Package net.sf.freecol.common.networking

Class NewRegionNameMessage

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

public class NewRegionNameMessage
extends AttributeMessage

The message sent when naming a new region.

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	NEW_REGION_NAME_TAG
private static java.lang.String	REGION_TAG
static java.lang.String	TAG
private static java.lang.String	TILE_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
NewRegionNameMessage(Game game, FreeColXMLReader xr)	Create a new NewRegionNameMessage from a stream.
NewRegionNameMessage(Region region, Tile tile, Unit unit, java.lang.String newRegionName)	Create a new NewRegionNameMessage with the supplied name.

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.
java.lang.String	getNewRegionName()	Public accessor for the new region name.
Message.MessagePriority	getPriority()	Get the priority of this type of message.
Region	getRegion(Game game)	Public accessor for the region.
Tile	getTile(Game game)	Public accessor for the tile.
Unit	getUnit(Player player)	Public accessor for the unit.
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

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

NEW_REGION_NAME_TAG

private static final java.lang.String NEW_REGION_NAME_TAG

See Also:

Constant Field Values

REGION_TAG

private static final java.lang.String REGION_TAG

See Also:

Constant Field Values

TILE_TAG

private static final java.lang.String TILE_TAG

See Also:

Constant Field Values

UNIT_TAG

private static final java.lang.String UNIT_TAG

See Also:

Constant Field Values

Constructor Detail

NewRegionNameMessage

public NewRegionNameMessage(Region region,
                            Tile tile,
                            Unit unit,
                            java.lang.String newRegionName)

Create a new NewRegionNameMessage with the supplied name.

Parameters:

region - The Region being discovered.

tile - The Tile where the region is discovered.

unit - The Unit that discovers the region.

newRegionName - The default new region name.

NewRegionNameMessage

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

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

getRegion

public Region getRegion(Game game)

Public accessor for the region.

Parameters:

game - The Game to look for a region in.

Returns:

The region of this message.

getTile

public Tile getTile(Game game)

Public accessor for the tile.

Parameters:

game - The Game to look for a tile in.

Returns:

The tile of this message.

getUnit

public Unit getUnit(Player player)

Public accessor for the unit.

Parameters:

player - The Player who owns the unit.

Returns:

The Unit of this message.

getNewRegionName

public java.lang.String getNewRegionName()

Public accessor for the new region name.

Returns:

The new region name of this message.