Package io.github.thecsdev.tcdcommons.api.util.enumerations

Enum Class Direction2D

java.lang.Object

java.lang.Enum<Direction2D>

io.github.thecsdev.tcdcommons.api.util.enumerations.Direction2D

All Implemented Interfaces:

Serializable, Comparable<Direction2D>, Constable

public enum Direction2D
extends Enum<Direction2D>

Enum representing 2D directions: UP, DOWN, LEFT, RIGHT.

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	Represents downward direction.
LEFT	Represents leftward direction.
RIGHT	Represents rightward direction.
UP	Represents upward direction.

Method Summary

Modifier and Type	Method	Description
boolean	isHorizontal()
boolean	isVertical()
static Direction2D	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Direction2D[]	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

UP

public static final Direction2D UP

Represents upward direction.

DOWN

public static final Direction2D DOWN

Represents downward direction.

LEFT

public static final Direction2D LEFT

Represents leftward direction.

RIGHT

public static final Direction2D RIGHT

Represents rightward direction.

Method Details

values

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

isVertical

public boolean isVertical()

isHorizontal

public boolean isHorizontal()