Package org.forgerock.api.models

Class Parameter.Builder

java.lang.Object
org.forgerock.api.models.Parameter.Builder
Enclosing class:
Parameter
public static final class Parameter.Builder extends Object
Builder to construct Parameter object.

  • Method Details

    • name

      public Parameter.Builder name(String name)
      Set the parameter name.
      Parameters:
      name - Parameter name
      Returns:
      Builder

    • enumValues

      public Parameter.Builder enumValues(String... enumValues)
      Sets enum-values that must match.
      Parameters:
      enumValues - Enum-values
      Returns:
      Builder

    • enumTitles

      public Parameter.Builder enumTitles(String... enumTitles)
      Sets enum-titles that must be the same length as enumValues(String[]), if provided.
      Parameters:
      enumTitles - Enum-titles
      Returns:
      Builder

    • type

      public Parameter.Builder type(String type)
      Set the parameter type.
      Parameters:
      type - Parameter type
      Returns:
      Builder

    • defaultValue

      public Parameter.Builder defaultValue(String defaultValue)
      Set the parameter default value.
      Parameters:
      defaultValue - If exists, the default value
      Returns:
      builder

    • description

      public Parameter.Builder description(LocalizableString description)
      Set the parameter description.
      Parameters:
      description - The description of the parameter
      Returns:
      builder

    • description

      public Parameter.Builder description(String description)
      Set the parameter description.
      Parameters:
      description - The description of the parameter
      Returns:
      builder

    • source

      public Parameter.Builder source(ParameterSource source)
      Set the parameter source.
      Parameters:
      source - Where the parameter comes from. May be: PATH or ADDITIONAL
      Returns:
      builder

    • required

      public Parameter.Builder required(Boolean required)
      Set the required property.
      Parameters:
      required - Whether the parameter is required
      Returns:
      builder

    • build

      public Parameter build()
      Builds the Parameter.
      Returns:
      The parameter instance