SourceForge.net Logo
aXSL API 0.2

org.axsl.common.value
Enum AbsoluteCompass

java.lang.Object
  extended by java.lang.Enum<AbsoluteCompass>
      extended by 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
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
 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're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, 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 final AbsoluteCompass[] values()
Returns an array containing the constants of this enum type, in the order they're 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're 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

isRelative

public boolean isRelative()
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()
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.

SourceForge.net Logo
aXSL API 0.2

This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.