net.sf.freecol.common.networking
Class BuildColonyMessage

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

public class BuildColonyMessage
extends DOMMessage

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

Field Summary

(package private) java.lang.String	builderId The unit that is building the colony.
(package private) java.lang.String	colonyName The name of the new colony.

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

document, logger

Constructor Summary

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

BuildColonyMessage(java.lang.String colonyName, Unit builder)
Create a new BuildColonyMessage with the supplied name and building 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 "buildColony"-message.
org.w3c.dom.Element	toXMLElement() Convert this BuildColonyMessage to XML.

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

clientError, createError, createError, createNewDocument, createNewRootElement, 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

colonyName

java.lang.String colonyName

The name of the new colony.

builderId

java.lang.String builderId

The unit that is building the colony.

Constructor Detail

BuildColonyMessage

public BuildColonyMessage(java.lang.String colonyName,
                          Unit builder)

Create a new BuildColonyMessage with the supplied name and building unit.

Parameters:

colonyName - The name for the new colony.

builder - The Unit to do the building.

BuildColonyMessage

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

Create a new BuildColonyMessage 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 "buildColony"-message.

Parameters:

server - The FreeColServer handling the request.

player - The Player building 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 BuildColonyMessage 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:

"buildColony".