com.nimbusds.openid.connect.sdk.claims

Enum ClaimRequirement

java.lang.Object

java.lang.Enum<ClaimRequirement>

com.nimbusds.openid.connect.sdk.claims.ClaimRequirement

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClaimRequirement>

public enum ClaimRequirement
extends java.lang.Enum<ClaimRequirement>

Enumeration of the claim requirement types.

Related specifications:

• OpenID Connect Core 1.0, section 5.5.1.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ESSENTIAL Essential claim.
VOLUNTARY Voluntary claim.

Method Summary

Modifier and Type	Method and Description
static ClaimRequirement	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClaimRequirement[]	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

ESSENTIAL

public static final ClaimRequirement ESSENTIAL

Essential claim.

VOLUNTARY

public static final ClaimRequirement VOLUNTARY

Voluntary claim.

Method Detail

values

public static ClaimRequirement[] 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 (ClaimRequirement c : ClaimRequirement.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClaimRequirement valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null