Annotation Interface ComponentInformation


@Target(TYPE) @Retention(RUNTIME) public @interface ComponentInformation
Provides useful information about an AbstractComponent
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    A short description of this component to be used, for example, on a component help page.
    A name for this component that users see.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    An array of authors involved in the creation of this component.
  • Element Details

    • friendlyName

      String friendlyName
      A name for this component that users see.
      Returns:
      This component's friendly name.
    • desc

      String desc
      A short description of this component to be used, for example, on a component help page.
      Returns:
      The description.
    • authors

      String[] authors
      An array of authors involved in the creation of this component.
      Returns:
      The authors.
      Default:
      {""}