Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.zazof.jteg
Class StartMessage  view StartMessage download StartMessage.java

java.lang.Object
  extended byorg.zazof.jteg.Message
      extended byorg.zazof.jteg.StartMessage
Direct Known Subclasses:
StartMessageProt5

public class StartMessage
extends Message


Field Summary
private  int $counter
           
private  java.util.Vector $help
           
private  int $index
           
private static boolean DEBUG
           
 
Fields inherited from class org.zazof.jteg.Message
 
Constructor Summary
StartMessage(Message nextMessage)
           
 
Method Summary
 java.lang.String constructMessageString(java.lang.String[] messageParts)
          This method will return a Stringrepresentation of a servermessage that corresponds to the different messageParts given as a parameter.
 Message decodeMessage(java.lang.String messageDescription)
          This method will return a Message that correctly processed the string according the active protocol.
 java.lang.String getMessageName()
          This method returns the name of the message (e.g.
 int getPlayerColor()
           
 int getPlayerID()
           
 java.lang.String getPlayerName()
           
 boolean hasMoreInformation()
          returns true if there is more player information in this message
 void nextInformation()
          if you want to access the next information object
 void resetInformation()
          resets the information pointer, so you could start back at the beginning
 
Methods inherited from class org.zazof.jteg.Message
getNextMessage, hasNextMessage, setNextMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

$help

private java.util.Vector $help

$counter

private int $counter

$index

private int $index

DEBUG

private static final boolean DEBUG
See Also:
Constant Field Values
Constructor Detail

StartMessage

public StartMessage(Message nextMessage)
Method Detail

decodeMessage

public Message decodeMessage(java.lang.String messageDescription)
                      throws UnknownMessageException
Description copied from class: Message
This method will return a Message that correctly processed the string according the active protocol. If no message was found that could process the inputstring, an exception is thrown.

The default implementation by message just passes the request on to the next message in the chain. If other behaviour is desired, this method needs to be overridden.

Overrides:
decodeMessage in class Message

constructMessageString

public java.lang.String constructMessageString(java.lang.String[] messageParts)
                                        throws UnknownMessageException
Description copied from class: Message
This method will return a Stringrepresentation of a servermessage that corresponds to the different messageParts given as a parameter. If no correct message could be constructed from the parts, an exception is thrown.

The default implementation by message just passes the request on to the next message in the chain. If other behaviour is desired, this method needs to be overridden.

Overrides:
constructMessageString in class Message

getMessageName

public java.lang.String getMessageName()
Description copied from class: Message
This method returns the name of the message (e.g. 'attaque' or 'loser', ...).

Specified by:
getMessageName in class Message

hasMoreInformation

public boolean hasMoreInformation()
returns true if there is more player information in this message


resetInformation

public void resetInformation()
resets the information pointer, so you could start back at the beginning


nextInformation

public void nextInformation()
if you want to access the next information object


getPlayerName

public java.lang.String getPlayerName()

getPlayerColor

public int getPlayerColor()

getPlayerID

public int getPlayerID()