net.sf.freecol.common.networking
Class ChangeWorkTypeMessage

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

public class ChangeWorkTypeMessage
extends DOMMessage

The message sent when changing the work type of a unit.

Field Summary

private java.lang.String	unitId The id of the unit that is working.
private java.lang.String	workTypeId The goods type to produce.

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

document, logger

Constructor Summary

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

ChangeWorkTypeMessage(Unit unit, GoodsType workType)
Create a new ChangeWorkTypeMessage with the supplied unit and produce.

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

workTypeId

private java.lang.String workTypeId

The goods type to produce.

Constructor Detail

ChangeWorkTypeMessage

public ChangeWorkTypeMessage(Unit unit,
                             GoodsType workType)

Create a new ChangeWorkTypeMessage with the supplied unit and produce.

Parameters:

unit - The Unit that is working.

workType - The GoodsType to produce.

ChangeWorkTypeMessage

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

Create a new ChangeWorkTypeMessage 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 "changeWorkType"-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 changes, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"changeWorkType".