net.sf.freecol.common.networking
Class SpySettlementMessage

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

public class SpySettlementMessage
extends Message

The message sent when spying on a settlement.


Constructor Summary
SpySettlementMessage(Game game, org.w3c.dom.Element element)
          Create a new SpySettlementMessage from a supplied element.
SpySettlementMessage(Unit unit, Map.Direction direction)
          Create a new SpySettlementMessage with the supplied unit and direction.
 
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 SpySettlementMessage 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

SpySettlementMessage

public SpySettlementMessage(Unit unit,
                            Map.Direction direction)
Create a new SpySettlementMessage with the supplied unit and direction.

Parameters:
unit - The Unit that is spying.
direction - The Direction the unit is looking.

SpySettlementMessage

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