Package org.forgerock.secrets.keys

Enum Class KeyFormatRaw

java.lang.Object

java.lang.Enum<KeyFormatRaw>

org.forgerock.secrets.keys.KeyFormatRaw

All Implemented Interfaces:

Serializable, Comparable<KeyFormatRaw>, java.lang.constant.Constable, KeyFormat<Key>

public enum KeyFormatRaw
extends Enum<KeyFormatRaw>
implements KeyFormat<Key>

Exports the raw key.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	The singleton instance of this formatter.

Method Summary

Modifier and Type	Method	Description
Key	export(CryptoKey key, Key rawKey)	Exports the given crypto key and raw key material.
static KeyFormatRaw	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyFormatRaw[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final KeyFormatRaw INSTANCE

The singleton instance of this formatter.

Method Details

values

public static KeyFormatRaw[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static KeyFormatRaw valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

export

public Key export(CryptoKey key,
 Key rawKey)

Description copied from interface: KeyFormat

Exports the given crypto key and raw key material.

Specified by:

export in interface KeyFormat<Key>

Parameters:

key - the crypto key.

rawKey - the raw key material.

Returns:

the exported key material in the given format.