Annotation Interface ConfigurationEntry


@Target(METHOD) @Retention(RUNTIME) @Documented public @interface ConfigurationEntry
Marks an interface's method that provides a configuration value.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Indicates when changes to the configuration entry's value are applied.
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Returns a list of paragraphs describing what the key/value configures.
    Returns a description for the data type of this configuration key's values.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Indicates when changes to the configuration entry's value are applied.
    Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).
  • Element Details

    • type

      String type
      Returns a description for the data type of this configuration key's values.
      Returns:
      A description for the data type of this configuration key's values.
    • description

      String[] description
      Returns a list of paragraphs describing what the key/value configures.
      Returns:
      A list of paragraphs describing what the key/value configures.
    • changesApplied

      Indicates when changes to the configuration entry's value are applied.
      Returns:
      A value indicating when changes to the configuration entry's value are applied.
      Default:
      UNSPECIFIED
    • orderKey

      String orderKey
      Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).
      Returns:
      The optional ordering key that this entry belongs to (for grouping/sorting of entries).
      Default:
      ""