net.sf.freecol.common.networking
Class BuyPropositionMessage

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

public class BuyPropositionMessage
extends Message

The message sent when negotiating a purchase at an IndianSettlement.


Constructor Summary
BuyPropositionMessage(Game game, org.w3c.dom.Element element)
          Create a new BuyPropositionMessage from a supplied element.
BuyPropositionMessage(Unit unit, Settlement settlement, Goods goods, int gold)
          Create a new BuyPropositionMessage.
 
Method Summary
 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 "buyProposition"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this BuyPropositionMessage 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

BuyPropositionMessage

public BuyPropositionMessage(Unit unit,
                             Settlement settlement,
                             Goods goods,
                             int gold)
Create a new BuyPropositionMessage.

Parameters:
unit - The Unit that is buying.
goods - The Goods to buy.
gold - The price of the goods (negative if unknown).

BuyPropositionMessage

public BuyPropositionMessage(Game game,
                             org.w3c.dom.Element element)
Create a new BuyPropositionMessage 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 "buyProposition"-message.

Parameters:
server - The FreeColServer handling the message.
player - The Player the message applies to.
connection - The Connection message was received on.
Returns:
This BuyProposition message as an Element with updated gold value, or an error Element on failure.

toXMLElement

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