Package com.takenoko.engine

Enum Class GameState

java.lang.Object

java.lang.Enum<GameState>

com.takenoko.engine.GameState

All Implemented Interfaces:

Serializable, Comparable<GameState>, Constable

public enum GameState
extends Enum<GameState>

The GameState enum is used to represent the different states of the game as it progresses.

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
FINISHED	FINISHED state is used when the game is finished.
INITIALIZED	INITIALIZED state is used when the game is created but not started yet.
PLAYING	PLAYING state is used when the game is currently being played.
READY	READY state is used when the game is ready to be played.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	GameState()

Method Summary

Modifier and Type	Method	Description
static GameState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GameState[]	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

INITIALIZED

public static final GameState INITIALIZED

INITIALIZED state is used when the game is created but not started yet.

READY

public static final GameState READY

READY state is used when the game is ready to be played.

PLAYING

public static final GameState PLAYING

PLAYING state is used when the game is currently being played.

FINISHED

public static final GameState FINISHED

FINISHED state is used when the game is finished.

Constructor Details

GameState

private GameState()

Method Details

values

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