net.sf.freecol.common.networking
Class MissionaryMessage

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

public class MissionaryMessage
extends DOMMessage

The message sent when a missionary establishes/denounces a mission.

Field Summary

private boolean	denounce Is this a denunciation?
private java.lang.String	directionString The direction to the settlement.
private java.lang.String	unitId The id of the missionary.

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

document, logger

Constructor Summary

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

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

directionString

private java.lang.String directionString

The direction to the settlement.

denounce

private boolean denounce

Is this a denunciation?

Constructor Detail

MissionaryMessage

public MissionaryMessage(Unit unit,
                         Map.Direction direction,
                         boolean denounce)

Create a new MissionaryMessage with the supplied name.

Parameters:

unit - The missionary Unit.

direction - The Direction to the settlement.

denounce - True if this is a denunciation.

MissionaryMessage

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

Create a new MissionaryMessage 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 "missionary"-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 mission operation, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"missionary".