org.starhope.appius.game
Enum GameStateFlag

java.lang.Object
  java.lang.Enum<GameStateFlag>
      org.starhope.appius.game.GameStateFlag

All Implemented Interfaces:

Serializable, Comparable<GameStateFlag>

public enum GameStateFlag
extends Enum<GameStateFlag>

The state of a GameEvent is one of countdown (between rounds), running (currently in team or mass play), and solo (practice or attract mode)

Author:

brpocock@star-hope.org

Enum Constant Summary

GAME_COUNTDOWN
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) GAME_COUNTDOWN (GameStateFlag)

GAME_RUNNING
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) GAME_RUNNING (GameStateFlag)

GAME_SOLO
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) GAME_SOLO (GameStateFlag)

Method Summary

static GameStateFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static GameStateFlag[]	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

GAME_COUNTDOWN

public static final GameStateFlag GAME_COUNTDOWN

WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) GAME_COUNTDOWN (GameStateFlag)

GAME_RUNNING

public static final GameStateFlag GAME_RUNNING

WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) GAME_RUNNING (GameStateFlag)

GAME_SOLO

public static final GameStateFlag GAME_SOLO

WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) GAME_SOLO (GameStateFlag)

Method Detail

values

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

Returns:

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

valueOf

public static GameStateFlag 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