Package org.spongepowered.api.util
Enum Class AxisDirection
- All Implemented Interfaces:
Serializable
,Comparable<AxisDirection>
,Constable
Represents the directional axis is either
positive, zero, or negative.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
signum()
Gets the signum for this direction.static AxisDirection
Returns the enum constant of this class with the specified name.static AxisDirection[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PLUS
-
ZERO
-
MINUS
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
signum
public int signum()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
-