Package me.deecaad.core.file.serializers

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

me.deecaad.core.file.serializers.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable, VectorProvider

public enum Direction
extends Enum<Direction>
implements VectorProvider

Enum holding the basic cardinal directions for simple user input.

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
BACKWARD
DOWN
FORWARD
LEFT
RIGHT
UP

Method Summary

Modifier and Type	Method	Description
@NotNull org.bukkit.util.Vector	provide(@Nullable Quaternion localTransform)	Returns the vector, as specified by the implementing class.
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

UP

public static final Direction UP

DOWN

public static final Direction DOWN

RIGHT

public static final Direction RIGHT

LEFT

public static final Direction LEFT

FORWARD

public static final Direction FORWARD

BACKWARD

public static final Direction BACKWARD

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

provide

@NotNull
public @NotNull org.bukkit.util.Vector provide(@Nullable
 @Nullable Quaternion localTransform)

Description copied from interface: VectorProvider

Returns the vector, as specified by the implementing class.

Specified by:

provide in interface VectorProvider

Parameters:

localTransform - The local transform to apply to the vector. This can be null.

Returns:

The vector.