com.nimbusds.oauth2.sdk

Class Scope.Value

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

com.nimbusds.oauth2.sdk.Scope.Value

All Implemented Interfaces:

Serializable, Comparable<Identifier>, net.minidev.json.JSONAware

Direct Known Subclasses:

OIDCScopeValue

Enclosing class:

Scope

@Immutable
public static class Scope.Value
extends Identifier

Authorisation scope value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scope.Value.Requirement Enumeration of the scope value requirements for application-specific authorisation requests.

Field Summary

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier

DEFAULT_BYTE_LENGTH

Constructor Summary

Constructors

Constructor and Description
Scope.Value(String value) Creates a new scope value.
Scope.Value(String value, Scope.Value.Requirement requirement) Creates a new scope value with an optional requirement.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Overrides Object.equals().
Scope.Value.Requirement	getRequirement() Gets the requirement of this scope value.

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

compareTo, getValue, hashCode, toJSONString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Scope.Value

public Scope.Value(String value)

Creates a new scope value. The requirement is not specified.

Parameters:

value - The scope value. Must not be null or empty string.

Scope.Value

public Scope.Value(String value,
           Scope.Value.Requirement requirement)

Creates a new scope value with an optional requirement.

Parameters:

value - The scope value. Must not be null or empty string.

requirement - The requirement, null if not specified.

Method Detail

getRequirement

public Scope.Value.Requirement getRequirement()

Gets the requirement of this scope value.

Returns:

The requirement, null if not specified.

equals

public boolean equals(Object object)

Description copied from class: Identifier

Overrides Object.equals().

Specified by:

equals in class Identifier

Parameters:

object - The object to compare to.

Returns:

true if the objects have the same value, otherwise false.