Package net.rotgruengelb.nixienaut.math

Enum Class CardinalDirection

java.lang.Object

java.lang.Enum<CardinalDirection>

net.rotgruengelb.nixienaut.math.CardinalDirection

All Implemented Interfaces:

Serializable, Comparable<CardinalDirection>, Constable, StringIdentifiable

public enum CardinalDirection
extends Enum<CardinalDirection>
implements StringIdentifiable

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST
NORTH
SOUTH
WEST

Method Summary

Modifier and Type	Method	Description
String	getStringRepresentation()	The string representation of the object.
static CardinalDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CardinalDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORTH

public static final CardinalDirection NORTH

EAST

public static final CardinalDirection EAST

SOUTH

public static final CardinalDirection SOUTH

WEST

public static final CardinalDirection WEST

Method Details

values

public static CardinalDirection[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CardinalDirection valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getStringRepresentation

public String getStringRepresentation()

Description copied from interface: StringIdentifiable

The string representation of the object.

Specified by:

getStringRepresentation in interface StringIdentifiable

Returns:

The string representation of the object.