Annotation Type Describable


@Retention(RUNTIME) @Target(TYPE) @Indexed public @interface Describable
Annotation used to register implementations to be discovered automatically.

Note that different services creating an instances have different conventions concerning both the values of this annotation as well as the class interface. In some cases, descriptions are visual labels used in UI, but it can as well be an internal identifier such as Jenkins class name. Compare Describable annotations for MatrixProject and ShellBuildStep. Unique constructor signature is often required for implementations of the same abstraction.

The details should be documented in particular superclass, such as Job or BuildStep.

Author:
Kohsuke Kawaguchi
See Also:
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Descriptions.
  • Element Details

    • value

      String[] value
      Descriptions.

      The annotation accepts several values as possible alternatives. First that exists will be used.