Package net.sf.freecol.common.networking

Class RemoveMessage

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

public class RemoveMessage
extends AttributeMessage

The message sent when removing a FreeColGameObject.

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	DIVERT_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
RemoveMessage(java.lang.String divertId, java.util.List<? extends FreeColGameObject> objects)	Create a new RemoveMessage.
RemoveMessage(Game game, FreeColXMLReader xr)	Create a new RemoveMessage from a stream.

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.
private static java.util.Map<java.lang.String,java.lang.String>	getAttributeMap(FreeColXMLReader xr)	Get the attributes as a map.
FreeColGameObject	getDivertObject(Game game)	Get the divert object.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
java.util.List<FreeColGameObject>	getRemovals(Game game)	Get the objects to remove.

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

appendChild, appendChildren, currentPlayerMessage, getChildCount, getChildren, getType, serverHandler, 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

DIVERT_TAG

private static final java.lang.String DIVERT_TAG

See Also:

Constant Field Values

Constructor Detail

RemoveMessage

public RemoveMessage(java.lang.String divertId,
                     java.util.List<? extends FreeColGameObject> objects)

Create a new RemoveMessage.

Parameters:

divertId - The identifier of an object to divert message attribution to.

objects - A list of FreeColGameObjects to remove.

RemoveMessage

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

Create a new RemoveMessage from a stream.

Parameters:

game - The Game this message belongs to.

xr - A FreeColXMLReader to read from.

Throws:

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

Method Detail

getAttributeMap

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

Get the attributes as a map.

Parameters:

xr - A FreeColXMLReader to read from.

Returns:

A map of the attributes.

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

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.

getDivertObject

public FreeColGameObject getDivertObject(Game game)

Get the divert object.

Parameters:

game - The Game to look in.

Returns:

The divert object, or null if none found.

getRemovals

public java.util.List<FreeColGameObject> getRemovals(Game game)

Get the objects to remove.

Parameters:

game - The Game to look in.

Returns:

A list of FreeColGameObjects to remove.