net.sf.freecol.common.networking

Class BuyMessage

java.lang.Object

net.sf.freecol.common.networking.DOMMessage

net.sf.freecol.common.networking.BuyMessage

public class BuyMessage
extends DOMMessage

The message sent when purchasing at an IndianSettlement.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	goldString The price to pay.
private Goods	goods The goods to be bought.
private java.lang.String	settlementId The object identifier of the settlement that is selling.
private java.lang.String	unitId The object identifier of the unit that is buying.

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

document, logger

Constructor Summary

Constructors

Constructor and Description
BuyMessage(Game game, org.w3c.dom.Element element) Create a new BuyMessage from a supplied element.
BuyMessage(Unit unit, Settlement settlement, Goods goods, int gold) Create a new BuyMessage.

Method Summary

Modifier and Type	Method and Description
int	getGold() What is the price currently negotiated for this transaction?
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 "buy"-message.
org.w3c.dom.Element	toXMLElement() Convert this BuyMessage to XML.

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

clientError, collapseElements, createError, createError, createMessage, createMessage, 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 final java.lang.String unitId

The object identifier of the unit that is buying.

settlementId

private final java.lang.String settlementId

The object identifier of the settlement that is selling.

goods

private final Goods goods

The goods to be bought.

goldString

private final java.lang.String goldString

The price to pay.

Constructor Detail

BuyMessage

public BuyMessage(Unit unit,
                  Settlement settlement,
                  Goods goods,
                  int gold)

Create a new BuyMessage.

Parameters:

unit - The Unit that is buying.

settlement - The Settlement that is trading.

goods - The Goods to buy.

gold - The price of the goods.

BuyMessage

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

Create a new BuyMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

getGold

public int getGold()

What is the price currently negotiated for this transaction?

Returns:

The current price.

handle

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

Handle a "buy"-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 following the purchase, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"buy".