Package net.sf.freecol.common.networking

Class GameEndedMessage

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

public class GameEndedMessage
extends AttributeMessage

The message to signal the end of the game.

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	HIGH_SCORE_TAG
static java.lang.String	TAG
private static java.lang.String	WINNER_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
GameEndedMessage(Game game, FreeColXMLReader xr)	Create a new GameEndedMessage from a stream.
GameEndedMessage(Player winner, boolean highScore)	Create a new GameEndedMessage with the supplied winner.

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.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
java.lang.String	getScore()	Get the high score attribute.
Player	getWinner(Game game)	Who won?

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

HIGH_SCORE_TAG

private static final java.lang.String HIGH_SCORE_TAG

See Also:

Constant Field Values

WINNER_TAG

private static final java.lang.String WINNER_TAG

See Also:

Constant Field Values

Constructor Detail

GameEndedMessage

public GameEndedMessage(Player winner,
                        boolean highScore)

Create a new GameEndedMessage with the supplied winner.

Parameters:

winner - The Player that has won.

highScore - True if a new high score was reached.

GameEndedMessage

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

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

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.

getWinner

public Player getWinner(Game game)

Who won?

Parameters:

game - The Game the winner is in.

Returns:

The Player that won.

getScore

public java.lang.String getScore()

Get the high score attribute. Note: *not* a boolean, due to a kludge in client.IGIH.

Returns:

The score attribute.