net.sf.freecol.common.networking
Class SetDestinationMessage

java.lang.Object
  extended by net.sf.freecol.common.networking.Message
      extended by net.sf.freecol.common.networking.SetDestinationMessage

public class SetDestinationMessage
extends Message

The message sent when the client requests setting a unit destination.


Constructor Summary
SetDestinationMessage(Game game, org.w3c.dom.Element element)
          Create a new SetDestinationMessage from a supplied element.
SetDestinationMessage(Unit unit, Location destination)
          Create a new SetDestinationMessage with 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, Connection connection)
          Handle a "setDestination"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this SetDestinationMessage to XML.
 
Methods inherited from class net.sf.freecol.common.networking.Message
clientError, createError, createError, createNewDocument, createNewRootElement, getAttribute, getChildElement, getDocument, getFreeColProtocolVersion, getType, hasAttribute, insertAsRoot, isType, setAttribute, setAttribute, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SetDestinationMessage

public SetDestinationMessage(Unit unit,
                             Location destination)
Create a new SetDestinationMessage with the supplied unit and destination.

Parameters:
unit - The Unit whose destination is to be set
destination - The destination to set (may be null)

SetDestinationMessage

public SetDestinationMessage(Game game,
                             org.w3c.dom.Element element)
Create a new SetDestinationMessage 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,
                                  Connection connection)
Handle a "setDestination"-message.

Parameters:
server - The FreeColServer handling the message.
connection - The Connection the message is from.
Returns:
An update containing the unit with the new destination, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()
Convert this SetDestinationMessage to XML.

Overrides:
toXMLElement in class Message
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:
"setDestination".