net.sf.freecol.common.networking
Class IndianDemandMessage

java.lang.Object
  net.sf.freecol.common.networking.DOMMessage
      net.sf.freecol.common.networking.IndianDemandMessage

public class IndianDemandMessage
extends DOMMessage

The message sent to resolve natives making demands of a colony.

Field Summary

private java.lang.String	colonyId
private java.lang.String	goldString
private Goods	goods
private java.lang.String	resultString
private java.lang.String	unitId

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

document, logger

Constructor Summary

IndianDemandMessage(Game game, org.w3c.dom.Element element)
Create a new IndianDemandMessage from a supplied element.

IndianDemandMessage(Unit unit, Colony colony, Goods goods, int gold)
Create a new IndianDemandMessage with the supplied unit, colony and demands.

Method Summary

Colony	getColony(Game game) Client-side convenience function to get the colony in this message.
int	getGold() Client-side convenience function to get the gold in this message.
Goods	getGoods() Client-side convenience function to get the goods in this message.
boolean	getResult() Client-side convenience function to set the result of this message.
Unit	getUnit(Game game) Client-side convenience function to get the unit in this message.
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 "indianDemand"-message.
void	setResult(boolean result) Client-side convenience function to set the result of this message.
org.w3c.dom.Element	toXMLElement() Convert this IndianDemandMessage to XML.

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

clientError, collapseElements, createError, createError, 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 java.lang.String unitId

colonyId

private java.lang.String colonyId

goods

private Goods goods

goldString

private java.lang.String goldString

resultString

private java.lang.String resultString

Constructor Detail

IndianDemandMessage

public IndianDemandMessage(Unit unit,
                           Colony colony,
                           Goods goods,
                           int gold)

Create a new IndianDemandMessage with the supplied unit, colony and demands.

Parameters:

unit - The Unit that is demanding.

colony - The Colony being demanded of.

goods - The Goods being demanded.

gold - The gold being demanded.

IndianDemandMessage

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

Create a new IndianDemandMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

getUnit

public Unit getUnit(Game game)

Client-side convenience function to get the unit in this message.

Parameters:

game - The Game to look for the unit in.

getColony

public Colony getColony(Game game)

Client-side convenience function to get the colony in this message.

Parameters:

game - The Game to look for the colony in.

getGoods

public Goods getGoods()

Client-side convenience function to get the goods in this message.

getGold

public int getGold()

Client-side convenience function to get the gold in this message.

getResult

public boolean getResult()

Client-side convenience function to set the result of this message.

Returns:

The result of this demand.

setResult

public void setResult(boolean result)

Client-side convenience function to set the result of this message.

Parameters:

result - The new result of this demand.

handle

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

Handle a "indianDemand"-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 indianDemandd unit, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"indianDemand".