com.guiseframework.geometry
Enum Axis

java.lang.Object
  java.lang.Enum<Axis>
      com.guiseframework.geometry.Axis

All Implemented Interfaces:

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

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

Indicates an absolute axis; for example, a direction of layout.

Author:

Garret Wilson

See Also:

Flow

Enum Constant Summary

X
The X axis.

Y
The Y axis.

Z
The Z axis.

Method Summary

static Axis	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Axis[]	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

X

public static final Axis X

The X axis.

Y

public static final Axis Y

The Y axis.

Z

public static final Axis Z

The Z axis. This value is currently unused.

Method Detail

values

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

Returns:

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

valueOf

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