model

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

model.Direction

All Implemented Interfaces:

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

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

A list of directions and common methods related to them is often needed by animals.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_LEFT
BOTTOM_RIGHT
CENTER
DOWN
LEFT
RIGHT
TOP_LEFT
TOP_RIGHT
UP

Method Summary

Modifier and Type	Method and Description
static Direction	fromInt(int d) Return the direction that this number refers to.
java.lang.String	getString() Return a string representation of this direction.
Direction	nextDirection(boolean clockwise) Return the next direction, going clockwise (if cw = true) or anticlockwise (if cw = false)
Direction	oppositeDirection() Return the opposite direction
static Direction	randomDirection() Return a random 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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UP

public static final Direction UP

DOWN

public static final Direction DOWN

LEFT

public static final Direction LEFT

RIGHT

public static final Direction RIGHT

TOP_RIGHT

public static final Direction TOP_RIGHT

TOP_LEFT

public static final Direction TOP_LEFT

BOTTOM_LEFT

public static final Direction BOTTOM_LEFT

BOTTOM_RIGHT

public static final Direction BOTTOM_RIGHT

CENTER

public static final Direction CENTER

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

oppositeDirection

public Direction oppositeDirection()

Return the opposite direction

nextDirection

public Direction nextDirection(boolean clockwise)

Return the next direction, going clockwise (if cw = true) or anticlockwise (if cw = false)

Parameters:

clockwise -

randomDirection

public static Direction randomDirection()

Return a random direction

fromInt

public static Direction fromInt(int d)

Return the direction that this number refers to.

getString

public java.lang.String getString()

Return a string representation of this direction.