net.sf.freecol.common.networking
Class LootCargoMessage

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

public class LootCargoMessage
extends DOMMessage

The message sent when looting cargo.

Field Summary

private java.util.List<Goods>	goods The goods to be looted.
private java.lang.String	loserId The ID of the unit that is looted.
private java.lang.String	winnerId The ID of the unit that is looting.

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

document, logger

Constructor Summary

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

LootCargoMessage(Unit winner, java.lang.String loserId, java.util.List<Goods> goods)
Create a new LootCargoMessage.

Method Summary

java.lang.String	getDefenderId() Public accessor to help the client igc.
java.util.List<Goods>	getGoods() Public accessor to help the client igc.
Unit	getUnit(Game game) Public accessor to help the client igc.
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 "lootCargo"-message.
org.w3c.dom.Element	toXMLElement() Convert this LootCargoMessage 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

winnerId

private java.lang.String winnerId

The ID of the unit that is looting.

loserId

private java.lang.String loserId

The ID of the unit that is looted.

goods

private java.util.List<Goods> goods

The goods to be looted.

Constructor Detail

LootCargoMessage

public LootCargoMessage(Unit winner,
                        java.lang.String loserId,
                        java.util.List<Goods> goods)

Create a new LootCargoMessage.

Parameters:

winner - The Unit that is looting.

loserId - The id of the Unit that is looted.

goods - The AbstractGoods to loot.

LootCargoMessage

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

Create a new LootCargoMessage from a supplied element.

Parameters:

game - The Game this message belongs to.

element - The Element to use to create the message.

Method Detail

getUnit

public Unit getUnit(Game game)

Public accessor to help the client igc.

Returns:

The winner unit.

getDefenderId

public java.lang.String getDefenderId()

Public accessor to help the client igc.

Returns:

The defender Id.

getGoods

public java.util.List<Goods> getGoods()

Public accessor to help the client igc.

Returns:

The goods to loot.

handle

public org.w3c.dom.Element handle(FreeColServer server,
                                  Player player,
                                  Connection connection)

Handle a "lootCargo"-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 encapsulating the looting.

Throws:

java.lang.IllegalStateException - if there is problem with the arguments.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"lootCargo".