Interface EnumDefinition

All Superinterfaces:
ConstantBackedEnum
All Known Implementing Classes:
ReleasePolicy, TypedMarker
public interface EnumDefinition extends ConstantBackedEnum
A ConstantBackedEnum that also carries a human-readable term and its definition.

An EnumDefinition expresses a controlled-vocabulary entry as an enum constant: the term() is the word being defined, the definition() states what it means, and the inherited ConstantBackedEnum.literalName() is the stable literal the term is encoded as — in a POM property, on the command line, and so on. For many vocabularies the term and the literal coincide.

Since:
1

  • Method Details

    • term

      String term()
      The human-readable term this constant names.
      Returns:
      the term; never null or blank

    • definition

      String definition()
      A one-sentence definition of term().
      Returns:
      the definition; never null or blank