Package net.sf.freecol.common.networking

Class NativeTradeMessage

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

public class NativeTradeMessage
extends ObjectMessage

The message sent to handle native trade sessions.

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	ACTION_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
NativeTradeMessage(Game game, FreeColXMLReader xr)	Create a new NativeTradeMessage from a stream.
NativeTradeMessage(NativeTrade.NativeTradeAction action, NativeTrade nt)	Create a new NativetradeMessage with the supplied unit and native settlement.
NativeTradeMessage(Unit unit, IndianSettlement is)	Create a new NativeTradeMessage request with the supplied unit and settlement.

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 NativeTrade.NativeTradeAction	getAction()
private NativeTrade	getNativeTrade()
Message.MessagePriority	getPriority()	Get the priority of this type of message.
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this message.

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

ACTION_TAG

private static final java.lang.String ACTION_TAG

See Also:

Constant Field Values

Constructor Detail

NativeTradeMessage

public NativeTradeMessage(Unit unit,
                          IndianSettlement is)

Create a new NativeTradeMessage request with the supplied unit and settlement.

Parameters:

unit - The Unit performing the trade.

is - The IndianSettlement where the trade occurs.

NativeTradeMessage

public NativeTradeMessage(NativeTrade.NativeTradeAction action,
                          NativeTrade nt)

Create a new NativetradeMessage with the supplied unit and native settlement.

Parameters:

action - The NativeTradeAction

nt - The NativeTrade

NativeTradeMessage

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

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

getAction

private NativeTrade.NativeTradeAction getAction()

getNativeTrade

private NativeTrade getNativeTrade()

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.