net.sf.freecol.common.networking

Class SellMessage

java.lang.Object

net.sf.freecol.common.networking.DOMMessage

net.sf.freecol.common.networking.SellMessage

public class SellMessage
extends DOMMessage

The message sent when selling at an IndianSettlement.

Field Summary

Fields

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

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

document, logger

Constructor Summary

Constructors

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

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

settlementId

private final java.lang.String settlementId

The object identifier of the settlement that is buying.

goods

private final Goods goods

The goods to be sold.

goldString

private final java.lang.String goldString

The sale price.

Constructor Detail

SellMessage

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

Create a new SellMessage.

Parameters:

unit - The Unit that is trading.

settlement - The Settlement that is trading.

goods - The Goods to sell.

gold - The price of the goods.

SellMessage

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

Create a new SellMessage 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 "sell"-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 as a result of the sale, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"sell".