Package net.sf.freecol.common.networking

Class HighScoresMessage

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

public class HighScoresMessage
extends ObjectMessage

The message sent when an high score query/response occurs.

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	KEY_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
HighScoresMessage(java.lang.String key, java.util.List<HighScore> scores)	Create a new HighScoresMessage in request form (no scores attached).
HighScoresMessage(Game game, FreeColXMLReader xr)	Create a new HighScoresMessage from a stream.

Method Summary

Modifier and Type	Method	Description
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
private java.lang.String	getKey()	Accessor for the key.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
private java.util.List<HighScore>	getScores()	Accessor for the scores list.
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this message.

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

aiHandler, currentPlayerMessage, getType, 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

KEY_TAG

private static final java.lang.String KEY_TAG

See Also:

Constant Field Values

Constructor Detail

HighScoresMessage

public HighScoresMessage(java.lang.String key,
                         java.util.List<HighScore> scores)

Create a new HighScoresMessage in request form (no scores attached).

Parameters:

key - A message key for the final display.

scores - The list of high scores, or null.

HighScoresMessage

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

Create a new HighScoresMessage 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

getKey

private java.lang.String getKey()

Accessor for the key.

Returns:

The key.

getScores

private java.util.List<HighScore> getScores()

Accessor for the scores list.

Returns:

The list of HighScores.

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.