Annotation Interface EnumAlias

@Documented @Retention(SOURCE) @Target(FIELD) public @interface EnumAlias
API documentation marker on an enum constant listing the other property values, case insensitive, that select it besides its own name, for example true or false.

Property enums follow the same conventions so that users can guess values without looking them up:

  • true turns the thing on or shows it, usually in its default form; when the default is off, true selects the usual on choice instead (caller info: basic).
  • false turns the thing off or hides it, selecting the constant named OFF or NONE.
  • default restores the default without naming it, so a later property source can undo an earlier one; it differs from true only when the default is off. When a constant is itself named DEFAULT, it is not aliased.
  • A constant named OFF is for a switch or mode that is turned off (color, strict checking, debug output); a constant named NONE is for a part or piece of content that is left out (no timestamp, no key values, no caller info).
  • An alias never repeats a constant's own name; names already match case insensitively.
API Note
Rainbow Gum's annotation processor records these aliases in generated resource files for its own tests. Those files are not public API: their names, location, and format may change in any release and must not be relied on.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
    The aliases.

  • Element Details