Enum Class MovementDirection

java.lang.Object

java.lang.Enum<MovementDirection>

nl.pim16aap2.animatedarchitecture.core.util.MovementDirection

All Implemented Interfaces:

Serializable, Comparable<MovementDirection>, Constable

public enum MovementDirection
extends Enum<MovementDirection>

Represents all possible movement directions of a Structure.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOCKWISE
COUNTERCLOCKWISE
DOWN
EAST
NONE
NORTH
SOUTH
UP
WEST

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<MovementDirection>	CARDINAL_DIRECTIONS	Unmodifiable set of the four cardinal directions; north, east, south, and west.

Method Summary

Modifier and Type	Method	Description
String	getLocalizationKey()
static Optional<MovementDirection>	getMovementDirection(String name)	Gets the MovementDirection from a name.
static MovementDirection	getOpposite(MovementDirection dir)	Get the MovementDirection that's the exact opposite of the provided one.
static int	getValue(MovementDirection dir)	Gets the index value of a MovementDirection.
static boolean	isCardinalDirection(@Nullable MovementDirection direction)	Check if the provided MovementDirection is a cardinal direction.
static @Nullable MovementDirection	valueOf(int dir)	Gets the MovementDirection from an index value.
static MovementDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MovementDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final MovementDirection NONE

CLOCKWISE

public static final MovementDirection CLOCKWISE

COUNTERCLOCKWISE

public static final MovementDirection COUNTERCLOCKWISE

UP

public static final MovementDirection UP

DOWN

public static final MovementDirection DOWN

NORTH

public static final MovementDirection NORTH

EAST

public static final MovementDirection EAST

SOUTH

public static final MovementDirection SOUTH

WEST

public static final MovementDirection WEST

Field Details

CARDINAL_DIRECTIONS

public static final Set<MovementDirection> CARDINAL_DIRECTIONS

Unmodifiable set of the four cardinal directions; north, east, south, and west.

Method Details

values

public static MovementDirection[] 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 MovementDirection 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

getValue

public static int getValue(MovementDirection dir)

Gets the index value of a MovementDirection.

Parameters:

dir - The MovementDirection.

Returns:

The index value of a MovementDirection.

valueOf

public static @Nullable MovementDirection valueOf(int dir)

Gets the MovementDirection from an index value.

Parameters:

dir - The MovementDirection.

Returns:

The MovementDirection associated with this index value.

getMovementDirection

public static Optional<MovementDirection> getMovementDirection(String name)

Gets the MovementDirection from a name.

Parameters:

name - The name of the MovementDirection.

Returns:

The MovementDirection associated with this name.

getOpposite

public static MovementDirection getOpposite(MovementDirection dir)

Get the MovementDirection that's the exact opposite of the provided one. For example, the opposite side of UP is DOWN.

Parameters:

dir - The current MovementDirection

Returns:

The opposite direction of the current MovementDirection.

isCardinalDirection

public static boolean isCardinalDirection(@Nullable MovementDirection direction)

Check if the provided MovementDirection is a cardinal direction.

Parameters:

direction - The MovementDirection to check.

Returns:

True if the provided MovementDirection is a cardinal direction, false otherwise.

getLocalizationKey

public String getLocalizationKey()