me.eccentric_nz.TARDIS.enumeration

Enum COMPASS

java.lang.Object

java.lang.Enum<COMPASS>

me.eccentric_nz.TARDIS.enumeration.COMPASS

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST
NORTH
SOUTH
WEST

Method Summary

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

EAST

public static final COMPASS EAST

SOUTH

public static final COMPASS SOUTH

WEST

public static final COMPASS WEST

NORTH

public static final COMPASS NORTH

Method Detail

values

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

Returns:

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

valueOf

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