Package io.github.wolfraam.chessgame.move.castle

Enum Class CastleMoveType

java.lang.Object

java.lang.Enum<CastleMoveType>

io.github.wolfraam.chessgame.move.castle.CastleMoveType

All Implemented Interfaces:

Serializable, Comparable<CastleMoveType>, Constable

public enum CastleMoveType
extends Enum<CastleMoveType>

The four different castle move types.

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
BLACK_KING_SIDE
BLACK_QUEEN_SIDE
WHITE_KING_SIDE
WHITE_QUEEN_SIDE

Field Summary

Fields

Modifier and Type	Field	Description
final CastleType	castleType
final Set<Square>	requiringEmptySquares
final Square	rookFrom
final Piece	rookPiece
final Square	rookTo
final Side	side

Method Summary

Modifier and Type	Method	Description
static CastleMoveType	determine(Square from, Square to, Piece piece)
static CastleMoveType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CastleMoveType[]	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

BLACK_KING_SIDE

public static final CastleMoveType BLACK_KING_SIDE

BLACK_QUEEN_SIDE

public static final CastleMoveType BLACK_QUEEN_SIDE

WHITE_KING_SIDE

public static final CastleMoveType WHITE_KING_SIDE

WHITE_QUEEN_SIDE

public static final CastleMoveType WHITE_QUEEN_SIDE

Field Details

castleType

public final CastleType castleType

requiringEmptySquares

public final Set<Square> requiringEmptySquares

rookFrom

public final Square rookFrom

rookPiece

public final Piece rookPiece

rookTo

public final Square rookTo

side

public final Side side

Method Details

values

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

determine

public static CastleMoveType determine(Square from,
 Square to,
 Piece piece)