Package net.sf.freecol.common.networking

Class SetStanceMessage

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

public class SetStanceMessage
extends AttributeMessage

The message sent to the clients to signal a stance change.

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	FIRST_TAG
private static java.lang.String	SECOND_TAG
private static java.lang.String	STANCE_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
SetStanceMessage(Game game, FreeColXMLReader xr)	Create a new SetStanceMessage from a stream.
SetStanceMessage(Stance stance, Player first, Player second)	Create a new SetStanceMessage with the given stance and players.

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.
Player	getFirstPlayer(Game game)	Which player is changing stance?
Message.MessagePriority	getPriority()	Get the priority of this type of message.
Player	getSecondPlayer(Game game)	Which player is the stance changed with respect to?
Stance	getStance()	Get the stance that changed.

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

FIRST_TAG

private static final java.lang.String FIRST_TAG

See Also:

Constant Field Values

SECOND_TAG

private static final java.lang.String SECOND_TAG

See Also:

Constant Field Values

STANCE_TAG

private static final java.lang.String STANCE_TAG

See Also:

Constant Field Values

Constructor Detail

SetStanceMessage

public SetStanceMessage(Stance stance,
                        Player first,
                        Player second)

Create a new SetStanceMessage with the given stance and players.

Parameters:

stance - The new Stance.

first - The Player whose stance is changing.

second - The Player the stance is changed with respect to.

SetStanceMessage

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

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

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.

getStance

public Stance getStance()

Get the stance that changed.

Returns:

The Stance value.

getFirstPlayer

public Player getFirstPlayer(Game game)

Which player is changing stance?

Parameters:

game - The Game the player is in.

Returns:

The player whose stance changes.

getSecondPlayer

public Player getSecondPlayer(Game game)

Which player is the stance changed with respect to?

Parameters:

game - The Game the player is in.

Returns:

The player the stance changed to.