net.sf.freecol.common.networking
Class InciteMessage

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

public class InciteMessage
extends DOMMessage

The message sent when inciting a native settlement.

Field Summary

private java.lang.String	directionString The direction to the settlement.
private java.lang.String	enemyId The id of the enemy to incite against.
private java.lang.String	goldString The amount of gold in the bribe.
private java.lang.String	unitId The id of the unit inciting.

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

document, logger

Constructor Summary

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

InciteMessage(Unit unit, Map.Direction direction, Player enemy, int gold)
Create a new InciteMessage with the supplied name.

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 "incite"-message.
org.w3c.dom.Element	toXMLElement() Convert this InciteMessage 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 inciting.

directionString

private java.lang.String directionString

The direction to the settlement.

enemyId

private java.lang.String enemyId

The id of the enemy to incite against.

goldString

private java.lang.String goldString

The amount of gold in the bribe.

Constructor Detail

InciteMessage

public InciteMessage(Unit unit,
                     Map.Direction direction,
                     Player enemy,
                     int gold)

Create a new InciteMessage with the supplied name.

Parameters:

unit - The inciting Unit.

direction - The Direction to the settlement.

enemy - The enemy Player.

gold - The amount of gold in the bribe (negative for the initial inquiry).

InciteMessage

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

Create a new InciteMessage 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 "incite"-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 incite, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"incite".