Package net.sf.colossus.game
Enum Class PlayerColor
- All Implemented Interfaces:
Serializable
,Comparable<PlayerColor>
,Constable
Models the notion of a color a player can pick.
This is not just the actual color of the markers, but also the names used
for it (long and short version) as well as a suitable foreground color. The
marker color itself is available through the {
getBackgroundColor()
method.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PlayerColor
static List
<PlayerColor> static PlayerColor
getByShortName
(String shortName) int
getName()
toString()
static PlayerColor
Returns the enum constant of this class with the specified name.static PlayerColor[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
BLACK
-
BLUE
-
BROWN
-
GOLD
-
GREEN
-
RED
-
ORANGE
-
PURPLE
-
SILVER
-
SKY
-
PINE
-
INDIGO
-
-
Field Details
-
name
-
shortName
-
mnemonic
private final int mnemonic -
backgroundColor
-
foregroundColor
-
-
Constructor Details
-
PlayerColor
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getMnemonic
public int getMnemonic() -
getName
-
getShortName
-
getBackgroundColor
-
getForegroundColor
-
getByName
-
getByShortName
-
getByName
-
toString
- Overrides:
toString
in classEnum<PlayerColor>
-