net.viktorc.detroid.framework.engine

Enum EnPassantRights

Object

Enum<EnPassantRights>

EnPassantRights

All Implemented Interfaces:

Serializable, Comparable<EnPassantRights>

public enum EnPassantRights
extends Enum<EnPassantRights>

A simple enum type for the representation of a side's en passant rights in a position.

Author:

Viktor

Enum Constant Summary

Enum Constants

Enum Constant and Description
A
B
C
D
E
F
G
H
NONE

Field Summary

Fields

Modifier and Type	Field and Description
byte	ind
static byte	TO_B_DEST_SQR_IND The difference between the EP right index and the square index of the destination of EP for black.
static byte	TO_B_VICT_SQR_IND The difference between the EP right index and the square index of the possible victim of EP for black.
static byte	TO_W_DEST_SQR_IND The difference between the EP right index and the square index of the destination of EP for white.
static byte	TO_W_VICT_SQR_IND The difference between the EP right index and the square index of the possible victim of EP for white.

Method Summary

Modifier and Type	Method and Description
static EnPassantRights	valueOf(String name) Returns the enum constant of this type with the specified name.
static EnPassantRights[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

A

public static final EnPassantRights A

B

public static final EnPassantRights B

C

public static final EnPassantRights C

D

public static final EnPassantRights D

E

public static final EnPassantRights E

F

public static final EnPassantRights F

G

public static final EnPassantRights G

H

public static final EnPassantRights H

NONE

public static final EnPassantRights NONE

Field Detail

TO_W_DEST_SQR_IND

public static final byte TO_W_DEST_SQR_IND

The difference between the EP right index and the square index of the destination of EP for white.

TO_W_VICT_SQR_IND

public static final byte TO_W_VICT_SQR_IND

The difference between the EP right index and the square index of the possible victim of EP for white.

TO_B_DEST_SQR_IND

public static final byte TO_B_DEST_SQR_IND

The difference between the EP right index and the square index of the destination of EP for black.

TO_B_VICT_SQR_IND

public static final byte TO_B_VICT_SQR_IND

The difference between the EP right index and the square index of the possible victim of EP for black.

ind

public final byte ind

Method Detail

values

public static EnPassantRights[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EnPassantRights c : EnPassantRights.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnPassantRights valueOf(String name)

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 name

NullPointerException - if the argument is null