Package net.sf.freecol.common.networking

Class FirstContactMessage

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

public class FirstContactMessage
extends AttributeMessage

The message sent when making first contact between players.

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	CAMPS_TAG
private static java.lang.String	OTHER_TAG
private static java.lang.String	PLAYER_TAG
private static java.lang.String	RESULT_TAG
static java.lang.String	TAG
private static java.lang.String	TILE_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
FirstContactMessage(Game game, FreeColXMLReader xr)	Create a new FirstContactMessage from a stream.
FirstContactMessage(Player player, Player other, Tile tile)	Create a new FirstContactMessage.

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	getOtherPlayer(Game game)
Player	getPlayer(Game game)
Message.MessagePriority	getPriority()	Get the priority of this type of message.
boolean	getResult()
int	getSettlementCount()
Tile	getTile(Game game)
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this message.
FirstContactMessage	setResult(boolean result)

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, 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

CAMPS_TAG

private static final java.lang.String CAMPS_TAG

See Also:

Constant Field Values

OTHER_TAG

private static final java.lang.String OTHER_TAG

See Also:

Constant Field Values

PLAYER_TAG

private static final java.lang.String PLAYER_TAG

See Also:

Constant Field Values

RESULT_TAG

private static final java.lang.String RESULT_TAG

See Also:

Constant Field Values

TILE_TAG

private static final java.lang.String TILE_TAG

See Also:

Constant Field Values

Constructor Detail

FirstContactMessage

public FirstContactMessage(Player player,
                           Player other,
                           Tile tile)

Create a new FirstContactMessage.

Parameters:

player - The Player making contact.

other - The Player being contacted.

tile - An optional Tile to offer.

FirstContactMessage

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

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

serverHandler

public ChangeSet serverHandler(FreeColServer freeColServer,
                               ServerPlayer serverPlayer)

Server-side handler for this message.

Overrides:

serverHandler in class TrivialMessage

Parameters:

freeColServer - The FreeColServer handling the request.

serverPlayer - The ServerPlayer that sent the request.

Returns:

A ChangeSet defining the response.

getPlayer

public Player getPlayer(Game game)

getOtherPlayer

public Player getOtherPlayer(Game game)

getTile

public Tile getTile(Game game)

getSettlementCount

public int getSettlementCount()

getResult

public boolean getResult()

setResult

public FirstContactMessage setResult(boolean result)