net.sf.freecol.common.networking
Class GoodsForSaleMessage

java.lang.Object
  extended by net.sf.freecol.common.networking.Message
      extended by net.sf.freecol.common.networking.GoodsForSaleMessage

public class GoodsForSaleMessage
extends Message

The message sent when renaming a FreeColGameObject.


Constructor Summary
GoodsForSaleMessage(Game game, org.w3c.dom.Element element)
          Create a new GoodsForSaleMessage from a supplied element.
GoodsForSaleMessage(Unit unit, Settlement settlement)
          Create a new GoodsForSaleMessage with the supplied name.
 
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 "goodsForSale"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this GoodsForSaleMessage to XML.
 
Methods inherited from class net.sf.freecol.common.networking.Message
clientError, createError, createError, createNewDocument, createNewRootElement, getAttribute, getChildElement, getDocument, getFreeColProtocolVersion, getType, hasAttribute, insertAsRoot, isType, setAttribute, setAttribute, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GoodsForSaleMessage

public GoodsForSaleMessage(Unit unit,
                           Settlement settlement)
Create a new GoodsForSaleMessage with the supplied name.

Parameters:
unit - The Unit that is trading.
settlement - The Settlement that is trading.

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

handle

public org.w3c.dom.Element handle(FreeColServer server,
                                  Player player,
                                  Connection connection)
Handle a "goodsForSale"-message.

Parameters:
server - The FreeColServer that is handling the message.
player - The Player the message applies to.
connection - The Connection the 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 Message
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".