org.axsl.common.value

Enum AbsoluteAxis

java.lang.Object

java.lang.Enum<AbsoluteAxis>

org.axsl.common.value.AbsoluteAxis

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbsoluteAxis>

public enum AbsoluteAxis
extends java.lang.Enum<AbsoluteAxis>

An enumeration of absolute axes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HORIZONTAL The horizontal absolute axis.
VERTICAL The vertical relative axis.

Method Summary

Modifier and Type	Method and Description
AbsoluteAxis	getOpposite() Returns the axis opposite to this.
static AbsoluteAxis	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AbsoluteAxis[]	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

HORIZONTAL

public static final AbsoluteAxis HORIZONTAL

The horizontal absolute axis.

VERTICAL

public static final AbsoluteAxis VERTICAL

The vertical relative axis.

Method Detail

values

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

Returns:

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

valueOf

public static AbsoluteAxis valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getOpposite

public AbsoluteAxis getOpposite()

Returns the axis opposite to this.

Returns:

The opposite axis.