net.sf.freecol.common.networking
Class TrainUnitInEuropeMessage

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

public class TrainUnitInEuropeMessage
extends DOMMessage

The message sent when training a unit in Europe.

Field Summary

private java.lang.String

typeId The id of the unit type.

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

document, logger

Constructor Summary

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

TrainUnitInEuropeMessage(UnitType type)
Create a new TrainUnitInEuropeMessage with the supplied type.

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

typeId

private java.lang.String typeId

The id of the unit type.

Constructor Detail

TrainUnitInEuropeMessage

public TrainUnitInEuropeMessage(UnitType type)

Create a new TrainUnitInEuropeMessage with the supplied type.

Parameters:

type - The UnitType to train.

TrainUnitInEuropeMessage

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

Create a new TrainUnitInEuropeMessage 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 "trainUnitInEurope"-message.

Parameters:

server - The FreeColServer handling the message.

player - The Player the message applies to.

connection - The Connection message was received on.

Returns:

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

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"trainUnitInEurope".