net.sf.freecol.common.networking
Class CashInTreasureTrainMessage

java.lang.Object
  net.sf.freecol.common.networking.DOMMessage
      net.sf.freecol.common.networking.CashInTreasureTrainMessage

public class CashInTreasureTrainMessage
extends DOMMessage

The message sent when cashing in a treasure train.

Field Summary

private java.lang.String

unitId The id of the object to be cashed in.

Fields inherited from class net.sf.freecol.common.networking.DOMMessage

document, logger

Constructor Summary

CashInTreasureTrainMessage(Game game, org.w3c.dom.Element element)
Create a new CashInTreasureTrainMessage from a supplied element.

CashInTreasureTrainMessage(Unit unit)
Create a new CashInTreasureTrainMessage with the supplied name.

Method Summary

static java.lang.String	getXMLElementTagName() The tag name of the root element representing this object.
org.w3c.dom.Element	handle(FreeColServer server, Player player, Connection connection) Handle a "cashInTreasureTrain"-message.
org.w3c.dom.Element	toXMLElement() Convert this CashInTreasureTrainMessage to XML.

Methods inherited from class net.sf.freecol.common.networking.DOMMessage

clientError, createError, createError, createNewDocument, createNewRootElement, getAttribute, getChildElement, getDocument, getFreeColProtocolVersion, getType, hasAttribute, insertAsRoot, isType, setAttribute, setAttribute, toString

Methods inherited from class java.lang.Object

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

Field Detail

unitId

private java.lang.String unitId

The id of the object to be cashed in.

Constructor Detail

CashInTreasureTrainMessage

public CashInTreasureTrainMessage(Unit unit)

Create a new CashInTreasureTrainMessage with the supplied name.

Parameters:

unit - The Unit to cash in.

CashInTreasureTrainMessage

public CashInTreasureTrainMessage(Game game,
                                  org.w3c.dom.Element element)

Create a new CashInTreasureTrainMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

handle

public org.w3c.dom.Element handle(FreeColServer server,
                                  Player player,
                                  Connection connection)

Handle a "cashInTreasureTrain"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

An update resulting from cashing in the treasure train, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this CashInTreasureTrainMessage to XML.

Overrides:

toXMLElement in class DOMMessage

Returns:

The XML representation of this message.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

The tag name of the root element representing this object.

Returns:

"cashInTreasureTrain".