net.sf.freecol.common.networking
Class AssignTradeRouteMessage

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

public class AssignTradeRouteMessage
extends DOMMessage

The message sent when assigning a trade route to a unit.

Field Summary

private java.lang.String	tradeRouteId The id of the trade route.
private java.lang.String	unitId The id of the unit.

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

document, logger

Constructor Summary

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

AssignTradeRouteMessage(Unit unit, TradeRoute tradeRoute)
Create a new AssignTradeRouteMessage with the supplied unit and 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 "assignTradeRoute"-message.
org.w3c.dom.Element	toXMLElement() Convert this AssignTradeRouteMessage 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.

tradeRouteId

private java.lang.String tradeRouteId

The id of the trade route.

Constructor Detail

AssignTradeRouteMessage

public AssignTradeRouteMessage(Unit unit,
                               TradeRoute tradeRoute)

Create a new AssignTradeRouteMessage with the supplied unit and route.

Parameters:

unit - The Unit to assign a trade route to.

tradeRoute - The TradeRoute to assign.

AssignTradeRouteMessage

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

Create a new AssignTradeRouteMessage 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 "assignTradeRoute"-message.

Parameters:

server - The FreeColServer handling the message.

connection - The Connection message was received on.

Returns:

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

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"assignTradeRoute".