Package org.forgerock.api.enums

Enum ParameterSource

java.lang.Object

java.lang.Enum<ParameterSource>

org.forgerock.api.enums.ParameterSource

All Implemented Interfaces:

Serializable, Comparable<ParameterSource>

public enum ParameterSource
extends Enum<ParameterSource>

Enum that represents where the Parameter comes from.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDITIONAL	Parameter comes from the request.
PATH	Parameter comes from the path.

Method Summary

Modifier and Type	Method	Description
static ParameterSource	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ParameterSource[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PATH

public static final ParameterSource PATH

Parameter comes from the path.

ADDITIONAL

public static final ParameterSource ADDITIONAL

Parameter comes from the request.

Method Detail

values

public static ParameterSource[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ParameterSource c : ParameterSource.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ParameterSource valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null