org.axsl.common.value

Enum AbsoluteCompass

java.lang.Object

java.lang.Enum<AbsoluteCompass>

org.axsl.common.value.AbsoluteCompass

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbsoluteCompass>, Compass

public enum AbsoluteCompass
extends java.lang.Enum<AbsoluteCompass>
implements Compass

An enumeration for the various absolute compass-point directions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM Constant indicating the "bottom" (south) absolute compass-point.
LEFT Constant indicating the "left" (west) absolute compass-point.
RIGHT Constant indicating the "right" (east) absolute compass-point.
TOP Constant indicating the "top" (north) absolute compass-point.

Method Summary

Modifier and Type	Method and Description
boolean	isAbsolute() Indicates whether this compass direction is an absolute direction.
boolean	isRelative() Indicates whether this compass direction is a relative direction.
static AbsoluteCompass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AbsoluteCompass[]	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

public static final AbsoluteCompass LEFT

Constant indicating the "left" (west) absolute compass-point.

RIGHT

public static final AbsoluteCompass RIGHT

Constant indicating the "right" (east) absolute compass-point.

TOP

public static final AbsoluteCompass TOP

Constant indicating the "top" (north) absolute compass-point.

BOTTOM

public static final AbsoluteCompass BOTTOM

Constant indicating the "bottom" (south) absolute compass-point.

Method Detail

values

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

Returns:

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

valueOf

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

isRelative

public boolean isRelative()

Description copied from interface: Compass

Indicates whether this compass direction is a relative direction.

Specified by:

isRelative in interface Compass

Returns:

True iff this compass direction is a relative direction.

isAbsolute

public boolean isAbsolute()

Description copied from interface: Compass

Indicates whether this compass direction is an absolute direction.

Specified by:

isAbsolute in interface Compass

Returns:

True iff this compass direction is an absolute direction.