Annotation Interface Option.AllowedValue

Enclosing class:
Option
@Target(METHOD) @Inherited @Retention(CLASS) @Repeatable(Option.AllowedValues.class) public static @interface Option.AllowedValue
Defines one possible value for an option. For enum options, an allowed value that matches the lower-case Enum.name() is also accepted. The explicitly declared allowed value is retained in generated configuration metadata.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    Description of this value, used in documentation, may be used in error handling.
    String
    value
    Value of the option.

  • Element Details

    • value

      String value
      Value of the option.
      Returns:
      value

    • description

      String description
      Description of this value, used in documentation, may be used in error handling.
      Returns:
      description