net.sf.freecol.common.networking
Class EmbarkMessage

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

public class EmbarkMessage
extends DOMMessage

The message sent when embarking.

Field Summary

private java.lang.String	carrierId The id of the carrier to embark onto.
private java.lang.String	directionString An optional direction for the unit to move to find the carrier.
private java.lang.String	unitId The id of the unit embarking.

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

document, logger

Constructor Summary

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

EmbarkMessage(Unit unit, Unit carrier, Map.Direction direction)
Create a new EmbarkMessage with the supplied unit, carrier and optional 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 "embark"-message.
org.w3c.dom.Element	toXMLElement() Convert this EmbarkMessage 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 embarking.

carrierId

private java.lang.String carrierId

The id of the carrier to embark onto.

directionString

private java.lang.String directionString

An optional direction for the unit to move to find the carrier.

Constructor Detail

EmbarkMessage

public EmbarkMessage(Unit unit,
                     Unit carrier,
                     Map.Direction direction)

Create a new EmbarkMessage with the supplied unit, carrier and optional direction.

Parameters:

unit - The Unit to embark.

carrier - The carrier Unit to embark on.

direction - An option direction to embark in.

EmbarkMessage

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

Create a new EmbarkMessage 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 "embark"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

An update containing the embarked unit, or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"embark".