Module org.refcodes.checkerboard

Package org.refcodes.checkerboard

Enum Class NeighbourhoodPositions

java.lang.Object

java.lang.Enum<NeighbourhoodPositions>

org.refcodes.checkerboard.NeighbourhoodPositions

All Implemented Interfaces:

Serializable, Comparable<NeighbourhoodPositions>, Constable

public enum NeighbourhoodPositions
extends Enum<NeighbourhoodPositions>

Returns the Position elements as of the according Neighbourhood.

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
MOORE	As of MooreNeighbourhood.
VON_NEUMANN	As of VonNeumannNeighbourhood.

Method Summary

Modifier and Type	Method	Description
org.refcodes.graphical.Position[]	getNeighbours()	Returns the Position elements as of the according Neighbourhood.
static NeighbourhoodPositions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NeighbourhoodPositions[]	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

VON_NEUMANN

public static final NeighbourhoodPositions VON_NEUMANN

As of VonNeumannNeighbourhood.

MOORE

public static final NeighbourhoodPositions MOORE

As of MooreNeighbourhood.

Method Details

values

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

getNeighbours

public org.refcodes.graphical.Position[] getNeighbours()

Returns the Position elements as of the according Neighbourhood.

Returns:

The according Position elements.