org.almacha.achamaze
Enum Direction

java.lang.Object
  java.lang.Enum<Direction>
      org.almacha.achamaze.Direction

All Implemented Interfaces:

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

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

Represents a direction (North, East, South, West).

Author:

Raphael Champeimont

Enum Constant Summary

EAST

NORTH

SOUTH

WEST

Method Summary

Direction	left() Returns the direciton on the left of the given one.
Direction	right() Returns the direciton on the right of the given 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

NORTH

public static final Direction NORTH

EAST

public static final Direction EAST

SOUTH

public static final Direction SOUTH

WEST

public static final Direction WEST

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

left

public Direction left()

Returns the direciton on the left of the given one.

Returns:

the computed direction

right

public Direction right()

Returns the direciton on the right of the given one.

Returns:

the computed direction