game.states
Enum PlayerState

java.lang.Object
  java.lang.Enum<PlayerState>
      game.states.PlayerState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PlayerState>

public enum PlayerState
extends java.lang.Enum<PlayerState>
implements java.io.Serializable

PlayerState contains the possible states of the Client when connected to the server.
DISCONNECTED: the client is no longer connected to the server.
CONNECTED: the client is connected and able to receive invites from other players.
WAITING: the client has an invite and is waiting to start a game.
PLAYING: the client is in a game and is not able to receive nor give invites.

Author:

Chris Barton

Enum Constant Summary

CONNECTED

DISCONNECTED

PLAYING

WAITING

Method Summary

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

DISCONNECTED

public static final PlayerState DISCONNECTED

CONNECTED

public static final PlayerState CONNECTED

WAITING

public static final PlayerState WAITING

PLAYING

public static final PlayerState PLAYING

Method Detail

values

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

Returns:

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

valueOf

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