net.sf.freecol.common.networking
Class UnloadCargoMessage

java.lang.Object
  extended by net.sf.freecol.common.networking.DOMMessage
      extended by net.sf.freecol.common.networking.UnloadCargoMessage

public class UnloadCargoMessage
extends DOMMessage

The message sent when unloading cargo onto a carrier.


Field Summary
private  Goods goods
          The goods to be unloaded.
 
Fields inherited from class net.sf.freecol.common.networking.DOMMessage
document, logger
 
Constructor Summary
UnloadCargoMessage(Game game, org.w3c.dom.Element element)
          Create a new UnloadCargoMessage from a supplied element.
UnloadCargoMessage(Goods goods)
          Create a new UnloadCargoMessage with the supplied goods and carrier.
 
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 "unloadCargo"-message.
 org.w3c.dom.Element toXMLElement()
          Convert this UnloadCargoMessage 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

goods

private Goods goods
The goods to be unloaded.

Constructor Detail

UnloadCargoMessage

public UnloadCargoMessage(Goods goods)
Create a new UnloadCargoMessage with the supplied goods and carrier.

Parameters:
goods - The Goods to unload.

UnloadCargoMessage

public UnloadCargoMessage(Game game,
                          org.w3c.dom.Element element)
Create a new UnloadCargoMessage 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 "unloadCargo"-message.

Parameters:
server - The FreeColServer handling the message.
player - The Player the message applies to.
connection - The Connection message received on.
Returns:
An update containing the containing location or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()
Convert this UnloadCargoMessage 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:
"unloadCargo".