org.axsl.common.value

Enum RelativeCompass

java.lang.Object

java.lang.Enum<RelativeCompass>

org.axsl.common.value.RelativeCompass

All Implemented Interfaces:

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

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

An enumeration for the various compass-point directions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER Constant indicating the "after" relative compass-point.
BEFORE Constant indicating the "before" relative compass-point.
END Constant indicating the "end" relative compass-point.
START Constant indicating the "start" relative 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 RelativeCompass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RelativeCompass[]	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

START

public static final RelativeCompass START

Constant indicating the "start" relative compass-point.

END

public static final RelativeCompass END

Constant indicating the "end" relative compass-point.

BEFORE

public static final RelativeCompass BEFORE

Constant indicating the "before" relative compass-point.

AFTER

public static final RelativeCompass AFTER

Constant indicating the "after" relative compass-point.

Method Detail

values

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

Returns:

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

valueOf

public static RelativeCompass 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.