net.sf.freecol.common.networking
Class EmigrateUnitMessage

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

public class EmigrateUnitMessage
extends Message

The message sent when a unit is to emigrate.


Constructor Summary
EmigrateUnitMessage(Game game, org.w3c.dom.Element element)
          Create a new EmigrateUnitMessage from a supplied element.
EmigrateUnitMessage(int slot)
          Create a new EmigrateUnitMessage with the supplied slot.
 
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 "emigrateUnit"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this EmigrateUnitMessage 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

EmigrateUnitMessage

public EmigrateUnitMessage(int slot)
Create a new EmigrateUnitMessage with the supplied slot.

Parameters:
slot - The slot to select the migrant from.

EmigrateUnitMessage

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

Parameters:
server - The FreeColServer that is handling the message.
player - The Player the message applies to.
connection - The Connection the message was received on.
Returns:
A multiple element containing the updated Europe and any required ModelMessages, or an error Element on failure.

toXMLElement

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