net.sf.freecol.common.networking
Class DebugForeignColonyMessage

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

public class DebugForeignColonyMessage
extends Message

The message sent when spying on a settlement.


Constructor Summary
DebugForeignColonyMessage(Game game, org.w3c.dom.Element element)
          Create a new DebugForeignColonyMessage from a supplied element.
DebugForeignColonyMessage(Tile tile)
          Create a new DebugForeignColonyMessage with the supplied tile.
 
Method Summary
 org.w3c.dom.Element getTileElement()
           
static java.lang.String getXMLElementTagName()
          The tag name of the root element representing this object.
 org.w3c.dom.Element handle(FreeColServer server, Connection connection)
          Handle a "spySettlement"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this DebugForeignColonyMessage 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

DebugForeignColonyMessage

public DebugForeignColonyMessage(Tile tile)
Create a new DebugForeignColonyMessage with the supplied tile.

Parameters:
tile - a Tile value

DebugForeignColonyMessage

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

Parameters:
game - The Game this message belongs to.
element - The Element to use to create the message.
Method Detail

getTileElement

public org.w3c.dom.Element getTileElement()

handle

public org.w3c.dom.Element handle(FreeColServer server,
                                  Connection connection)
Handle a "spySettlement"-message.

Parameters:
server - The FreeColServer that is handling the message.
connection - The Connection the message was received on.
Returns:
An Element containing a representation of the settlement being spied upon and any units at that position, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()
Convert this DebugForeignColonyMessage 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:
"debugForeignColony".