SourceForge.net Logo
aXSL API 0.2

org.axsl.common.value
Enum AbsoluteAxis

java.lang.Object
  extended by java.lang.Enum<AbsoluteAxis>
      extended by org.axsl.common.value.AbsoluteAxis
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AbsoluteAxis>

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

An enumeration of absolute axes.


Enum Constant Summary
HORIZONTAL
          Constant indicating the horizontal absolute axis.
VERTICAL
          Constant indicating the vertical relative axis.
 
Method Summary
 AbsoluteAxis getOpposite()
          Returns the opposite axis.
static AbsoluteAxis valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AbsoluteAxis[] 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

HORIZONTAL

public static final AbsoluteAxis HORIZONTAL
Constant indicating the horizontal absolute axis.


VERTICAL

public static final AbsoluteAxis VERTICAL
Constant indicating the vertical relative axis.

Method Detail

values

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

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

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

getOpposite

public AbsoluteAxis getOpposite()
Returns the opposite axis.

Returns:
The opposite axis.

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.