Package za.co.wethinkcode.robots.shared

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

za.co.wethinkcode.robots.shared.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Enum that annotates the cardinal directions absolutely

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	Eastern direction of the world
NORTH	North direction of the world
SOUTH	Southern direction of the world
WEST	Western direction of the world

Method Summary

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

North direction of the world

EAST

public static final Direction EAST

Eastern direction of the world

SOUTH

public static final Direction SOUTH

Southern direction of the world

WEST

public static final Direction WEST

Western direction of the world

Method Details

values

public static Direction[] 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 Direction 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