net.sf.freecol.common.networking
Class SetBuildQueueMessage

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

public class SetBuildQueueMessage
extends DOMMessage

The message sent when setting the build queue.

Field Summary

private java.lang.String	colonyId The id of the colony containing the queue.
private java.lang.String[]	queue The items in the build queue.

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

document, logger

Constructor Summary

SetBuildQueueMessage(Colony colony, java.util.List<BuildableType> queue)
Create a new SetBuildQueueMessage for the supplied colony and queue.

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

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

colonyId

private java.lang.String colonyId

The id of the colony containing the queue.

queue

private java.lang.String[] queue

The items in the build queue.

Constructor Detail

SetBuildQueueMessage

public SetBuildQueueMessage(Colony colony,
                            java.util.List<BuildableType> queue)

Create a new SetBuildQueueMessage for the supplied colony and queue.

Parameters:

colony - The Colony where the queue is.

queue - A list of BuildableTypes to build.

SetBuildQueueMessage

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

Create a new SetBuildQueueMessage 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 "setBuildQueue"-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 new queue or an error Element on failure.

toXMLElement

public org.w3c.dom.Element toXMLElement()

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

"setBuildQueue".