net.sf.gogui.go

Enum GoColor

java.lang.Object

java.lang.Enum<GoColor>

net.sf.gogui.go.GoColor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GoColor>

public enum GoColor
extends java.lang.Enum<GoColor>

Player color / state of a point on the board (black, white, empty).

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLACK Black stone or black player.
EMPTY Empty intersection.
WHITE White stone or white player.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<GoColor>	BLACK_WHITE
static java.util.List<GoColor>	BLACK_WHITE_EMPTY
static java.util.List<GoColor>	WHITE_BLACK

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getCapitalizedName() Return color name if used for specifying player.
abstract java.lang.String	getUppercaseLetter() Return uppercase letter identifying the color.
abstract boolean	isBlackWhite() Check if color is black or white.
abstract GoColor	otherColor() Return other color.
static GoColor	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GoColor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLACK

public static final GoColor BLACK

Black stone or black player.

WHITE

public static final GoColor WHITE

White stone or white player.

EMPTY

public static final GoColor EMPTY

Empty intersection.

Field Detail

BLACK_WHITE

public static final java.util.List<GoColor> BLACK_WHITE

WHITE_BLACK

public static final java.util.List<GoColor> WHITE_BLACK

BLACK_WHITE_EMPTY

public static final java.util.List<GoColor> BLACK_WHITE_EMPTY

Method Detail

values

public static GoColor[] 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 (GoColor c : GoColor.values())
    System.out.println(c);

Returns:

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

valueOf

public static GoColor valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCapitalizedName

public abstract java.lang.String getCapitalizedName()

Return color name if used for specifying player. Returns the capitalized color name (e.g. "Black" for BLACK). This name will also potentially be internationalized in the future.

getUppercaseLetter

public abstract java.lang.String getUppercaseLetter()

Return uppercase letter identifying the color. Returns "B", "W", or "E". This letter is not internationalized, such that it can be used for instance in standard language independent game results (e.g. "W+3").

isBlackWhite

public abstract boolean isBlackWhite()

Check if color is black or white.

Returns:

true, if color is BLACK or WHITE.

otherColor

public abstract GoColor otherColor()

Return other color.

Returns:

BLACK for WHITE, WHITE for BLACK, EMPTY for EMPTY.