org.jogre.common.comm
Class CommRequestData

java.lang.Object
  org.jogre.common.comm.CommGameMessage
      org.jogre.common.comm.CommRequestData

All Implemented Interfaces:

ITransmittable

public class CommRequestData

extends CommGameMessage

Communication class for a client requesting data.

Version:

Alpha 0.2.3

Author:

Bob Marks

Field Summary

static String

XML_ATT_DATA_TYPE

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

status, username, usernameTo, XML_ATT_STATUS, XML_ATT_USERNAME, XML_ATT_USERNAME_TO

Constructor Summary

CommRequestData(String dataType)
Constructor for a requesting data.

CommRequestData(XMLElement message)
Constructor which takes an XMLElement.

Method Summary

XMLElement	flatten() Flatten the object into an XMLElement.
String	getDataType() Return the data type that the user wishes to receive.

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

flatten, 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

Field Detail

XML_ATT_DATA_TYPE

public static final String XML_ATT_DATA_TYPE

See Also:

Constant Field Values

Constructor Detail

CommRequestData

public CommRequestData(String dataType)

Constructor for a requesting data. This can be either "game" (Game), "table_list" (TableList) or "user_list" (UserList).

CommRequestData

public CommRequestData(XMLElement message)
                throws TransmissionException

Constructor which takes an XMLElement.

Parameters:

message -

Throws:

TransmissionException

Method Detail

getDataType

public String getDataType()

Return the data type that the user wishes to receive.

Returns:

Data type.

flatten

public XMLElement flatten()

Flatten the object into an XMLElement.

Returns:

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

See Also:

ITransmittable.flatten()