Annotation Type Description


  • @Retention(RUNTIME)
    @Target({FIELD,TYPE})
    @Beta
    @PublicAPI
    public @interface Description
    The annotated element has a description contained in this annotation.

    Marks types/enum instances (typically parameter objects) which are meant to expose to the user (through reflection based dynamic API discovery) to choose from in a specific situation

    Please note that this annotation is marked with @Beta annotation, so it can be subject of incompatible change or remove in later releases.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String description
      Element description description.
      String name
      Element name.
      String shortName
      Short name of the descripted element.
    • Element Detail

      • shortName

        String shortName
        Short name of the descripted element. Short name is used as a label or argument name. Values are expected to
        • Contain only lovercase alphanumeric characters, "_" or "-".
        • Be human readable.
        • Be short.
        Returns:
        Short name
      • name

        String name
        Element name.
        Returns:
        Name
      • description

        String description
        Element description description. Expected to contain a human readable description composed of one or more complete sentence.
        Returns:
        Human readable description