org.jogre.common.comm
Class CommStartGame

java.lang.Object
  org.jogre.common.comm.CommGameMessage
      org.jogre.common.comm.CommTableMessage
          org.jogre.common.comm.CommStartGame

All Implemented Interfaces:

ITransmittable

public class CommStartGame

extends CommTableMessage

Small communication object for starting a game

Version:

Alpha 0.2.3

Author:

Bob Marks

Field Summary

Fields inherited from class org.jogre.common.comm.CommTableMessage

NO_TABLE, tableNum, XML_ATT_TABLE_NUM

Fields inherited from class org.jogre.common.comm.CommGameMessage

status, username, usernameTo, XML_ATT_STATUS, XML_ATT_USERNAME, XML_ATT_USERNAME_TO

Constructor Summary

CommStartGame(String currentPlayer, int tableNum)
Constructor for requesting joining an existing table.

CommStartGame(XMLElement message)
Constructor which takes an XMLElement.

Method Summary

XMLElement	flatten() Flatten the String for transmission purposes.
String	getCurrentPlayer() Return the current player.

Methods inherited from class org.jogre.common.comm.CommTableMessage

flatten, getTableNum, setTableNum

Methods inherited from class org.jogre.common.comm.CommGameMessage

getStatus, getUsername, getUsernameTo, isUsernameSet, isUsernameToSet, setUsername, setUsernameTo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommStartGame

public CommStartGame(String currentPlayer,
                     int tableNum)

Constructor for requesting joining an existing table.

Parameters:

tableNum - Table number of table where game is starting

CommStartGame

public CommStartGame(XMLElement message)

Constructor which takes an XMLElement.

Parameters:

message -

Method Detail

getCurrentPlayer

public String getCurrentPlayer()

Return the current player.

Returns:

Current player.

flatten

public XMLElement flatten()

Flatten the String for transmission purposes.

Returns:

XML version of the state of an object which can be constructed again.

See Also:

ITransmittable.flatten()