com.nimbusds.jose

Class Algorithm

java.lang.Object

com.nimbusds.jose.Algorithm

All Implemented Interfaces:

net.minidev.json.JSONAware

Direct Known Subclasses:

EncryptionMethod, JWEAlgorithm, JWSAlgorithm

@Immutable
public class Algorithm
extends java.lang.Object
implements net.minidev.json.JSONAware

The base class for algorithm names, with optional implementation requirement. This class is immutable.

Includes constants for the following standard algorithm names:

• none

Version:

$version$ (2013-03-27)

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static Algorithm	NONE No algorithm (plain JOSE object without signature / encryption).

Constructor Summary

Constructors

Constructor and Description
Algorithm(java.lang.String name) Creates a new JOSE algorithm name.
Algorithm(java.lang.String name, Requirement req) Creates a new JOSE algorithm name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Overrides Object.equals().
java.lang.String	getName() Gets the name of this algorithm.
Requirement	getRequirement() Gets the implementation requirement of this algorithm.
int	hashCode() Overrides Object.hashCode().
java.lang.String	toJSONString() Returns the JSON string representation of this algorithm.
java.lang.String	toString() Returns the string representation of this algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final Algorithm NONE

No algorithm (plain JOSE object without signature / encryption).

Constructor Detail

Algorithm

public Algorithm(java.lang.String name,
         Requirement req)

Creates a new JOSE algorithm name.

Parameters:

name - The algorithm name. Must not be null.

req - The implementation requirement, null if not known.

Algorithm

public Algorithm(java.lang.String name)

Creates a new JOSE algorithm name.

Parameters:

name - The algorithm name. Must not be null.

Method Detail

getName

public final java.lang.String getName()

Gets the name of this algorithm.

Returns:

The algorithm name.

getRequirement

public final Requirement getRequirement()

Gets the implementation requirement of this algorithm.

Returns:

The implementation requirement, null if not known.

hashCode

public final int hashCode()

Overrides Object.hashCode().

Overrides:

hashCode in class java.lang.Object

Returns:

The object hash code.

equals

public boolean equals(java.lang.Object object)

Overrides Object.equals().

Overrides:

equals in class java.lang.Object

Parameters:

object - The object to compare to.

Returns:

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

toString

public final java.lang.String toString()

Returns the string representation of this algorithm.

Overrides:

toString in class java.lang.Object

Returns:

The string representation.

See Also:

getName()

toJSONString

public final java.lang.String toJSONString()

Returns the JSON string representation of this algorithm.

Specified by:

toJSONString in interface net.minidev.json.JSONAware

Returns:

The JSON string representation.