Package com.nimbusds.oauth2.sdk

Enum ParameterRequirement

java.lang.Object

java.lang.Enum<ParameterRequirement>

com.nimbusds.oauth2.sdk.ParameterRequirement

All Implemented Interfaces:

Serializable, Comparable<ParameterRequirement>, java.lang.constant.Constable

public enum ParameterRequirement
extends Enum<ParameterRequirement>

The requirement level for a parameter.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOT_ALLOWED	The parameter is not allowed.
OPTIONAL	The parameter is optional.
REQUIRED	The parameter is required.

Method Summary

Modifier and Type	Method	Description
static ParameterRequirement	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ParameterRequirement[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUIRED

public static final ParameterRequirement REQUIRED

The parameter is required.

OPTIONAL

public static final ParameterRequirement OPTIONAL

The parameter is optional.

NOT_ALLOWED

public static final ParameterRequirement NOT_ALLOWED

The parameter is not allowed.

Method Details

values

public static ParameterRequirement[] values()

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

Returns:

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

valueOf

public static ParameterRequirement 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