|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.freecol.common.networking.Message
net.sf.freecol.common.networking.BuildColonyMessage
public class BuildColonyMessage
The message sent when the client requests building of a colony.
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.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 |
---|
public BuildColonyMessage(java.lang.String colonyName, Unit builder)
BuildColonyMessage
with the supplied name
and building unit.
colonyName
- The name for the new colony.builder
- The Unit
to do the building.public BuildColonyMessage(Game game, org.w3c.dom.Element element)
BuildColonyMessage
from a supplied element.
game
- The Game
this message belongs to.element
- The Element
to use to create the message.Method Detail |
---|
public org.w3c.dom.Element handle(FreeColServer server, Player player, Connection connection)
server
- The FreeColServer
handling the request.player
- The Player
building the colony.connection
- The Connection
the message is from.
Element
defining the new colony
and updating its surrounding tiles,
or an error Element
on failure.public org.w3c.dom.Element toXMLElement()
toXMLElement
in class Message
public static java.lang.String getXMLElementTagName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |