Package net.sf.freecol.common.networking

Class DisembarkMessage

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

public class DisembarkMessage
extends AttributeMessage

The message sent when disembarking.

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
static java.lang.String	TAG
private static java.lang.String	UNIT_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
DisembarkMessage(Game game, FreeColXMLReader xr)	Create a new DisembarkMessage from a stream.
DisembarkMessage(Unit unit)	Create a new DisembarkMessage with the supplied name.

Method Summary

Modifier and Type	Method	Description
boolean	currentPlayerMessage()	Should this message only be sent to a server by the current player?
Message.MessagePriority	getPriority()	Get the priority of this type of message.
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

UNIT_TAG

private static final java.lang.String UNIT_TAG

See Also:

Constant Field Values

Constructor Detail

DisembarkMessage

public DisembarkMessage(Unit unit)

Create a new DisembarkMessage with the supplied name.

Parameters:

unit - The Unit that is disembarking.

DisembarkMessage

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

Create a new DisembarkMessage from a stream.

Parameters:

game - The Game this message belongs to.

xr - The FreeColXMLReader to read from.

Throws:

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

Method Detail

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.