Package net.sf.freecol.common.networking

Class NewTurnMessage

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

public class NewTurnMessage
extends AttributeMessage

The message sent to the clients to signal a new turn.

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	TURN_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
NewTurnMessage(Game game, FreeColXMLReader xr)	Create a new NewTurnMessage from a stream.
NewTurnMessage(Turn turn)	Create a new NewTurnMessage with the supplied message.

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.
int	getTurnNumber()	Get the turn number.

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

TURN_TAG

private static final java.lang.String TURN_TAG

See Also:

Constant Field Values

Constructor Detail

NewTurnMessage

public NewTurnMessage(Turn turn)

Create a new NewTurnMessage with the supplied message.

Parameters:

turn - The new Turn.

NewTurnMessage

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

Create a new NewTurnMessage from a stream.

Parameters:

game - The Game to read within.

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.

getTurnNumber

public int getTurnNumber()

Get the turn number.

Returns:

The turn number.