net.sf.freecol.common.networking
Class PutOutsideColonyMessage

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

public class PutOutsideColonyMessage
extends DOMMessage

The message sent when putting a unit outside a colony.

Field Summary

private java.lang.String

unitId The id of the unit to be put out.

Fields inherited from class net.sf.freecol.common.networking.DOMMessage

document, logger

Constructor Summary

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

PutOutsideColonyMessage(Unit unit)
Create a new PutOutsideColonyMessage with 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, Player player, Connection connection) Handle a "putOutsideColony"-message.
org.w3c.dom.Element	toXMLElement() Convert this PutOutsideColonyMessage 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 unit to be put out.

Constructor Detail

PutOutsideColonyMessage

public PutOutsideColonyMessage(Unit unit)

Create a new PutOutsideColonyMessage with the supplied unit.

Parameters:

unit - The Unit to put outside.

PutOutsideColonyMessage

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

Create a new PutOutsideColonyMessage 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 "putOutsideColony"-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 encapsulating the change. or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this PutOutsideColonyMessage 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:

"putOutsideColony".