org.jogre.common.comm
Class CommSitDown

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

All Implemented Interfaces:

ITransmittable

public class CommSitDown

extends CommTableMessage

Small communication object which is used when a client sits down on a particular seat at a table. If the seat is free the player list is updated and notifications are sent to all players at this table.

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

CommSitDown(int seatNum)
Constructor for requesting joining an existing table.

CommSitDown(XMLElement message)
Constructor which takes an XMLElement.

Method Summary

XMLElement	flatten() Flatten the String for transmission purposes.
int	getSeatNum() Return the seat number.

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

CommSitDown

public CommSitDown(int seatNum)

Constructor for requesting joining an existing table.

CommSitDown

public CommSitDown(XMLElement message)

Constructor which takes an XMLElement.

Parameters:

message -

Method Detail

getSeatNum

public int getSeatNum()

Return the seat number.

Returns:

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()