Package net.sf.freecol.common.networking

Class SetAIMessage

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

public class SetAIMessage
extends AttributeMessage

The message that changes the AI state of a player.

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	AI_TAG
private static java.lang.String	PLAYER_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
SetAIMessage(Game game, FreeColXMLReader xr)	Create a new SetAIMessage from a stream.
SetAIMessage(Player player, boolean ai)	Create a new SetAIMessage with the given player and state.

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.
boolean	getAI()	What AI state should be set?
Player	getPlayer(Game game)	Which player is to be set?
Message.MessagePriority	getPriority()	Get the priority of this type of 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

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

AI_TAG

private static final java.lang.String AI_TAG

See Also:

Constant Field Values

PLAYER_TAG

private static final java.lang.String PLAYER_TAG

See Also:

Constant Field Values

Constructor Detail

SetAIMessage

public SetAIMessage(Player player,
                    boolean ai)

Create a new SetAIMessage with the given player and state.

Parameters:

player - The Player to set.

ai - The new AI state.

SetAIMessage

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

Create a new SetAIMessage from a stream.

Parameters:

game - The Game this message belongs to.

xr - A 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.

getPlayer

public Player getPlayer(Game game)

Which player is to be set?

Parameters:

game - The Game the player is in.

Returns:

The Player to set the AI state of.

getAI

public boolean getAI()

What AI state should be set?

Returns:

The AI state.