net.sf.freecol.common.networking
Class BuyMessage

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

public class BuyMessage
extends Message

The message sent when purchasing at an IndianSettlement.


Constructor Summary
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
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.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

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

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:
Null.
Throws:
java.lang.IllegalStateException - if there is problem with the arguments.

toXMLElement

public org.w3c.dom.Element toXMLElement()
Convert this BuyMessage 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:
"buy".