Package it.polimi.ingsw.Model.Enums

Enum Class PawnColour

java.lang.Object

java.lang.Enum<PawnColour>

it.polimi.ingsw.Model.Enums.PawnColour

All Implemented Interfaces:

Serializable, Comparable<PawnColour>, Constable

public enum PawnColour
extends Enum<PawnColour>
implements Serializable

Represents the colour of many pawns on the game boards, like Students and Teachers.

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
BLUE
GREEN
PINK
RED
YELLOW

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PawnColour()

Method Summary

Modifier and Type	Method	Description
static PawnColour	getPawnColourFromText(String text)	Convert a string to a valid PawnColour
static PawnColour	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PawnColour[]	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

GREEN

public static final PawnColour GREEN

RED

public static final PawnColour RED

YELLOW

public static final PawnColour YELLOW

PINK

public static final PawnColour PINK

BLUE

public static final PawnColour BLUE

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

PawnColour

private PawnColour()

Method Details

values

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

getPawnColourFromText

public static PawnColour getPawnColourFromText(String text)

Convert a string to a valid PawnColour

Parameters:

text - string containing a colour

Returns:

the appropriate PawnColour or null when the string does not represent a valid pawnColour