org.axsl.common.value

Enum RelativeAxis

java.lang.Object

java.lang.Enum<RelativeAxis>

org.axsl.common.value.RelativeAxis

All Implemented Interfaces:

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

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

An enumeration of relative axes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK_PROGRESSION Constant indicating the block-progression relative axis.
INLINE_PROGRESSION Constant indicating the inline-progression relative axis.

Method Summary

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

BLOCK_PROGRESSION

public static final RelativeAxis BLOCK_PROGRESSION

Constant indicating the block-progression relative axis.

INLINE_PROGRESSION

public static final RelativeAxis INLINE_PROGRESSION

Constant indicating the inline-progression relative axis.

Method Detail

values

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

Returns:

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

valueOf

public static RelativeAxis 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