Enum Direction

java.lang.Object

java.lang.Enum<Direction>

Direction

All Implemented Interfaces:

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

public enum Direction
extends java.lang.Enum<Direction>

Direction - a direction enumeration useful for orthogonal (up, down, right, left) movement direction on a grid. NOTE: Do not implement values() or valueOf(String)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN
LEFT
RIGHT
UP

Field Summary

Fields

Modifier and Type	Field and Description
char	CHAR direction character representation
int	D_COL direction column change
int	D_ROW direction row change

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() Return a String with the single character representation of this direction.
static Direction	valueOf(java.lang.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

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RIGHT

public static final Direction RIGHT

UP

public static final Direction UP

LEFT

public static final Direction LEFT

DOWN

public static final Direction DOWN

Field Detail

D_ROW

public final int D_ROW

direction row change

D_COL

public final int D_COL

direction column change

CHAR

public final char CHAR

direction character representation

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(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

toString

public java.lang.String toString()

Return a String with the single character representation of this direction.

Overrides:

toString in class java.lang.Enum<Direction>

Returns:

a String with the single character representation of this direction.

See Also:

Enum.toString()