net.sf.freecol.common.networking
Class BuyGoodsMessage

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

public class BuyGoodsMessage
extends DOMMessage

The message sent when buying goods in Europe.

Field Summary

private java.lang.String	amountString The amount of goods to buy.
private java.lang.String	carrierId The id of the carrier to load to goods onto.
private java.lang.String	goodsTypeId The id of the type of goods to buy.

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

document, logger

Constructor Summary

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

BuyGoodsMessage(Unit carrier, GoodsType type, int amount)
Create a new BuyGoodsMessage.

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 "buyGoods"-message.
org.w3c.dom.Element	toXMLElement() Convert this BuyGoodsMessage 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

carrierId

private java.lang.String carrierId

The id of the carrier to load to goods onto.

goodsTypeId

private java.lang.String goodsTypeId

The id of the type of goods to buy.

amountString

private java.lang.String amountString

The amount of goods to buy.

Constructor Detail

BuyGoodsMessage

public BuyGoodsMessage(Unit carrier,
                       GoodsType type,
                       int amount)

Create a new BuyGoodsMessage.

Parameters:

carrier - The Unit to load the goods onto.

type - The type of goods to buy.

amount - The amount of goods to buy.

BuyGoodsMessage

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

Create a new BuyGoodsMessage 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 "buyGoods"-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 carrier, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"buyGoods".