net.sf.freecol.common.networking
Class ClaimLandMessage

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

public class ClaimLandMessage
extends DOMMessage

The message sent when the client requests claiming land.

Field Summary

private java.lang.String	priceString The price to pay for the tile.
private java.lang.String	settlementId The ID of the Settlement to own the tile, if any.
private java.lang.String	tileId The ID of the tile to claim.

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

document, logger

Constructor Summary

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

ClaimLandMessage(Tile tile, Settlement settlement, int price)
Create a new ClaimLandMessage.

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 "claimLand"-message.
org.w3c.dom.Element	toXMLElement() Convert this ClaimLandMessage to XML.

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

clientError, createError, createError, createNewDocument, createNewRootElement, 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

tileId

private java.lang.String tileId

The ID of the tile to claim.

settlementId

private java.lang.String settlementId

The ID of the Settlement to own the tile, if any.

priceString

private java.lang.String priceString

The price to pay for the tile.

Constructor Detail

ClaimLandMessage

public ClaimLandMessage(Tile tile,
                        Settlement settlement,
                        int price)

Create a new ClaimLandMessage.

Parameters:

tile - The Tile to claim.

settlement - The Settlement to own the tile, if any.

price - The price to pay for the tile, negative if stealing.

ClaimLandMessage

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

Create a new ClaimLandMessage 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 "claimLand"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection the message was from.

Returns:

An update, or error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"claimLand".