Package de.ellpeck.rockbottom.api.util

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

de.ellpeck.rockbottom.api.util.Direction

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

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 Direction[]	ADJACENT
static Direction[]	ADJACENT_INCLUDING_NONE
static Direction[]	DIAGONAL
static Direction[]	DIAGONAL_INCLUDING_NONE
static Direction[]	DIRECTIONS
static Direction[]	SURROUNDING
static Direction[]	SURROUNDING_INCLUDING_NONE
int	x
int	y

Method Summary

Modifier and Type	Method	Description
Direction	getOpposite()
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

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 Detail

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 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

getOpposite

public Direction getOpposite()