com.nimbusds.jose.jwk
Enum Use

java.lang.Object
  java.lang.Enum<Use>
      com.nimbusds.jose.jwk.Use

All Implemented Interfaces:

Serializable, Comparable<Use>

public enum Use
extends Enum<Use>

Enumeration of key uses. Represents the use parameter in a JSON Web Key (JWK).

Represents the following JWK use values:

• sig
• enc

Version:

$version$ (2013-05-29)

Author:

Vladimir Dzhuvinov

Enum Constant Summary

ENCRYPTION
Encryption.

SIGNATURE
Signature.

Method Summary

static Use	parse(String s) Parses a JSON Web Key (JWK) use from the specified use parameter value.
static Use	valueOf(String name) Returns the enum constant of this type with the specified name.
static Use[]	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

SIGNATURE

public static final Use SIGNATURE

Signature.

ENCRYPTION

public static final Use ENCRYPTION

Encryption.

Method Detail

values

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

Returns:

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

valueOf

public static Use 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

parse

public static Use parse(String s)
                 throws ParseException

Parses a JSON Web Key (JWK) use from the specified use parameter value.

Parameters:

s - The string to parse. Must be either "sig" or "enc". Must not be null.

Throws:

ParseException - If the string couldn't be parsed to a valid key use.