org.keyczar.enums
Enum KeyPurpose
java.lang.Object
java.lang.Enum<KeyPurpose>
org.keyczar.enums.KeyPurpose
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<KeyPurpose>
public enum KeyPurpose
- extends java.lang.Enum<KeyPurpose>
Encodes different possible uses of a key:
- Decrypt and Encrypt,
- Encrypt Only,
- Sign and Verify,
- Verify Only, and
- Test.
JSON Representation currently supports these strings:
- "DECRYPT_AND_ENCRYPT"
- "ENCRYPT"
- "SIGN_AND_VERIFY"
- "VERIFY"
- Author:
- steveweis@gmail.com (Steve Weis), arkajit.dey@gmail.com (Arkajit Dey)
Methods inherited from class java.lang.Enum |
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
DECRYPT_AND_ENCRYPT
public static final KeyPurpose DECRYPT_AND_ENCRYPT
ENCRYPT
public static final KeyPurpose ENCRYPT
SIGN_AND_VERIFY
public static final KeyPurpose SIGN_AND_VERIFY
VERIFY
public static final KeyPurpose VERIFY
TEST
public static final KeyPurpose TEST
values
public static KeyPurpose[] 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 (KeyPurpose c : KeyPurpose.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they are declared
valueOf
public static KeyPurpose 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
getPurpose
public static KeyPurpose getPurpose(int value)
getPurpose
public static KeyPurpose getPurpose(java.lang.String name)