ReplyMessage (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.common.networking.Message
- - net.sf.freecol.common.networking.TrivialMessage
  - - net.sf.freecol.common.networking.AttributeMessage
    - - net.sf.freecol.common.networking.WrapperMessage
      - net.sf.freecol.common.networking.ReplyMessage

public class ReplyMessage
extends WrapperMessage

The basic reply message wrapper.

Nested Class Summary
- Nested classes/interfaces inherited from class net.sf.freecol.common.networking.Message
  Message.MessagePriority

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String TAG
- Fields inherited from class net.sf.freecol.common.networking.WrapperMessage
  REPLY_ID_TAG
- Fields inherited from class net.sf.freecol.common.networking.AttributeMessage
  attributes
- Fields inherited from class net.sf.freecol.common.networking.TrivialMessage
  continueMessage, disconnectMessage, endTurnMessage, enterRevengeModeMessage, reconnectMessage, requestLaunchMessage, retireMessage, startGameMessage
- Fields inherited from class net.sf.freecol.common.networking.Message
  logger, messagePriorityComparator

Constructor Summary

Constructors
Constructor	Description
`ReplyMessage(int replyId, Message message)`	Create a new `ReplyMessage` of a given type.
`ReplyMessage(Game game, FreeColXMLReader xr)`	Create a new `ReplyMessage` from a stream.

Method Summary
- Methods inherited from class net.sf.freecol.common.networking.WrapperMessage
  clientHandler, getMessage, getSubType, isEmpty, serverHandler, toString, writeChildren
- Methods inherited from class net.sf.freecol.common.networking.AttributeMessage
  canMerge, getPriority, getStringAttribute, getStringAttributeMap, hasAttribute, setMergeable, setStringAttribute
- Methods inherited from class net.sf.freecol.common.networking.TrivialMessage
  aiHandler, appendChild, appendChildren, currentPlayerMessage, getChildCount, getChildren, getType, setChildren, setType
- Methods inherited from class net.sf.freecol.common.networking.Message
  clientGeneric, expected, getArrayAttributes, getBooleanAttribute, getChild, getChildren, getEnumAttribute, getIntegerAttribute, getPriorityLevel, igc, igc, invokeAndWait, invokeLater, isType, merge, pgc, pgc, pretty, read, setArrayAttributes, setArrayAttributes, setBooleanAttribute, setEnumAttribute, setIntegerAttribute, setStringAttributeMap, setStringAttributes, setStringAttributes, toXML, writeAttributes
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReplyMessage
```
public ReplyMessage(int replyId,
                    Message message)
```
    Create a new ReplyMessage of a given type.
    
    Parameters:
    
    replyId - The reply id.
    
    message - The Message to encapsulate.
  - ReplyMessage
```
public ReplyMessage(Game game,
                    FreeColXMLReader xr)
             throws javax.xml.stream.XMLStreamException,
                    FreeColException
```
    Create a new ReplyMessage from a stream.
    
    Parameters:
    
    game - The Game to read within.
    
    xr - The FreeColXMLReader to read from.
    
    Throws:
    
    javax.xml.stream.XMLStreamException - if the stream is corrupt.
    
    FreeColException - if the internal message can not be read.