Package dev.getelements.elements.rt.annotation

Annotation Interface DeprecationDefinition

@Target(TYPE) @Retention(RUNTIME) public @interface DeprecationDefinition
Indicates that the

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    deprecated
    Flag to indicate explicit deprecation.
    String
    value
    Indicates that the module is deprecated.

  • Element Details

    • value

      String value
      Indicates that the module is deprecated. Supplying a value will be relayed as the deprecation reason to the code which uses the deprecated module. The warning should appear in logs when attempting to use the module.
      Returns:
      the deprecation message
      Default:
      "<deprecated>"

    • deprecated

      boolean deprecated
      Flag to indicate explicit deprecation. It should rarely be necessary to explicitly set this flag.
      Returns:
      true if deprecated, false otherwise
      Default:
      true