net.sf.freecol.common.networking
Class AskSkillMessage

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

public class AskSkillMessage
extends DOMMessage

The message sent when asking for the skill taught at a settlement.

Field Summary

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

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

document, logger

Constructor Summary

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

AskSkillMessage(Unit unit, Map.Direction direction)
Create a new AskSkillMessage 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 "askSkill"-message.
org.w3c.dom.Element	toXMLElement() Convert this AskSkillMessage 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 asking.

directionString

private java.lang.String directionString

The direction the unit is asking in.

Constructor Detail

AskSkillMessage

public AskSkillMessage(Unit unit,
                       Map.Direction direction)

Create a new AskSkillMessage with the supplied unit and direction.

Parameters:

unit - The Unit that is asking.

direction - The Direction the unit is looking.

AskSkillMessage

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

Create a new AskSkillMessage 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 "askSkill"-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 to update the originating player with the result of the query.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"askSkill".