Package net.sf.freecol.common.networking

Class AddPlayerMessage

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

public class AddPlayerMessage
extends ObjectMessage

The message sent to add or update players to 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 Player	destination	The player to specialize the players for.
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
AddPlayerMessage(Game game, FreeColXMLReader xr)	Create a new AddPlayerMessage from a stream.
AddPlayerMessage(Player destination, java.util.List<Player> players)	Create a new AddPlayerMessage.

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.
private java.util.List<Player>	getPlayers()	Get the attached players.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
void	toXML(FreeColXMLWriter xw)	Write this message as XML.

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

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

destination

private final Player destination

The player to specialize the players for.

Constructor Detail

AddPlayerMessage

public AddPlayerMessage(Player destination,
                        java.util.List<Player> players)

Create a new AddPlayerMessage.

Parameters:

destination - An optional Player that will see this message.

players - A list of Players to add.

AddPlayerMessage

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

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

getPlayers

private java.util.List<Player> getPlayers()

Get the attached players.

Returns:

The list of Players to add.

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

toXML

public void toXML(FreeColXMLWriter xw)
           throws javax.xml.stream.XMLStreamException

Write this message as XML.

Overrides:

toXML in class Message

Parameters:

xw - The FreeColXMLWriter to write with.

Throws:

javax.xml.stream.XMLStreamException - if there is a problem writing the stream.

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.