com.nimbusds.oauth2.sdk
Enum ScopeToken.Requirement

java.lang.Object
  java.lang.Enum<ScopeToken.Requirement>
      com.nimbusds.oauth2.sdk.ScopeToken.Requirement

All Implemented Interfaces:

Serializable, Comparable<ScopeToken.Requirement>

Enclosing class:

ScopeToken

public static enum ScopeToken.Requirement
extends Enum<ScopeToken.Requirement>

Enumeration of the scope token requirements for application-specific authorisation requests.

Enum Constant Summary

OPTIONAL
The token may be optionally included in the Scope parameter.

REQUIRED
The token must be present in the Scope parameter.

Method Summary

static ScopeToken.Requirement	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScopeToken.Requirement[]	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

REQUIRED

public static final ScopeToken.Requirement REQUIRED

The token must be present in the Scope parameter.

OPTIONAL

public static final ScopeToken.Requirement OPTIONAL

The token may be optionally included in the Scope parameter.

Method Detail

values

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

Returns:

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

valueOf

public static ScopeToken.Requirement 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