net.sf.freecol.common.networking
Class DisembarkMessage

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

public class DisembarkMessage
extends Message

The message sent when disembarking.


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

DisembarkMessage

public DisembarkMessage(Unit unit)
Create a new DisembarkMessage with the supplied name.

Parameters:
unit - The Unit that is disembarking.

DisembarkMessage

public DisembarkMessage(Game game,
                        org.w3c.dom.Element element)
Create a new DisembarkMessage 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 "disembark"-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 disembarkd unit, or an error Element on failure.

toXMLElement

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