net.sf.freecol.common.networking
Class MoveToMessage

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

public class MoveToMessage
extends DOMMessage

The message sent when moving a unit across the high seas.

Field Summary

private java.lang.String	destinationId The id of the destination to be moved to.
private java.lang.String	unitId The id of the object to be moved.

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

document, logger

Constructor Summary

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

MoveToMessage(Unit unit, Location destination)
Create a new MoveToMessage for the supplied unit and destination.

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 "moveTo"-message.
org.w3c.dom.Element	toXMLElement() Convert this MoveToMessage 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 object to be moved.

destinationId

private java.lang.String destinationId

The id of the destination to be moved to.

Constructor Detail

MoveToMessage

public MoveToMessage(Unit unit,
                     Location destination)

Create a new MoveToMessage for the supplied unit and destination.

Parameters:

unit - The Unit to move.

destination - The Location to move to.

MoveToMessage

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

Create a new MoveToMessage 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 "moveTo"-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 moved unit, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"moveTo".