net.sf.freecol.common.networking

Class SellGoodsMessage

java.lang.Object

net.sf.freecol.common.networking.DOMMessage

net.sf.freecol.common.networking.SellGoodsMessage

public class SellGoodsMessage
extends DOMMessage

The message sent when selling goods in Europe.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	amountString The amount of goods to sell.
private java.lang.String	carrierId The identifier of the carrier to unload to goods from.
private java.lang.String	goodsTypeId The identifier of the type of goods to sell.

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

document, logger

Constructor Summary

Constructors

Constructor and Description
SellGoodsMessage(Game game, org.w3c.dom.Element element) Create a new SellGoodsMessage from a supplied element.
SellGoodsMessage(Goods goods, Unit carrier) Create a new SellGoodsMessage.

Method Summary

Methods

Modifier and Type	Method and Description
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 "sellGoods"-message.
org.w3c.dom.Element	toXMLElement() Convert this SellGoodsMessage 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

carrierId

private java.lang.String carrierId

The identifier of the carrier to unload to goods from.

goodsTypeId

private java.lang.String goodsTypeId

The identifier of the type of goods to sell.

amountString

private java.lang.String amountString

The amount of goods to sell.

Constructor Detail

SellGoodsMessage

public SellGoodsMessage(Goods goods,
                Unit carrier)

Create a new SellGoodsMessage.

Parameters:

goods - The Goods to sell.

carrier - The Unit carrying the goods.

SellGoodsMessage

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

Create a new SellGoodsMessage 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 "sellGoods"-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 SellGoodsMessage 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:

"sellGoods".