org.axsl.common.value

Enum AbsoluteDirection

java.lang.Object

java.lang.Enum<AbsoluteDirection>

org.axsl.common.value.AbsoluteDirection

All Implemented Interfaces:

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

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

An enumeration of absolute directions or vectors, that is, directions of movement.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_TO_TOP Constant indicating the "bottom-to-top" direction.
LEFT_TO_RIGHT Constant indicating the "left-to-right" direction.
RIGHT_TO_LEFT Constant indicating the "right-to-left" direction.
TOP_TO_BOTTOM Constant indicating the "top-to-bottom" direction.

Method Summary

Modifier and Type	Method and Description
boolean	isHorizontal() Indicates whether this direction is on the horizontal axis.
boolean	isVertical() Indicates whether this direction is on the horizontal axis.
static AbsoluteDirection	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AbsoluteDirection[]	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

LEFT_TO_RIGHT

public static final AbsoluteDirection LEFT_TO_RIGHT

Constant indicating the "left-to-right" direction.

RIGHT_TO_LEFT

public static final AbsoluteDirection RIGHT_TO_LEFT

Constant indicating the "right-to-left" direction.

TOP_TO_BOTTOM

public static final AbsoluteDirection TOP_TO_BOTTOM

Constant indicating the "top-to-bottom" direction.

BOTTOM_TO_TOP

public static final AbsoluteDirection BOTTOM_TO_TOP

Constant indicating the "bottom-to-top" direction.

Method Detail

values

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

Returns:

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

valueOf

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

isHorizontal

public boolean isHorizontal()

Indicates whether this direction is on the horizontal axis.

Returns:

True iff this direction is on the horizontal axis.

isVertical

public boolean isVertical()

Indicates whether this direction is on the horizontal axis.

Returns:

True iff this direction is on the horizontal axis.