org.cell2d

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

org.cell2d.Direction

All Implemented Interfaces:

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

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

A Direction is one of the four orthogonal directions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN Down.
LEFT Left.
RIGHT Right.
UP Up.

Method Summary

Modifier and Type	Method and Description
Direction	clockwise() Returns the Direction 90 degrees clockwise from this one.
Direction	counterclockwise() Returns the Direction 90 degrees counterclockwise from this one.
Direction	opposite() Returns the Direction opposite this one.
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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

public static final Direction LEFT

Left.

RIGHT

public static final Direction RIGHT

Right.

UP

public static final Direction UP

Up.

DOWN

public static final Direction DOWN

Down.

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

opposite

public Direction opposite()

Returns the Direction opposite this one. For instance, RIGHT.opposite() returns LEFT.

Returns:

The Direction opposite this one

clockwise

public Direction clockwise()

Returns the Direction 90 degrees clockwise from this one. For instance, RIGHT.clockwise() returns DOWN.

Returns:

The Direction 90 degrees clockwise from this one

counterclockwise

public Direction counterclockwise()

Returns the Direction 90 degrees counterclockwise from this one. For instance, RIGHT.counterclockwise() returns UP.

Returns:

The Direction 90 degrees counterclockwise from this one