com.unboundid.util.ssl.cert

Enum PKCS8PrivateKeyVersion

java.lang.Object

java.lang.Enum<PKCS8PrivateKeyVersion>

com.unboundid.util.ssl.cert.PKCS8PrivateKeyVersion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PKCS8PrivateKeyVersion>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum PKCS8PrivateKeyVersion
extends java.lang.Enum<PKCS8PrivateKeyVersion>

This enum defines a set of supported PKCS #8 private key versions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
V1 The PKCS #8 v1 private key version.
V2 The PKCS #8 v2 private key version.

Method Summary

Modifier and Type	Method and Description
static PKCS8PrivateKeyVersion	forName(java.lang.String name) Retrieves the PKCS #8 private key version with the specified name.
java.lang.String	getName() Retrieves the name for this private key version.
static PKCS8PrivateKeyVersion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PKCS8PrivateKeyVersion[]	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

V1

public static final PKCS8PrivateKeyVersion V1

The PKCS #8 v1 private key version.

V2

public static final PKCS8PrivateKeyVersion V2

The PKCS #8 v2 private key version.

Method Detail

values

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

Returns:

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

valueOf

public static PKCS8PrivateKeyVersion valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this private key version.

Returns:

The name for this private key version.

forName

@Nullable
public static PKCS8PrivateKeyVersion forName(@NotNull
                                                       java.lang.String name)

Retrieves the PKCS #8 private key version with the specified name.

Parameters:

name - The name of the PKCS #8 private key version to retrieve. It must not be null.

Returns:

The requested PKCS #8 private key version, or null if no such version is defined.