Package de.ellpeck.rockbottom.api.util

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

de.ellpeck.rockbottom.api.util.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

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
DOWN
LEFT
LEFT_DOWN
LEFT_UP
NONE
RIGHT
RIGHT_DOWN
RIGHT_UP
UP

Field Summary

Fields

Modifier and Type	Field	Description
static final Direction[]	ADJACENT
static final Direction[]	ADJACENT_INCLUDING_NONE
static final Direction[]	DIAGONAL
static final Direction[]	DIAGONAL_INCLUDING_NONE
static final Direction[]	DIRECTIONS
static final Direction[]	SURROUNDING
static final Direction[]	SURROUNDING_INCLUDING_NONE
final int	x
final int	y

Method Summary

Modifier and Type	Method	Description
static Direction	getHorizontal(int side)
Direction	getOpposite()
static Direction	getVertical(int side)
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

NONE

public static final Direction NONE

UP

public static final Direction UP

DOWN

public static final Direction DOWN

LEFT

public static final Direction LEFT

RIGHT

public static final Direction RIGHT

LEFT_UP

public static final Direction LEFT_UP

LEFT_DOWN

public static final Direction LEFT_DOWN

RIGHT_UP

public static final Direction RIGHT_UP

RIGHT_DOWN

public static final Direction RIGHT_DOWN

Field Details

DIRECTIONS

public static final Direction[] DIRECTIONS

ADJACENT

public static final Direction[] ADJACENT

ADJACENT_INCLUDING_NONE

public static final Direction[] ADJACENT_INCLUDING_NONE

DIAGONAL

public static final Direction[] DIAGONAL

DIAGONAL_INCLUDING_NONE

public static final Direction[] DIAGONAL_INCLUDING_NONE

SURROUNDING

public static final Direction[] SURROUNDING

SURROUNDING_INCLUDING_NONE

public static final Direction[] SURROUNDING_INCLUDING_NONE

x

public final int x

y

public final int y

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

getOpposite

public Direction getOpposite()

getHorizontal

public static Direction getHorizontal(int side)

getVertical

public static Direction getVertical(int side)