Package net.sf.freecol.common.networking

Class SetAvailableMessage

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

public class SetAvailableMessage
extends AttributeMessage

The message that changes the player availability.

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	NATION_TAG
private static java.lang.String	STATE_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
SetAvailableMessage(Game game, FreeColXMLReader xr)	Create a new SetAvailableMessage from a stream.
SetAvailableMessage(Nation nation, NationOptions.NationState state)	Create a new SetAvailableMessage.

Method Summary

Modifier and Type	Method	Description
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
Nation	getNation(Specification spec)	Get the nation whose availability is changing.
NationOptions.NationState	getNationState()	Get the new nation availabiility.
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, currentPlayerMessage, 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

NATION_TAG

private static final java.lang.String NATION_TAG

See Also:

Constant Field Values

STATE_TAG

private static final java.lang.String STATE_TAG

See Also:

Constant Field Values

Constructor Detail

SetAvailableMessage

public SetAvailableMessage(Nation nation,
                           NationOptions.NationState state)

Create a new SetAvailableMessage.

Parameters:

nation - The Nation to make available.

state - The NationState for that nation.

SetAvailableMessage

public SetAvailableMessage(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 - if the stream is corrupt.

Method Detail

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

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.

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.

getNation

public Nation getNation(Specification spec)

Get the nation whose availability is changing.

Parameters:

spec - The Specification to look up the nation in.

Returns:

The Nation found.

getNationState

public NationOptions.NationState getNationState()

Get the new nation availabiility.

Returns:

The new NationState.