Package net.sf.freecol.common.networking

Class InciteMessage

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

public class InciteMessage
extends AttributeMessage

The message sent when inciting a native settlement.

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	ENEMY_TAG
private static java.lang.String	GOLD_TAG
private static java.lang.String	SETTLEMENT_TAG
static java.lang.String	TAG
private static java.lang.String	UNIT_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
InciteMessage(Game game, FreeColXMLReader xr)	Create a new InciteMessage from a stream.
InciteMessage(Unit unit, IndianSettlement is, Player enemy, int gold)	Create a new InciteMessage with the supplied name.

Method Summary

Modifier and Type	Method	Description
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
boolean	currentPlayerMessage()	Should this message only be sent to a server by the current player?
Player	getEnemy(Game game)
int	getGold()
Message.MessagePriority	getPriority()	Get the priority of this type of message.
IndianSettlement	getSettlement(Unit unit)
Unit	getUnit(Player player)
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this 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

aiHandler, appendChild, appendChildren, 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

ENEMY_TAG

private static final java.lang.String ENEMY_TAG

See Also:

Constant Field Values

GOLD_TAG

private static final java.lang.String GOLD_TAG

See Also:

Constant Field Values

SETTLEMENT_TAG

private static final java.lang.String SETTLEMENT_TAG

See Also:

Constant Field Values

UNIT_TAG

private static final java.lang.String UNIT_TAG

See Also:

Constant Field Values

Constructor Detail

InciteMessage

public InciteMessage(Unit unit,
                     IndianSettlement is,
                     Player enemy,
                     int gold)

Create a new InciteMessage with the supplied name.

Parameters:

unit - The inciting Unit.

is - The IndianSettlement to incite.

enemy - The enemy Player.

gold - The amount of gold in the bribe (negative for the initial inquiry).

InciteMessage

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

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

currentPlayerMessage

public boolean currentPlayerMessage()

Should this message only be sent to a server by the current player?

Overrides:

currentPlayerMessage in class TrivialMessage

Returns:

True if this is a current-player-only message.

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

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.

getUnit

public Unit getUnit(Player player)

getSettlement

public IndianSettlement getSettlement(Unit unit)

getEnemy

public Player getEnemy(Game game)

getGold

public int getGold()