Package org.woehlke.computer.kurzweil.commons.model

Enum Class LatticePointNeighbourhoodPosition

java.lang.Object

java.lang.Enum<LatticePointNeighbourhoodPosition>

org.woehlke.computer.kurzweil.commons.model.LatticePointNeighbourhoodPosition

All Implemented Interfaces:

Serializable, Comparable<LatticePointNeighbourhoodPosition>, Constable

public enum LatticePointNeighbourhoodPosition
extends Enum<LatticePointNeighbourhoodPosition>

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
CENTER
EAST
NORTH
NORTH_EAST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_WEST
WEST

Method Summary

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

CENTER

public static final LatticePointNeighbourhoodPosition CENTER

NORTH

public static final LatticePointNeighbourhoodPosition NORTH

EAST

public static final LatticePointNeighbourhoodPosition EAST

SOUTH

public static final LatticePointNeighbourhoodPosition SOUTH

WEST

public static final LatticePointNeighbourhoodPosition WEST

NORTH_EAST

public static final LatticePointNeighbourhoodPosition NORTH_EAST

SOUTH_EAST

public static final LatticePointNeighbourhoodPosition SOUTH_EAST

SOUTH_WEST

public static final LatticePointNeighbourhoodPosition SOUTH_WEST

NORTH_WEST

public static final LatticePointNeighbourhoodPosition NORTH_WEST

Method Details

values

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

getNeighbourhoodFor

public static LatticePointNeighbourhoodPosition[] getNeighbourhoodFor(LatticeNeighbourhoodType neighbourhoodType)