Package org.apache.rat.config.parameters

Annotation Type ConfigComponent

@Target({FIELD,TYPE,METHOD}) @Retention(RUNTIME) public @interface ConfigComponent
An annotation that marks a configuration component.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    ComponentType
    type
    The component type.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    desc
    The description of the component.
    String
    name
    The common name for the component.
    Class<?>
    parameterType
    For collections defines the enclosed type.
    boolean
    required
    If true this component can be a child of the containing component.

  • Element Details

    • name

      String name
      The common name for the component. If not specified the name of the field or class is used.
      Returns:
      the component name.
      Default:
      ""

    • desc

      String desc
      The description of the component.
      Returns:
      the component description.
      Default:
      ""

    • type

      ComponentType type
      The component type.
      Returns:
      the component type.

    • parameterType

      Class<?> parameterType
      For collections defines the enclosed type.
      Returns:
      the enclosed type.
      Default:
      void.class

    • required

      boolean required
      If true this component can be a child of the containing component.
      Returns:
      true if this component can be a child of the containing component.
      Default:
      false