com.sdl.context.common.cli

Enum CharacterType

java.lang.Object

java.lang.Enum<CharacterType>

com.sdl.context.common.cli.CharacterType

All Implemented Interfaces:

Serializable, Comparable<CharacterType>

public enum CharacterType
extends Enum<CharacterType>

Character type for a command line interface.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARROW_DOWN Arrow down.
ARROW_UP Arrow up.
BACK
DISPLAY Display Character.
END End marks the end of a line (i.e.
QUIT Quit character.
START Start marks the start of a line (a null character).

Method Summary

Modifier and Type	Method and Description
static CharacterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CharacterType[]	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

START

public static final CharacterType START

Start marks the start of a line (a null character).

END

public static final CharacterType END

End marks the end of a line (i.e. carriage return).

BACK

public static final CharacterType BACK

ARROW_UP

public static final CharacterType ARROW_UP

Arrow up.

ARROW_DOWN

public static final CharacterType ARROW_DOWN

Arrow down.

DISPLAY

public static final CharacterType DISPLAY

Display Character.

QUIT

public static final CharacterType QUIT

Quit character.

Method Detail

values

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

Returns:

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

valueOf

public static CharacterType valueOf(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:

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

NullPointerException - if the argument is null