org.leialearns.enumerations

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

org.leialearns.enumerations.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Defines the possible values for the direction property of a DirectedSymbol.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION Indicates that the symbol was sent from LEIA to its environment.
RESPONSE Indicates that the symbol was received by LEIA from its environment.

Method Summary

Methods

Modifier and Type	Method and Description
char	toChar() Returns the -- unique -- character that corresponds to this direction.
static Direction	valueOf(char character) Returns the direction constant that corresponds to the given character.
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

Enum Constant Detail

ACTION

public static final Direction ACTION

Indicates that the symbol was sent from LEIA to its environment.

RESPONSE

public static final Direction RESPONSE

Indicates that the symbol was received by LEIA from its environment.

Method Detail

values

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

Returns:

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

valueOf

public static Direction 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

toChar

public char toChar()

Returns the -- unique -- character that corresponds to this direction. This can be used for compact representations that specify directions.

Returns:

The character that corresponds to this direction

valueOf

public static Direction valueOf(char character)

Returns the direction constant that corresponds to the given character. This is the reverse operation of toChar().

Parameters:

character - The character value to look up

Returns:

The corresponding direction constant

Throws:

IllegalArgumentException - If no direction constant corresponds to the given character