Package org.jenkinsci

Annotation Interface Symbol

@Indexed @Retention(RUNTIME) @Target(TYPE) @Documented public @interface Symbol
Defines a unique identifier to refer to an extension.

This identifier is intended to be a short name that can be easily typed in by humans, and be used by the likes of various DSL plugins and workflow which uses text/code to refer to them.

To keep symbol names short, symbol names are meant to be only unique within a specific extension point. A symbol name shouldn't include the name of the extension point in it (for example, "list" is preferred over "listView".) A symbol name should follow the camel case convention, such as "fooBarZot"

Because this is a short symbol, avoiding a collision requires a coordination. We will scan the list of known symbol names in the update center and publish that list to help people choose the symbol names wisely.

The symbol must be a valid Java identifier. Multiple symbols can be specified as aliases. The first one is used as the primary identifier for reverse-mapping.

Generally symbols should be named after their display names, so that users see association between what they see in web UI and symbols they see in code.

To look up a component by its symbol, see the documentation of the symbol plugin.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
     

  • Element Details