net.sf.freecol.common.networking
Class MoveMessage

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

public class MoveMessage
extends DOMMessage

The message sent when moving a unit.

Field Summary

private java.lang.String	directionString The direction to move.
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

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

MoveMessage(Unit unit, Map.Direction direction)
Create a new MoveMessage for the supplied unit and direction.

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

directionString

private java.lang.String directionString

The direction to move.

Constructor Detail

MoveMessage

public MoveMessage(Unit unit,
                   Map.Direction direction)

Create a new MoveMessage for the supplied unit and direction.

Parameters:

unit - The Unit to move.

direction - The Direction to move in.

MoveMessage

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

Create a new MoveMessage 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 "move"-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 MoveMessage 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:

"move".