org.jogre.common.comm
Class CommDisconnect

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

All Implemented Interfaces:

ITransmittable

public class CommDisconnect

extends CommGameMessage

Communication class which is used to disconnect a user from the system.

Version:

Alpha 0.2.3

Author:

Bob Marks

Field Summary

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

status, username, usernameTo, XML_ATT_STATUS, XML_ATT_USERNAME, XML_ATT_USERNAME_TO

Constructor Summary

CommDisconnect()
Constructor which specifies that a client wishes to disconnect.

CommDisconnect(String username)
Message sent from server to other clients.

CommDisconnect(XMLElement message)
Constructor which creates a CommDisconnect object from the flatten () method of another CommDisconnect object.

Method Summary

XMLElement

flatten() Flatten disconnect object.

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

Constructor Detail

CommDisconnect

public CommDisconnect()

Constructor which specifies that a client wishes to disconnect.

CommDisconnect

public CommDisconnect(String username)

Message sent from server to other clients.

Parameters:

username -

CommDisconnect

public CommDisconnect(XMLElement message)
               throws TransmissionException

Constructor which creates a CommDisconnect object from the flatten () method of another CommDisconnect object.

Parameters:

message -

Throws:

TransmissionException

Method Detail

flatten

public XMLElement flatten()

Flatten disconnect object.

Returns:

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

See Also:

ITransmittable.flatten()