net.sf.freecol.common.networking
Class ChangeWorkImprovementTypeMessage

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

public class ChangeWorkImprovementTypeMessage
extends DOMMessage

The message sent when changing a work improvement type.

Field Summary

private java.lang.String	improvementId The id of the improvement type.
private java.lang.String	unitId The id of the unit that is working.

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

document, logger

Constructor Summary

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

ChangeWorkImprovementTypeMessage(Unit unit, TileImprovementType type)
Create a new ChangeWorkImprovementTypeMessage with the supplied unit and improvement 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 "changeWorkImprovementType"-message.
org.w3c.dom.Element	toXMLElement() Convert this ChangeWorkImprovementTypeMessage 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 unit that is working.

improvementId

private java.lang.String improvementId

The id of the improvement type.

Constructor Detail

ChangeWorkImprovementTypeMessage

public ChangeWorkImprovementTypeMessage(Unit unit,
                                        TileImprovementType type)

Create a new ChangeWorkImprovementTypeMessage with the supplied unit and improvement type.

Parameters:

unit - The Unit that is working.

type - The new TileImprovementType.

ChangeWorkImprovementTypeMessage

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

Create a new ChangeWorkImprovementTypeMessage 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 "changeWorkImprovementType"-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 changeWorkImprovementTyped unit, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"changeWorkImprovementType".