org.forgerock.api.annotations

Annotation Type Parameter

public @interface Parameter

A extra parameter to an operation.

Required Element Summary

Required Elements

Modifier and Type	Required Element and 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 and 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 Detail

name

public abstract String name

The name of the parameter.

type

public abstract String type

The type semantics of the String value.

defaultValue

public abstract String defaultValue

The default value, if applicable. Should not be an empty string.

Default:

""

description

public abstract String description

A description of the parameter.

Default:

""

source

public abstract ParameterSource source

The source of the parameter. Defaults to PATH.

Default:

org.forgerock.api.enums.ParameterSource.PATH

required

public abstract boolean required

Whether the parameter is required. Defaults to true.

Default:

true

enumValues

public abstract String[] enumValues

Enumeration of acceptable values, if required.

Default:

{}

enumTitles

public abstract String[] enumTitles

Titles of enumeration values.

Default:

{}