net.sf.freecol.common.networking
Class ScoutIndianSettlementMessage

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

public class ScoutIndianSettlementMessage
extends DOMMessage

The message sent when scouting a native settlement.

Field Summary

private java.lang.String	directionString The direction the unit is learning in.
private java.lang.String	unitId The id of the unit that is learning.

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

document, logger

Constructor Summary

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

ScoutIndianSettlementMessage(Unit unit, Map.Direction direction)
Create a new ScoutIndianSettlementMessage 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, Player player, Connection connection) Handle a "scoutIndianSettlement"-message.
org.w3c.dom.Element	toXMLElement() Convert this ScoutIndianSettlementMessage 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 unit that is learning.

directionString

private java.lang.String directionString

The direction the unit is learning in.

Constructor Detail

ScoutIndianSettlementMessage

public ScoutIndianSettlementMessage(Unit unit,
                                    Map.Direction direction)

Create a new ScoutIndianSettlementMessage with the supplied unit and direction.

Parameters:

unit - The Unit that is learning.

direction - The Direction the unit is looking.

ScoutIndianSettlementMessage

public ScoutIndianSettlementMessage(Game game,
                                    org.w3c.dom.Element element)

Create a new ScoutIndianSettlementMessage 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 "scoutIndianSettlement"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

An element containing the result of the scouting action, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

Convert this ScoutIndianSettlementMessage 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:

"scoutIndianSettlement".