Package net.pl3x.map.core.util

Enum Class SpiralIterator.Direction

java.lang.Object

java.lang.Enum<SpiralIterator.Direction>

net.pl3x.map.core.util.SpiralIterator.Direction

All Implemented Interfaces:

Serializable, Comparable<SpiralIterator.Direction>, Constable

Enclosing class:

SpiralIterator

public static enum SpiralIterator.Direction
extends Enum<SpiralIterator.Direction>

Represents the cardinal directions

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
@NotNull SpiralIterator.Direction	next()	Get the next direction in a clockwise pattern
static SpiralIterator.Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SpiralIterator.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

EAST

public static final SpiralIterator.Direction EAST

SOUTH

public static final SpiralIterator.Direction SOUTH

WEST

public static final SpiralIterator.Direction WEST

NORTH

public static final SpiralIterator.Direction NORTH

Method Details

values

public static SpiralIterator.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 SpiralIterator.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

next

@NotNull
public @NotNull SpiralIterator.Direction next()

Get the next direction in a clockwise pattern

Returns:

next direction