org.jogre.comm
Class CommDisconnect

java.lang.Object
  |
  +--org.jogre.comm.CommSimpleMessage
        |
        +--org.jogre.comm.CommDisconnect

All Implemented Interfaces:

ITransmittable

public class CommDisconnect

extends CommSimpleMessage

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

Version:

Alpha 0.1

Author:

Bob Marks

Field Summary

static int

CLIENT_DISCONNECT

Fields inherited from class org.jogre.comm.CommSimpleMessage

status, username

Constructor Summary

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

CommDisconnect(String username, int status)

Method Summary

String

flatten() This method flattens an ITransmittable object into a String which can be transmitted.

Methods inherited from class org.jogre.comm.CommSimpleMessage

getStatus, getUsername

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_DISCONNECT

public static final int CLIENT_DISCONNECT

Constructor Detail

CommDisconnect

public CommDisconnect(String username,
                      int status)

Parameters:

status -

username -

CommDisconnect

public CommDisconnect(String inString)
               throws TransmissionException

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

Parameters:

inString -

Throws:

TransmissionException -

Method Detail

flatten

public String flatten()

Description copied from interface: ITransmittable

This method flattens an ITransmittable object into a String which can be transmitted. The object can then be recreated again from this String using its single String parameter constructor.

Following copied from interface: org.jogre.comm.ITransmittable

Returns: