net.sf.freecol.common.networking
Class DeliverGiftMessage

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

public class DeliverGiftMessage
extends DOMMessage

The message sent when delivering a gift to a Settlement.

Field Summary

private Goods	goods The goods to be delivered.
private java.lang.String	settlementId The ID of the settlement the gift is going to.
private java.lang.String	unitId The ID of the unit that is delivering the gift.

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

document, logger

Constructor Summary

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

DeliverGiftMessage(Unit unit, Settlement settlement, Goods goods)
Create a new DeliverGiftMessage.

Method Summary

Goods	getGoods() Get the Goods delivered as a gift.
Settlement	getSettlement() Get the Settlement which is receiving the gift.
Unit	getUnit() Get the Unit which is delivering the gift.
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 "deliverGift"-message.
org.w3c.dom.Element	toXMLElement() Convert this DeliverGiftMessage to XML.

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

clientError, collapseElements, createError, createError, createNewDocument, createNewRootElement, elementToString, 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 unit that is delivering the gift.

settlementId

private java.lang.String settlementId

The ID of the settlement the gift is going to.

goods

private Goods goods

The goods to be delivered.

Constructor Detail

DeliverGiftMessage

public DeliverGiftMessage(Unit unit,
                          Settlement settlement,
                          Goods goods)

Create a new DeliverGiftMessage.

Parameters:

unit - The Unit that is trading.

settlement - The Settlement that is trading.

goods - The Goods to deliverGift.

DeliverGiftMessage

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

Create a new DeliverGiftMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

getUnit

public Unit getUnit()

Get the Unit which is delivering the gift. This is a helper routine to be called in-client as it blindly trusts its field.

Returns:

The unit, or null if none.

getSettlement

public Settlement getSettlement()

Get the Settlement which is receiving the gift. This is a helper routine to be called in-client as it blindly trusts its field.

Returns:

The settlement, or null if none.

getGoods

public Goods getGoods()

Get the Goods delivered as a gift. This is a helper routine to be called in-client as it blindly trusts its field.

Returns:

The goods, or null if none.

handle

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

Handle a "deliverGift"-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 containing the unit and settlement, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this DeliverGiftMessage 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:

"deliverGift".