Package net.sf.freecol.common.networking

Class IndianDemandMessage

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

public class IndianDemandMessage
extends AttributeMessage

The message sent to resolve natives making demands of a colony.

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	AMOUNT_TAG
private static java.lang.String	COLONY_TAG
private static java.lang.String	RESULT_TAG
static java.lang.String	TAG
private static java.lang.String	TYPE_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
IndianDemandMessage(Game game, FreeColXMLReader xr)	Create a new IndianDemandMessage from a stream.
IndianDemandMessage(Unit unit, Colony colony, GoodsType type, int amount)	Create a new IndianDemandMessage with the supplied unit, colony and demands.

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.
int	getAmount()	Client-side convenience function to get the gold in this message.
Colony	getColony(Game game)	Client-side convenience function to get the colony in this message.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
Constants.IndianDemandAction	getResult()	Client-side convenience function to set the result of this message.
GoodsType	getType(Game game)	Client-side convenience function to get the goods type in this message.
Unit	getUnit(Game game)	Client-side convenience function to get the unit in this message.
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this message.
IndianDemandMessage	setResult(Constants.IndianDemandAction result)	Client-side convenience function to set the result of 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

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

AMOUNT_TAG

private static final java.lang.String AMOUNT_TAG

See Also:

Constant Field Values

COLONY_TAG

private static final java.lang.String COLONY_TAG

See Also:

Constant Field Values

RESULT_TAG

private static final java.lang.String RESULT_TAG

See Also:

Constant Field Values

TYPE_TAG

private static final java.lang.String TYPE_TAG

See Also:

Constant Field Values

UNIT_TAG

private static final java.lang.String UNIT_TAG

See Also:

Constant Field Values

Constructor Detail

IndianDemandMessage

public IndianDemandMessage(Unit unit,
                           Colony colony,
                           GoodsType type,
                           int amount)

Create a new IndianDemandMessage with the supplied unit, colony and demands.

Parameters:

unit - The Unit that is demanding.

colony - The Colony being demanded of.

type - The GoodsType being demanded.

amount - The amount of goods being demanded.

IndianDemandMessage

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

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

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.

getUnit

public Unit getUnit(Game game)

Client-side convenience function to get the unit in this message.

Parameters:

game - The Game to look for the unit in.

Returns:

The Unit found.

getColony

public Colony getColony(Game game)

Client-side convenience function to get the colony in this message.

Parameters:

game - The Game to look for the colony in.

Returns:

The Colony found.

getType

public GoodsType getType(Game game)

Client-side convenience function to get the goods type in this message.

Parameters:

game - The Game to look for the goods type in.

Returns:

The GoodsType found.

getAmount

public int getAmount()

Client-side convenience function to get the gold in this message.

Returns:

The amount of gold specified by this message, or -1 if none or invalid.

getResult

public Constants.IndianDemandAction getResult()

Client-side convenience function to set the result of this message.

Returns:

The result of this demand.

setResult

public IndianDemandMessage setResult(Constants.IndianDemandAction result)

Client-side convenience function to set the result of this message.

Parameters:

result - The new result of this demand.

Returns:

This message.