Package com.nimbusds.jose

Enum Class Requirement

java.lang.Object

java.lang.Enum<Requirement>

com.nimbusds.jose.Requirement

All Implemented Interfaces:

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

public enum Requirement
extends Enum<Requirement>

Enumeration of JOSE algorithm implementation requirements. Refers to the requirement levels defined in RFC 2119.

Version:

2012-09-17

Author:

Vladimir Dzhuvinov

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
OPTIONAL	The implementation of the algorithm is optional.
RECOMMENDED	The implementation of the algorithm is recommended.
REQUIRED	The implementation of the algorithm is required.

Method Summary

Modifier and Type	Method	Description
static Requirement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Requirement[]	values()	Returns an array containing the constants of this enum class, 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 Requirement REQUIRED

The implementation of the algorithm is required.

RECOMMENDED

public static final Requirement RECOMMENDED

The implementation of the algorithm is recommended.

OPTIONAL

public static final Requirement OPTIONAL

The implementation of the algorithm is optional.

Method Details

values

public static Requirement[] values()

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

Returns:

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

valueOf

public static Requirement valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null