Package g54327.humbug.model.Structures

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

g54327.humbug.model.Structures.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Direction enumeration. NORTH, SOUTH, EAST or WEST

Since:

0.1.0

Version:

1.1.0

Author:

Andrew SASSOYE

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST	EAST DIRECTION
NORTH	NORTH DIRECTION
SOUTH	SOUTH DIRECTION
WEST	WEST DIRECTION

Method Summary

Modifier and Type	Method	Description
int	getDeltaColumn()	DeltaColumn getter
int	getDeltaRow()	DeltaRow getter
Direction	opposite()	Gives the opposite Direction
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

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

NORTH DIRECTION

SOUTH

public static final Direction SOUTH

SOUTH DIRECTION

EAST

public static final Direction EAST

EAST DIRECTION

WEST

public static final Direction WEST

WEST DIRECTION

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

opposite

public Direction opposite()

Gives the opposite Direction

Returns:

Opposite Direction

Since:

1.1.0

getDeltaRow

public int getDeltaRow()

DeltaRow getter

Returns:

this.deltaRow

getDeltaColumn

public int getDeltaColumn()

DeltaColumn getter

Returns:

this.deltaColumn