Package org.springframework.credhub.support

Enum Class KeyLength

java.lang.Object

java.lang.Enum<KeyLength>

org.springframework.credhub.support.KeyLength

All Implemented Interfaces:

Serializable, Comparable<KeyLength>, Constable

public enum KeyLength
extends Enum<KeyLength>

Enumeration of key lengths supported by CredHub for key generation.

Author:

Scott Frederick

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
LENGTH_2048	2048 bit key.
LENGTH_3072	3072 bit key.
LENGTH_4096	4096 bit key.

Method Summary

Modifier and Type	Method	Description
int	getLength()	Get the key length value.
static @Nullable KeyLength	getTypeByString(int length)	Convert an integer value to its enum value.
static KeyLength	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyLength[]	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

LENGTH_2048

public static final KeyLength LENGTH_2048

2048 bit key.

LENGTH_3072

public static final KeyLength LENGTH_3072

3072 bit key.

LENGTH_4096

public static final KeyLength LENGTH_4096

4096 bit key.

Method Details

values

public static KeyLength[] 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 KeyLength 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

getLength

public int getLength()

Get the key length value.

Returns:

the key length in bits

getTypeByString

public static @Nullable KeyLength getTypeByString(int length)

Convert an integer value to its enum value.

Parameters:

length - the integer value to convert to enum value

Returns:

the enum value