- All Implemented Interfaces:
Serializable
,Comparable<Rotation>
,java.lang.constant.Constable
public enum Rotation extends Enum<Rotation>
Rotation in terms of "clockwise" or "anti-clockwise". Most useful for getting
the next state from a
VonNeumannNeighbourhood
or
MooreNeighbourhood
element by calling its
Neighbourhood.next(Rotation)
method.-
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 ANTI_CLOCKWISE
Represents an anti-clockwise rotation.CLOCKWISE
Represents a clockwise rotation. -
Method Summary
Modifier and Type Method Description Rotation
inverse()
Inverts the rotation direction.<N extends Neighbourhood<N>>
Nnext(N aNeighbourhood)
Returns the next neighbourhood relative to the provided neighbourhood.static Rotation
valueOf(String name)
Returns the enum constant of this type with the specified name.static Rotation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
CLOCKWISE
Represents a clockwise rotation. -
ANTI_CLOCKWISE
Represents an anti-clockwise rotation.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
inverse
Inverts the rotation direction. ACLOCKWISE
rotation becomes anANTI_CLOCKWISE
rotation and vice versa.- Returns:
- The inverted ("the other way round") rotation.
-
next
Returns the next neighbourhood relative to the provided neighbourhood. Depending on theRotation
state, eitherNeighbourhood.clockwiseNext()
CLOCKWISE
orNeighbourhood.clockwisePrevious()
ANTI_CLOCKWISE
- Type Parameters:
N
- The neighbourhood such as theVonNeumannNeighbourhood
or theMooreNeighbourhood
.- Parameters:
aNeighbourhood
- The current state for which to retrieve the next neighbourhood.- Returns:
- The next state relative to the given state.
-