Enum Class Key

java.lang.Object

java.lang.Enum<Key>

pretty.keys.Key

All Implemented Interfaces:

Serializable, Comparable<Key>, Constable

public enum Key
extends Enum<Key>

Enum representing keys in DefaultKeyTranslator

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
BACKSPACE
DOWN
ENTER
LEFT
RIGHT
SPACE
UNTRANSLATABLE
UP

Method Summary

Modifier and Type	Method	Description
int	getCode()	Get the code of the key.
String	toString()
static Key	untranslatable(int code)	Create an untranslatable key
static Key	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Key[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNTRANSLATABLE

public static final Key UNTRANSLATABLE

ENTER

public static final Key ENTER

BACKSPACE

public static final Key BACKSPACE

SPACE

public static final Key SPACE

UP

public static final Key UP

DOWN

public static final Key DOWN

LEFT

public static final Key LEFT

RIGHT

public static final Key RIGHT

Method Details

values

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

getCode

public int getCode()

Get the code of the key. Except for UNTRANSLATABLE, all others have the value 0 by default.

Returns:

the code of the key

untranslatable

public static Key untranslatable(int code)

Create an untranslatable key

Parameters:

code - - the code of the key

Returns:

the untranslatable key

toString

public String toString()

Overrides:

toString in class Enum<Key>