Package net.sf.freecol.common.networking

Class SetBuildQueueMessage

java.lang.Object

net.sf.freecol.common.networking.Message

net.sf.freecol.common.networking.TrivialMessage

net.sf.freecol.common.networking.AttributeMessage

net.sf.freecol.common.networking.SetBuildQueueMessage

public class SetBuildQueueMessage
extends AttributeMessage

The message sent when setting the build queue.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.freecol.common.networking.Message

Message.MessagePriority

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	COLONY_TAG
static java.lang.String	TAG

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

attributes

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

continueMessage, disconnectMessage, endTurnMessage, enterRevengeModeMessage, reconnectMessage, requestLaunchMessage, retireMessage, startGameMessage

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

logger, messagePriorityComparator

Constructor Summary

Constructors

Constructor	Description
SetBuildQueueMessage(Colony colony, java.util.List<BuildableType> queue)	Create a new SetBuildQueueMessage for the supplied colony and queue.
SetBuildQueueMessage(Game game, FreeColXMLReader xr)	Create a new SetAvailableMessage from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	currentPlayerMessage()	Should this message only be sent to a server by the current player?
private static java.util.Map<java.lang.String,java.lang.String>	getAttributeMap(FreeColXMLReader xr)	Get a map of attributes from the reader.
private Colony	getColony(Player player)	Get the colony that is building.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
private java.util.List<BuildableType>	getQueue(Specification spec)	Get the list of buildables defined by the array attributes.
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this message.

Methods inherited from class net.sf.freecol.common.networking.AttributeMessage

canMerge, getStringAttribute, getStringAttributeMap, hasAttribute, setMergeable, setStringAttribute

Methods inherited from class net.sf.freecol.common.networking.TrivialMessage

aiHandler, appendChild, appendChildren, clientHandler, getChildCount, getChildren, getType, setChildren, setType

Methods inherited from class net.sf.freecol.common.networking.Message

clientGeneric, expected, getArrayAttributes, getBooleanAttribute, getChild, getChildren, getEnumAttribute, getIntegerAttribute, getPriorityLevel, igc, igc, invokeAndWait, invokeLater, isEmpty, isType, merge, pgc, pgc, pretty, read, setArrayAttributes, setArrayAttributes, setBooleanAttribute, setEnumAttribute, setIntegerAttribute, setStringAttributeMap, setStringAttributes, setStringAttributes, toString, toXML, writeAttributes, writeChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

COLONY_TAG

private static final java.lang.String COLONY_TAG

See Also:

Constant Field Values

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,
                            FreeColXMLReader xr)
                     throws javax.xml.stream.XMLStreamException

Create a new SetAvailableMessage from a stream.

Parameters:

game - The Game this message belongs to (null here).

xr - The FreeColXMLReader to read from.

Throws:

javax.xml.stream.XMLStreamException - is the stream is corrupt.

Method Detail

getAttributeMap

private static java.util.Map<java.lang.String,java.lang.String> getAttributeMap(FreeColXMLReader xr)

Get a map of attributes from the reader.

Parameters:

xr - The FreeColXMLReader to query.

Returns:

A map of attributes.

getColony

private Colony getColony(Player player)

Get the colony that is building.

Parameters:

player - The Player that owns the colony.

Returns:

The colony.

getQueue

private java.util.List<BuildableType> getQueue(Specification spec)

Get the list of buildables defined by the array attributes.

Parameters:

spec - A Specification to use to make the buildable.

Returns:

A list of BuildableTypes.

currentPlayerMessage

public boolean currentPlayerMessage()

Should this message only be sent to a server by the current player?

Overrides:

currentPlayerMessage in class TrivialMessage

Returns:

True if this is a current-player-only message.

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

serverHandler

public ChangeSet serverHandler(FreeColServer freeColServer,
                               ServerPlayer serverPlayer)

Server-side handler for this message.

Overrides:

serverHandler in class TrivialMessage

Parameters:

freeColServer - The FreeColServer handling the request.

serverPlayer - The ServerPlayer that sent the request.

Returns:

A ChangeSet defining the response.