Package net.sf.freecol.common.networking

Class SetNationMessage

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

public class SetNationMessage
extends AttributeMessage

The message that sets the player nation.

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	PLAYER_TAG
static java.lang.String	TAG
private static java.lang.String	VALUE_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
SetNationMessage(Game game, FreeColXMLReader xr)	Create a new SetNationMessage from a stream.
SetNationMessage(Player player, Nation nation)	Create a new SetNationMessage.

Method Summary

Modifier and Type	Method	Description
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
Player	getPlayer(Game game)	Get the player that is setting its nation.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
Nation	getValue(Specification spec)	Get the nation to set.
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

PLAYER_TAG

private static final java.lang.String PLAYER_TAG

See Also:

Constant Field Values

VALUE_TAG

private static final java.lang.String VALUE_TAG

See Also:

Constant Field Values

Constructor Detail

SetNationMessage

public SetNationMessage(Player player,
                        Nation nation)

Create a new SetNationMessage.

Parameters:

player - The Player to set the nation for.

nation - The Nation to set.

SetNationMessage

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

Create a new SetNationMessage 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.

getPlayer

public Player getPlayer(Game game)

Get the player that is setting its nation.

Parameters:

game - The Game to look up the player in.

Returns:

The Player found, or null.

getValue

public Nation getValue(Specification spec)

Get the nation to set.

Parameters:

spec - The Specification to look up the nation in.

Returns:

The Nation.