net.sf.freecol.common.networking
Class JoinColonyMessage

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

public class JoinColonyMessage
extends Message

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


Constructor Summary
JoinColonyMessage(Colony colony, Unit builder)
          Create a new JoinColonyMessage with the supplied name and building unit.
JoinColonyMessage(Game game, org.w3c.dom.Element element)
          Create a new JoinColonyMessage 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 "joinColony"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this JoinColonyMessage 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

JoinColonyMessage

public JoinColonyMessage(Colony colony,
                         Unit builder)
Create a new JoinColonyMessage with the supplied name and building unit.

Parameters:
colony - a Colony value
builder - The Unit to do the building.

JoinColonyMessage

public JoinColonyMessage(Game game,
                         org.w3c.dom.Element element)
Create a new JoinColonyMessage 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 "joinColony"-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 JoinColonyMessage 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:
"buildColony".