net.sf.freecol.common.networking
Class UpdateCurrentStopMessage

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

public class UpdateCurrentStopMessage
extends Message

The message sent updating a unit's current stop.


Constructor Summary
UpdateCurrentStopMessage(Game game, org.w3c.dom.Element element)
          Create a new UpdateCurrentStopMessage from a supplied element.
UpdateCurrentStopMessage(Unit unit)
          Create a new UpdateCurrentStopMessage for the supplied unit.
 
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 "updateCurrentStop"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this UpdateCurrentStopMessage 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

UpdateCurrentStopMessage

public UpdateCurrentStopMessage(Unit unit)
Create a new UpdateCurrentStopMessage for the supplied unit.

Parameters:
unit - A Unit whose stop is to be updated.

UpdateCurrentStopMessage

public UpdateCurrentStopMessage(Game game,
                                org.w3c.dom.Element element)
Create a new UpdateCurrentStopMessage 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 "updateCurrentStop"-message.

Parameters:
server - The FreeColServer handling the message.
connection - The Connection the message is from.
Returns:
An update containing the unit after updating its current stop, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()
Convert this UpdateCurrentStopMessage 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:
"updateCurrentStop".