Package com.takenoko.vector

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

com.takenoko.vector.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

The enum Direction represents the 6 directions in a 2D hexagonal grid.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NORTH
NORTH_EAST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_WEST

Field Summary

Fields

Modifier and Type	Field	Description
private final Vector	vector

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Direction(Vector vector)

Method Summary

Modifier and Type	Method	Description
Vector	getVector()
static Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Direction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORTH

public static final Direction NORTH

NORTH_EAST

public static final Direction NORTH_EAST

SOUTH_EAST

public static final Direction SOUTH_EAST

SOUTH

public static final Direction SOUTH

SOUTH_WEST

public static final Direction SOUTH_WEST

NORTH_WEST

public static final Direction NORTH_WEST

Field Details

vector

private final Vector vector

Constructor Details

Direction

private Direction(Vector vector)

Method Details

values

public static Direction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Direction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getVector

public Vector getVector()