net.sf.freecol.common.model

Class PlayerExploredTile

java.lang.Object

net.sf.freecol.common.model.FreeColObject

net.sf.freecol.common.model.FreeColGameObject

net.sf.freecol.common.model.PlayerExploredTile

All Implemented Interfaces:

java.lang.Comparable<FreeColObject>, ObjectWithId

public class PlayerExploredTile
extends FreeColGameObject

This class contains the mutable tile data visible to a specific player. Sometimes a tile contains information that should not be given to a player. For instance; a settlement that was built after the player last viewed the tile. The toXMLElement of Tile uses information from this class to hide information that is not available.

Field Summary

Fields

Modifier and Type	Field and Description
private Tension	alarm
private static java.lang.String	ALARM_TAG
private static java.lang.String	COLONY_UNIT_COUNT_TAG
private int	colonyUnitCount
private static java.lang.String	LEARNABLE_SKILL_TAG
private static java.util.logging.Logger	logger
private Unit	missionary
private static java.lang.String	MISSIONARY_TAG
private static java.lang.String	MOST_HATED_TAG
private Player	mostHated
private static java.lang.String	OLD_TILE_IMPROVEMENT_TAG
private Player	owner The owner of the tile.
private static java.lang.String	OWNER_TAG
private static java.lang.String	OWNING_SETTLEMENT_TAG
private Settlement	owningSettlement The owning settlement of the tile, if any.
private Player	player The owner of this view.
private static java.lang.String	PLAYER_TAG
private Tile	tile The tile viewed.
private static java.lang.String	TILE_TAG
private java.util.List<TileItem>	tileItems All known TileItems.
private static java.lang.String	WANTED_GOODS_TAG

Fields inherited from class net.sf.freecol.common.model.FreeColObject

ARRAY_SIZE_TAG, ID_ATTRIBUTE, ID_ATTRIBUTE_TAG, INFINITY, UNDEFINED, VALUE_TAG

Constructor Summary

Constructors

Constructor and Description
PlayerExploredTile(Game game, Player player, Tile tile) Creates a new PlayerExploredTile.
PlayerExploredTile(Game game, java.lang.String id) Create a new player explored tile.

Method Summary

Modifier and Type	Method and Description
private void	addTileItem(TileItem item) Add a tile item to this pet.
void	fixCache() Use this PET so set an approximation to the correct cached tile.
private java.util.List<TileItem>	getTileItems() Get the tile items in this pet.
static java.lang.String	getXMLElementTagName() Gets the tag name of the root element representing this object.
java.lang.String	getXMLTagName() Gets the tag name used to serialize this object, generally the class name starting with a lower case letter.
protected void	readAttributes(FreeColXMLReader xr) Reads the attributes of this object from an XML stream.
protected void	readChild(FreeColXMLReader xr) Reads a single child object.
protected void	readChildren(FreeColXMLReader xr) Reads the children of this object from an XML stream.
void	writeAttributes(FreeColXMLWriter xw) Write the attributes of this object to a stream.
void	writeChildren(FreeColXMLWriter xw) Write the children of this object to a stream.

Methods inherited from class net.sf.freecol.common.model.FreeColGameObject

checkIntegrity, cloneFreeColGameObject, dispose, disposeResources, equals, fundamentalDispose, getDisposeList, getGame, getLinkTarget, getSpecification, hashCode, internId, isDisposed, isUninitialized, readFromXML, setGame

Methods inherited from class net.sf.freecol.common.model.FreeColObject

addAbility, addFeatures, addModifier, addPropertyChangeListener, addPropertyChangeListener, applyModifiers, applyModifiers, applyModifiers, compareIds, compareTo, containsAbilityKey, containsModifierKey, copy, dumpCollection, dumpObject, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAbilities, getAbilities, getAbilities, getAbilities, getDefenceModifiers, getFeatureContainer, getId, getIdNumber, getIdType, getIdType, getModifiers, getModifiers, getModifiers, getModifiers, getPropertyChangeListeners, getPropertyChangeListeners, getSortedAbilities, getSortedCopy, getSortedModifiers, getSuffix, getSuffix, hasAbility, hasAbility, hasAbility, hasListeners, hasModifier, hasModifier, hasModifier, invokeMethod, logFreeColObjects, readFromXMLElement, readFromXMLPartial, readId, removeAbilities, removeAbility, removeFeatures, removeModifier, removeModifiers, removePropertyChangeListener, removePropertyChangeListener, save, save, save, save, serialize, serialize, setId, setSpecification, toString, toXML, toXML, toXMLElement, toXMLElement, toXMLElement, toXMLElementPartial, toXMLPartial

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static final java.util.logging.Logger logger

player

private Player player

The owner of this view.

tile

private Tile tile

The tile viewed.

owner

private Player owner

The owner of the tile.

owningSettlement

private Settlement owningSettlement

The owning settlement of the tile, if any.

tileItems

private java.util.List<TileItem> tileItems

All known TileItems.

colonyUnitCount

private int colonyUnitCount

missionary

private Unit missionary

alarm

private Tension alarm

mostHated

private Player mostHated

ALARM_TAG

private static final java.lang.String ALARM_TAG

See Also:

Constant Field Values

COLONY_UNIT_COUNT_TAG

private static final java.lang.String COLONY_UNIT_COUNT_TAG

See Also:

Constant Field Values

LEARNABLE_SKILL_TAG

private static final java.lang.String LEARNABLE_SKILL_TAG

See Also:

Constant Field Values

MISSIONARY_TAG

private static final java.lang.String MISSIONARY_TAG

See Also:

Constant Field Values

MOST_HATED_TAG

private static final java.lang.String MOST_HATED_TAG

See Also:

Constant Field Values

OWNER_TAG

private static final java.lang.String OWNER_TAG

See Also:

Constant Field Values

OWNING_SETTLEMENT_TAG

private static final java.lang.String OWNING_SETTLEMENT_TAG

See Also:

Constant Field Values

PLAYER_TAG

private static final java.lang.String PLAYER_TAG

See Also:

Constant Field Values

TILE_TAG

private static final java.lang.String TILE_TAG

See Also:

Constant Field Values

WANTED_GOODS_TAG

private static final java.lang.String WANTED_GOODS_TAG

See Also:

Constant Field Values

OLD_TILE_IMPROVEMENT_TAG

private static final java.lang.String OLD_TILE_IMPROVEMENT_TAG

See Also:

Constant Field Values

Constructor Detail

PlayerExploredTile

public PlayerExploredTile(Game game,
                          Player player,
                          Tile tile)

Creates a new PlayerExploredTile.

Parameters:

game - The enclosing Game.

player - The Player that owns this view.

tile - The Tile to view.

PlayerExploredTile

public PlayerExploredTile(Game game,
                          java.lang.String id)

Create a new player explored tile.

Parameters:

game - The enclosing Game.

id - The object identifier.

Method Detail

getTileItems

private java.util.List<TileItem> getTileItems()

Get the tile items in this pet.

Returns:

A list of TileItems.

addTileItem

private void addTileItem(TileItem item)

Add a tile item to this pet.

Parameters:

item - The TileItem to add.

fixCache

public void fixCache()

Use this PET so set an approximation to the correct cached tile. This is impossible in general, and will only happen once when converting an old saved game, but at least try to do something credible.

writeAttributes

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

Write the attributes of this object to a stream. To be overridden if required by any object that has attributes and uses the toXML(FreeColXMLWriter, String) call.

Overrides:

writeAttributes in class FreeColObject

Parameters:

xw - The FreeColXMLWriter to write to.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

writeChildren

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

Write the children of this object to a stream. To be overridden if required by any object that has children and uses the toXML(FreeColXMLWriter, String) call.

Overrides:

writeChildren in class FreeColObject

Parameters:

xw - The FreeColXMLWriter to write to.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

readAttributes

protected void readAttributes(FreeColXMLReader xr)
                       throws javax.xml.stream.XMLStreamException

Reads the attributes of this object from an XML stream.

Overrides:

readAttributes in class FreeColObject

Parameters:

xr - The FreeColXMLReader to read from.

Throws:

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

readChildren

protected void readChildren(FreeColXMLReader xr)
                     throws javax.xml.stream.XMLStreamException

Reads the children of this object from an XML stream.

Overrides:

readChildren in class FreeColObject

Parameters:

xr - The FreeColXMLReader to read from.

Throws:

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

readChild

protected void readChild(FreeColXMLReader xr)
                  throws javax.xml.stream.XMLStreamException

Reads a single child object. Subclasses must override to read their enclosed elements. This particular instance of the routine always throws XMLStreamException because we should never arrive here. However it is very useful to always call super.readChild() when an unexpected tag is encountered, as the exception thrown here provides some useful debugging context.

Overrides:

readChild in class FreeColObject

Parameters:

xr - The FreeColXMLReader to read from.

Throws:

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

getXMLTagName

public java.lang.String getXMLTagName()

Gets the tag name used to serialize this object, generally the class name starting with a lower case letter.

Specified by:

getXMLTagName in class FreeColObject

Returns:

The tag name for this object.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

Gets the tag name of the root element representing this object.

Returns:

"playerExploredTile".