net.sf.freecol.common.networking

Class GoodsForSaleMessage

java.lang.Object

net.sf.freecol.common.networking.DOMMessage

net.sf.freecol.common.networking.GoodsForSaleMessage

public class GoodsForSaleMessage
extends DOMMessage

The message sent when querying a settlement for what it has for sale.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<Goods>	sellGoods The list of goods for sale.
private java.lang.String	settlementId The identifier of the settlement that is trading.
private java.lang.String	unitId The identifier of the unit that is trading.

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

document, logger

Constructor Summary

Constructors

Constructor and Description
GoodsForSaleMessage(Game game, org.w3c.dom.Element element) Create a new GoodsForSaleMessage from a supplied element.
GoodsForSaleMessage(Unit unit, Settlement settlement, java.util.List<Goods> sellGoods) Create a new GoodsForSaleMessage with the supplied name.

Method Summary

Modifier and Type	Method and Description
java.util.List<Goods>	getGoods()
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 "goodsForSale"-message.
org.w3c.dom.Element	toXMLElement() Convert this GoodsForSaleMessage 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 identifier of the unit that is trading.

settlementId

private final java.lang.String settlementId

The identifier of the settlement that is trading.

sellGoods

private final java.util.List<Goods> sellGoods

The list of goods for sale.

Constructor Detail

GoodsForSaleMessage

public GoodsForSaleMessage(Unit unit,
                           Settlement settlement,
                           java.util.List<Goods> sellGoods)

Create a new GoodsForSaleMessage with the supplied name.

Parameters:

unit - The Unit that is trading.

settlement - The Settlement that is trading.

sellGoods - A list of Goods to be sold.

GoodsForSaleMessage

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

Create a new GoodsForSaleMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

getGoods

public java.util.List<Goods> getGoods()

handle

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

Handle a "goodsForSale"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

This GoodsForSaleMessage with the goods for sale attached as children or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"goodsForSale".