net.sf.freecol.common.networking
Class SpySettlementMessage

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

public class SpySettlementMessage
extends DOMMessage

The message sent when spying on a settlement.

Field Summary

private java.lang.String	directionString The direction the spy is looking.
private java.lang.String	unitId The id of the object doing the spying.

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

document, logger

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

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.DOMMessage

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

unitId

private java.lang.String unitId

The id of the object doing the spying.

directionString

private java.lang.String directionString

The direction the spy is looking.

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

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 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:

"spySettlement".