net.sf.freecol.common.networking
Class EquipUnitMessage

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

public class EquipUnitMessage
extends DOMMessage

Class to handle equipping a unit.

Field Summary

private java.lang.String	amountString The amount of equipment.
private java.lang.String	typeId The id of the equipment type.
private java.lang.String	unitId The id of the unit.

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

document, logger

Constructor Summary

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

EquipUnitMessage(Unit unit, EquipmentType type, int amount)
Create a new EquipUnitMessage for the supplied unit and equipment type and amount.

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

typeId

private java.lang.String typeId

The id of the equipment type.

amountString

private java.lang.String amountString

The amount of equipment.

Constructor Detail

EquipUnitMessage

public EquipUnitMessage(Unit unit,
                        EquipmentType type,
                        int amount)

Create a new EquipUnitMessage for the supplied unit and equipment type and amount.

Parameters:

unit - The Unit to equip.

type - The EquipmentType to equip with.

amount - The amount of equipment.

EquipUnitMessage

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

Create a new EquipUnitMessage 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 "equipUnit"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message received on.

Returns:

An update encapsulating the equipUnit location change or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"equipUnit".