org.jogre.common.playerstate
Class PlayerState

java.lang.Object
  |
  +--org.jogre.common.playerstate.PlayerState

All Implemented Interfaces:

ITransmittable

Direct Known Subclasses:

PlayerStateGameStarted, PlayerStateReady, PlayerStateSeated, PlayerStateViewing

public abstract class PlayerState

extends Object

implements ITransmittable

Class which describes the state of the various player when they join a table. This class employs the STATE design pattern from the GOF.

Version:

Alpha 0.1

Author:

Bob Marks

Field Summary

static int	GAME_STARTED
static int	READY_TO_START
static int	SEATED
static int	VIEWING

Constructor Summary

PlayerState()

Method Summary

abstract boolean	canOfferDrawResign() Returns true if a user can offer a draw or resign.
abstract boolean	canSit(PlayerList players) Returns true if a user can sit.
abstract boolean	canStand(PlayerList players) Returns true if a user can stand.
abstract boolean	canStart(PlayerList players) Returns true if a user can hit the start.
abstract int	intValue() Integer label of this state (see constants of this class).
abstract PlayerState	sit() Abstract method which defines what a player can do when they sit.
abstract PlayerState	stand() Abstract method which defines what a player can do when they stand up.
abstract PlayerState	start() Abstract method which defines what a player can do when they start.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jogre.comm.ITransmittable

flatten

Field Detail

VIEWING

public static final int VIEWING

SEATED

public static final int SEATED

READY_TO_START

public static final int READY_TO_START

GAME_STARTED

public static final int GAME_STARTED

Constructor Detail

PlayerState

public PlayerState()

Method Detail

sit

public abstract PlayerState sit()

Abstract method which defines what a player can do when they sit.

Returns:

PlayerState object.

stand

public abstract PlayerState stand()

Abstract method which defines what a player can do when they stand up.

Returns:

PlayerState object.

start

public abstract PlayerState start()

Abstract method which defines what a player can do when they start.

Returns:

PlayerState object.

canSit

public abstract boolean canSit(PlayerList players)

Returns true if a user can sit.

Parameters:

players - List of players.

Returns:

canStand

public abstract boolean canStand(PlayerList players)

Returns true if a user can stand.

Parameters:

players - List of players.

Returns:

canStart

public abstract boolean canStart(PlayerList players)

Returns true if a user can hit the start.

Parameters:

players - List of players.

Returns:

canOfferDrawResign

public abstract boolean canOfferDrawResign()

Returns true if a user can offer a draw or resign.

Returns:

intValue

public abstract int intValue()

Integer label of this state (see constants of this class).

Returns: