net.sf.freecol.common.networking
Class UpdateTradeRouteMessage

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

public class UpdateTradeRouteMessage
extends DOMMessage

The message sent when updating a trade route.

Field Summary

private TradeRoute

tradeRoute The trade route to update.

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

document, logger

Constructor Summary

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

UpdateTradeRouteMessage(TradeRoute tradeRoute)
Create a new UpdateTradeRouteMessage with the supplied trade route.

Method Summary

static java.lang.String	getXMLElementTagName() The tag name of the root element representing this object.
org.w3c.dom.Element	handle(FreeColServer server, Connection connection) Handle a "updateTradeRoute"-message.
org.w3c.dom.Element	toXMLElement() Convert this UpdateTradeRouteMessage 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

tradeRoute

private TradeRoute tradeRoute

The trade route to update.

Constructor Detail

UpdateTradeRouteMessage

public UpdateTradeRouteMessage(TradeRoute tradeRoute)

Create a new UpdateTradeRouteMessage with the supplied trade route.

Parameters:

tradeRoute - The TradeRoute to update.

UpdateTradeRouteMessage

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

Create a new UpdateTradeRouteMessage 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,
                                  Connection connection)

Handle a "updateTradeRoute"-message.

Parameters:

server - The FreeColServer handling the message.

connection - The Connection message was received on.

Returns:

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

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"updateTradeRoute".