Package net.sf.freecol.common.networking

Class SpySettlementMessage

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

public class SpySettlementMessage
extends ObjectMessage

The message sent when spying on a 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	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
SpySettlementMessage(Game game, FreeColXMLReader xr)	Create a new SpySettlementMessage from a stream.
SpySettlementMessage(Unit unit, Settlement settlement)	Create a new SpySettlementMessage request with the supplied unit and settlement

Method Summary

Modifier and Type	Method	Description
void	clientHandler(FreeColClient freeColClient)	Client-side handler for this message.
private Colony	getColony(Game game)
Message.MessagePriority	getPriority()	Get the priority of this type of message.
private Tile	getSpyTile()
private Unit	getUnit(Player player)
ChangeSet	serverHandler(FreeColServer freeColServer, ServerPlayer serverPlayer)	Server-side handler for this message.
void	writeChildren(FreeColXMLWriter xw)	Write any children of 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

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

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

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

SpySettlementMessage

public SpySettlementMessage(Unit unit,
                            Settlement settlement)

Create a new SpySettlementMessage request with the supplied unit and settlement

Parameters:

unit - The Unit that is spying.

settlement - The Settlement the unit is looking at.

SpySettlementMessage

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

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

getSpyTile

private Tile getSpyTile()

getUnit

private Unit getUnit(Player player)

getColony

private Colony getColony(Game game)

getPriority

public Message.MessagePriority getPriority()

Get the priority of this type of message.

Overrides:

getPriority in class AttributeMessage

Returns:

The message priority.

writeChildren

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

Write any children of this message.

Overrides:

writeChildren in class Message

Parameters:

xw - The FreeColXMLWriter to write to.

Throws:

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

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.