net.sf.freecol.common.networking
Class PayForBuildingMessage

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

public class PayForBuildingMessage
extends DOMMessage

The message sent when paying for a building.

Field Summary

private java.lang.String

colonyId The id of the colony that is building.

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

document, logger

Constructor Summary

PayForBuildingMessage(Colony colony)
Create a new PayForBuildingMessage with the supplied colony.

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

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

colonyId

private java.lang.String colonyId

The id of the colony that is building.

Constructor Detail

PayForBuildingMessage

public PayForBuildingMessage(Colony colony)

Create a new PayForBuildingMessage with the supplied colony.

Parameters:

colony - The Colony that is building.

PayForBuildingMessage

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

Create a new PayForBuildingMessage 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 "payForBuilding"-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 payForBuildingd unit, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"payForBuilding".