net.sf.freecol.common.networking
Class WorkMessage

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

public class WorkMessage
extends DOMMessage

Class to handle changes in work location.

Field Summary

private java.lang.String	unitId The id of the unit.
private java.lang.String	workLocationId The id of the work location.

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

document, logger

Constructor Summary

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

WorkMessage(Unit unit, WorkLocation workLocation)
Create a new WorkMessage for the supplied unit and work location.

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

workLocationId

private java.lang.String workLocationId

The id of the work location.

Constructor Detail

WorkMessage

public WorkMessage(Unit unit,
                   WorkLocation workLocation)

Create a new WorkMessage for the supplied unit and work location.

Parameters:

unit - The Unit to change the work location of.

workLocation - The WorkLocation to change to.

WorkMessage

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

Create a new WorkMessage 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 "work"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message received on.

Returns:

An update encapsulating the work location change or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"work".