org.jogre.comm
Class CommError

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

All Implemented Interfaces:

ITransmittable

public class CommError

extends CommSimpleMessage

Communications class which is used to send an error from the server to a client or vice-versa.

Version:

Alpha 0.1

Author:

Bob Marks

Field Summary

static int

GENERAL_ERROR

Fields inherited from class org.jogre.comm.CommSimpleMessage

status, username

Constructor Summary

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

CommError(String username, int errorCode)

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

GENERAL_ERROR

public static final int GENERAL_ERROR

Constructor Detail

CommError

public CommError(String username,
                 int errorCode)

Parameters:

username -

errorCode -

CommError

public CommError(String inString)
          throws TransmissionException

Constructor which creates a CommError object from the flatten () method of another CommError 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: