net.sf.freecol.common.networking
Class AbandonColonyMessage

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

public class AbandonColonyMessage
extends DOMMessage

The message sent when the client requests abandoning of a colony.

Field Summary

(package private) java.lang.String

colonyId The colony to abandon.

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

document, logger

Constructor Summary

AbandonColonyMessage(Colony colony)
Create a new AbandonColonyMessage with the specified colony.

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

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 "abandonColony"-message.
org.w3c.dom.Element	toXMLElement() Convert this AbandonColonyMessage 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

colonyId

java.lang.String colonyId

The colony to abandon.

Constructor Detail

AbandonColonyMessage

public AbandonColonyMessage(Colony colony)

Create a new AbandonColonyMessage with the specified colony.

Parameters:

colony - The Colony to abandon.

AbandonColonyMessage

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

Create a new AbandonColonyMessage 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 "abandonColony"-message.

Parameters:

server - The FreeColServer handling the request.

player - The Player abandoning the colony.

connection - The Connection the message is from.

Returns:

An update Element defining the new colony and updating its surrounding tiles, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"abandonColony".