org.xmlcml.euclid

Enum Axis.Axis2

java.lang.Object

java.lang.Enum<Axis.Axis2>

org.xmlcml.euclid.Axis.Axis2

All Implemented Interfaces:

Serializable, Comparable<Axis.Axis2>

Enclosing class:

Axis

public static enum Axis.Axis2
extends Enum<Axis.Axis2>

enum for x y z axes

Enum Constant Summary

Enum Constants

Enum Constant and Description
X x axis.
Y y axis.

Field Summary

Fields

Modifier and Type	Field and Description
String	axis string value
int	value integer value

Method Summary

Modifier and Type	Method and Description
static Axis.Axis2	valueOf(String name) Returns the enum constant of this type with the specified name.
static Axis.Axis2[]	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.Axis2 X

x axis. value is 0 for indexing arrays.

Y

public static final Axis.Axis2 Y

y axis. value is 1 for indexing arrays.

Field Detail

axis

public final String axis

string value

value

public final int value

integer value

Method Detail

values

public static Axis.Axis2[] 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.Axis2 c : Axis.Axis2.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.Axis2 valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null