Package etomica.util

Enum Constants.CompassDirection

java.lang.Object

java.lang.Enum<Constants.CompassDirection>

etomica.util.Constants.CompassDirection

Enclosing class:

Constants

public static enum Constants.CompassDirection
extends java.lang.Enum<Constants.CompassDirection>

Enumerated type for the compass directions NORTH, SOUTH, EAST, WEST. Used to express the orientation of an object.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST
NORTH
SOUTH
WEST

Method Summary

Modifier and Type	Method	Description
java.lang.String	toString()
static Constants.CompassDirection	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Constants.CompassDirection[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH

public static final Constants.CompassDirection NORTH

SOUTH

public static final Constants.CompassDirection SOUTH

WEST

public static final Constants.CompassDirection WEST

EAST

public static final Constants.CompassDirection EAST

Method Detail

values

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

Returns:

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

valueOf

public static Constants.CompassDirection 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Constants.CompassDirection>