|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.freecol.common.networking.Message
net.sf.freecol.common.networking.DeliverGiftMessage
public class DeliverGiftMessage
The message sent when delivering a gift to a Settlement.
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.Message |
---|
clientError, createError, createError, createNewDocument, createNewRootElement, getAttribute, getChildElement, getDocument, getFreeColProtocolVersion, getType, hasAttribute, insertAsRoot, isType, setAttribute, setAttribute, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DeliverGiftMessage(Unit unit, Settlement settlement, Goods goods)
DeliverGiftMessage
.
unit
- The Unit
that is trading.settlement
- The Settlement
that is trading.goods
- The Goods
to deliverGift.public DeliverGiftMessage(Game game, org.w3c.dom.Element element)
DeliverGiftMessage
from a supplied element.
game
- The Game
this message belongs to.element
- The Element
to use to create the message.Method Detail |
---|
public Unit getUnit()
Unit
which is delivering the gift. This is a
helper routine to be called in-client as it blindly trusts its field.
public Settlement getSettlement()
Settlement
which is receiving the gift. This is a
helper routine to be called in-client as it blindly trusts its field.
public Goods getGoods()
Goods
delivered as a gift. This is a helper
routine to be called in-client as it blindly trusts its field.
public org.w3c.dom.Element handle(FreeColServer server, Player player, Connection connection)
server
- The FreeColServer
handling the message.player
- The Player
the message applies to.connection
- The Connection
message was received on.
Element
on failure.public org.w3c.dom.Element toXMLElement()
toXMLElement
in class Message
public static java.lang.String getXMLElementTagName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |