net.sf.freecol.common.networking
Class DemandTributeMessage

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

public class DemandTributeMessage
extends DOMMessage

The message sent when demanding tribute from a native settlement.

Field Summary

private java.lang.String	directionString The direction the demand is made.
private java.lang.String	unitId The id of the object demanding.

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

document, logger

Constructor Summary

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

DemandTributeMessage(Unit unit, Map.Direction direction)
Create a new DemandTributeMessage with the supplied unit and direction.

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 "demandTribute"-message.
org.w3c.dom.Element	toXMLElement() Convert this DemandTributeMessage 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

The id of the object demanding.

directionString

private java.lang.String directionString

The direction the demand is made.

Constructor Detail

DemandTributeMessage

public DemandTributeMessage(Unit unit,
                            Map.Direction direction)

Create a new DemandTributeMessage with the supplied unit and direction.

Parameters:

unit - The Unit that is demanding.

direction - The Direction the unit is looking.

DemandTributeMessage

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

Create a new DemandTributeMessage 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 "demandTribute"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player that sent the message.

connection - The Connection message was received on.

Returns:

An Element to update the originating player with the result of the demand.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"demandTribute".