com.playhub

Enum GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub

java.lang.Object

java.lang.Enum<GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub>

com.playhub.GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub>

Enclosing class:

GameInfoToReturnToPlayHub

public static enum GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub
extends java.lang.Enum<GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub>

The game's current state. This is returned to PlayHub as part of the GameInfoToReturnToPlayHub.

Author:

alon

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED_BY_GAME The game had to be stopped by the game itself.
CANCELLED_BY_USER The game has been cancelled by the user in some way.
FINISHED The game has finished in a regular manner (i.e.
RUNNING The game is currently running.

Method Summary

Methods

Modifier and Type	Method and Description
static GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RUNNING

public static final GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub RUNNING

The game is currently running.

FINISHED

public static final GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub FINISHED

The game has finished in a regular manner (i.e. someone won, or some other scenario legitimate for your game).

CANCELLED_BY_USER

public static final GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub CANCELLED_BY_USER

The game has been cancelled by the user in some way. Irrelevant for most games, but you can wish this state if you please. It only differs to the users from FINISHED in the message they receive about the ending of the game, and that is doesn't require the game to return who is the "winner" (as their obviously isn't one).

CANCELLED_BY_GAME

public static final GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub CANCELLED_BY_GAME

The game had to be stopped by the game itself. Irrelevant for most games, but you can wish this state if you please. It only differs to the users from FINISHED and CANCELLED_BY_USER in the message they receive about the ending of the game, and as CANCELLED_BY_USER, if this is returned then you are not required to retuen a valid winnerUserId, as their is no "winner".

Method Detail

values

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

Returns:

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

valueOf

public static GameInfoToReturnToPlayHub.GameStateToReturnToPlayhub 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