Package civitas.celestis.annotation.application

Annotation Interface ApplicationCritical

@Documented @Retention(SOURCE) @Target({FIELD,METHOD,PARAMETER,CONSTRUCTOR,RECORD_COMPONENT,LOCAL_VARIABLE}) public @interface ApplicationCritical
A marker interface used to mark certain parts of the code which are considered application critical. A code is application critical when it can influence the behavior of the main thread of the application in a destructive manner.

Destructive actions are defined as code that can potentially put the main thread in an infinite loop, or alter the normal control flow of the main thread.

When a component is annotated with this annotation, exercise caution when using or modifying its contents, as it could potentially lead to unintended behavior on the main thread, which may cause major issues which damage the integrity of the entire application.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    created
    Returns the version of which this component was created in.
    String
    lastUpdated
    Returns the version of which this component was last updated in.

  • Element Details

    • created

      @Nonnull String created
      Returns the version of which this component was created in. This has a default value only to facilitate the usage of this annotation. In practice, this should be treated as a required field.
      Returns:
      The version this component was created in
      Default:
      "unknown"

    • lastUpdated

      @Nonnull String lastUpdated
      Returns the version of which this component was last updated in.
      Returns:
      The version this component was last updated in
      Default:
      "unknown"