net.sf.freecol.common.networking
Class PayArrearsMessage

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

public class PayArrearsMessage
extends DOMMessage

The message sent when paying tax arrears.

Field Summary

private java.lang.String

goodsTypeId The id of the GoodsType to pay arrears for.

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

document, logger

Constructor Summary

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

PayArrearsMessage(GoodsType type)
Create a new PayArrearsMessage with the supplied goods type.

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

goodsTypeId

private java.lang.String goodsTypeId

The id of the GoodsType to pay arrears for.

Constructor Detail

PayArrearsMessage

public PayArrearsMessage(GoodsType type)

Create a new PayArrearsMessage with the supplied goods type.

Parameters:

type - The GoodsType to pay arrears for.

PayArrearsMessage

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

Create a new PayArrearsMessage 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 "payArrears"-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 payArrearsd unit, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"payArrears".