Package net.sf.freecol.common.networking

Class UpdateMessage

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.ObjectMessage

net.sf.freecol.common.networking.UpdateMessage

public class UpdateMessage
extends ObjectMessage

The message sent to update game objects.

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 Player	destination	The player to specialize the objects for.
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

Modifier	Constructor	Description
	UpdateMessage(Game game, FreeColXMLReader xr)	Create a new UpdateMessage from a stream.
private	UpdateMessage(Player destination)	Create a new UpdateMessage.
	UpdateMessage(Player destination, java.util.List<FreeColGameObject> fcgos)	Create a new UpdateMessage.
	UpdateMessage(Player destination, FreeColGameObject fcgo)	Create a new UpdateMessage.

Method Summary

Modifier and Type	Method	Description
void	aiHandler(FreeColServer freeColServer, AIPlayer aiPlayer)	AI-side handler for this message.
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
boolean	merge(Message message)	Merge another message into this message if possible.
void	toXML(FreeColXMLWriter xw)	Write this message as XML.

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

appendChild, appendChildren, getChildCount, getChildren, setChildren

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

currentPlayerMessage, getType, serverHandler, 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, pgc, pgc, pretty, read, setArrayAttributes, setArrayAttributes, setBooleanAttribute, setEnumAttribute, setIntegerAttribute, setStringAttributeMap, setStringAttributes, setStringAttributes, toString, 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

destination

private final Player destination

The player to specialize the objects for.

Constructor Detail

UpdateMessage

private UpdateMessage(Player destination)

Create a new UpdateMessage.

Parameters:

destination - The destination Player.

UpdateMessage

public UpdateMessage(Player destination,
                     FreeColGameObject fcgo)

Create a new UpdateMessage.

Parameters:

destination - The destination Player.

fcgo - A FreeColGameObjects to add.

UpdateMessage

public UpdateMessage(Player destination,
                     java.util.List<FreeColGameObject> fcgos)

Create a new UpdateMessage.

Parameters:

destination - The destination Player.

fcgos - A list of FreeColObjects to add.

UpdateMessage

public UpdateMessage(Game game,
                     FreeColXMLReader xr)
              throws javax.xml.stream.XMLStreamException

Create a new UpdateMessage from a stream.

Parameters:

game - The Game this message belongs to.

xr - The FreeColXMLReader to read from.

Throws:

javax.xml.stream.XMLStreamException - if there is a problem reading the stream.

Method Detail

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

merge

public boolean merge(Message message)

Merge another message into this message if possible.

Overrides:

merge in class Message

Parameters:

message - The Message to merge.

Returns:

True if the other message was merged.

toXML

public void toXML(FreeColXMLWriter xw)
           throws javax.xml.stream.XMLStreamException

Write this message as XML.

Overrides:

toXML in class Message

Parameters:

xw - The FreeColXMLWriter to write with.

Throws:

javax.xml.stream.XMLStreamException - if there is a problem writing the stream.

aiHandler

public void aiHandler(FreeColServer freeColServer,
                      AIPlayer aiPlayer)

AI-side handler for this message. AI handlers always return null. FIXME: One day the FreeColServer should devolve to AIMain.

Overrides:

aiHandler in class TrivialMessage

Parameters:

freeColServer - The FreeColServer handling the request.

aiPlayer - The AIPlayer the message was sent to.

clientHandler

public void clientHandler(FreeColClient freeColClient)

Client-side handler for this message. Client handlers always return null.

Overrides:

clientHandler in class TrivialMessage

Parameters:

freeColClient - The FreeColClient to handle this message.