org.spongepowered.api.util

Enum AxisDirection

java.lang.Object

java.lang.Enum<AxisDirection>

org.spongepowered.api.util.AxisDirection

All Implemented Interfaces:

Serializable, Comparable<AxisDirection>

public enum AxisDirection
extends Enum<AxisDirection>

Represents the directional axis is either positive, zero, or negative.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MINUS
PLUS
ZERO

Method Summary

Modifier and Type	Method and Description
int	getSignum() Gets the signum for this direction.
static AxisDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxisDirection[]	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

PLUS

public static final AxisDirection PLUS

ZERO

public static final AxisDirection ZERO

MINUS

public static final AxisDirection MINUS

Method Detail

values

public static AxisDirection[] 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 (AxisDirection c : AxisDirection.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AxisDirection valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getSignum

public int getSignum()

Gets the signum for this direction.

A positive direction has a value of 1, negative direction -1 and 0 for no direction.

Returns:

The signum