Package org.forgerock.api.annotations

Annotation Interface Parameter

public @interface Parameter
A extra parameter to an operation.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name of the parameter.
    String
    type
    The type semantics of the String value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    The default value, if applicable.
    String
    description
    A description of the parameter.
    String[]
    enumTitles
    Titles of enumeration values.
    String[]
    enumValues
    Enumeration of acceptable values, if required.
    boolean
    required
    Whether the parameter is required.
    ParameterSource
    source
    The source of the parameter.

  • Element Details

    • name

      String name
      The name of the parameter.

    • type

      String type
      The type semantics of the String value.

    • defaultValue

      String defaultValue
      The default value, if applicable. Should not be an empty string.
      Default:
      ""

    • description

      String description
      A description of the parameter.
      Default:
      ""

    • source

      ParameterSource source
      The source of the parameter. Defaults to PATH.
      Default:
      PATH

    • required

      boolean required
      Whether the parameter is required. Defaults to true.
      Default:
      true

    • enumValues

      String[] enumValues
      Enumeration of acceptable values, if required.
      Default:
      {}

    • enumTitles

      String[] enumTitles
      Titles of enumeration values.
      Default:
      {}