Module dev.metaschema.databind
Package dev.metaschema.databind.model.annotations

Annotation Type AllowedValue

@Documented @Retention(RUNTIME) @Target(ANNOTATION_TYPE) public @interface AllowedValue
This annotation provides an enumerated value that is used as part of an AllowedValues annotation.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    A description, encoded as a line of Markdown.
    String
    value
    The specific enumerated value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    deprecatedVersion
    The version this value was deprecated in.

  • Element Details

    • value

      @NonNull String value
      The specific enumerated value.
      Returns:
      the value

    • description

      @NonNull String description
      A description, encoded as a line of Markdown.
      Returns:
      an encoded markdown string

    • deprecatedVersion

      @NonNull String deprecatedVersion
      The version this value was deprecated in.
      Returns:
      the version or an empty string if the value is not deprecated
      Default:
      ""