net.sf.freecol.common.model
Class ColonyTile

java.lang.Object
  net.sf.freecol.common.model.FreeColGameObject
      net.sf.freecol.common.model.ColonyTile

All Implemented Interfaces:

Location, Ownable, WorkLocation

public class ColonyTile
extends FreeColGameObject
implements WorkLocation, Ownable

Represents a work location on a tile.

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	LICENSE
static java.lang.String	REVISION

Constructor Summary

ColonyTile(Game game, Colony colony, Tile workTile)
Creates a new ColonyTile.

ColonyTile(Game game, org.w3c.dom.Element e)
Initiates a new Building from an XML representation.

ColonyTile(Game game, java.lang.String id)
Initiates a new ColonyTile with the given ID.

ColonyTile(Game game, javax.xml.stream.XMLStreamReader in)
Initiates a new Building from an XML representation.

Method Summary

void	add(Locatable locatable) Add the specified Locatable to this WorkLocation.
boolean	canAdd(Locatable locatable) Checks if the specified Locatable may be added to this WorkLocation.
boolean	contains(Locatable locatable) Checks if this ColonyTile contains the given Locatable.
void	dispose() Removes all references to this object.
Colony	getColony() Gets a pointer to the colony containing this tile.
int	getExpertForProducing(int goodsType) Returns the unit type producing the greatest amount of the given goods at this tile.
Unit	getFirstUnit() Gets the Unit currently working on this ColonyTile.
int	getFoodProduction() Returns the production of food on this tile.
GoodsContainer	getGoodsContainer() Gets the GoodsContainer this Location use for storing it's goods.
java.lang.String	getLabel() Returns a description of the tile, with the name of the tile and any improvements made to it (road/plow)
Unit	getLastUnit() Gets the Unit currently working on this ColonyTile.
java.lang.String	getLocationName() Returns the (non-unique) name of this ColonyTile.
Player	getOwner() Gets the owner of this Ownable.
int	getProductionOf(int goodsType) Returns the production of the given type of goods.
Tile	getTile() Gets the tile where the colony is located.
Unit	getUnit() Gets the Unit currently working on this ColonyTile.
int	getUnitCount() Gets the amount of Units at this ColonyTile.
java.util.Iterator<Unit>	getUnitIterator() Gets a Iterator of every Unit directly located on this Location.
java.util.List<Unit>	getUnitList() Returns a list containing all the Units present at this Location.
Tile	getWorkTile() Gets the work tile.
int	getWorkType(Unit unit) Returns a worktype for a unit.
static java.lang.String	getXMLElementTagName() Gets the tag name of the root element representing this object.
boolean	isColonyCenterTile() Checks if this is the tile where the Colony is located.
void	newTurn() Prepares this ColonyTile for a new turn.
protected void	readFromXMLImpl(javax.xml.stream.XMLStreamReader in) Initialize this object from an XML-representation of this object.
void	relocateWorkers() Relocates any worker on this ColonyTile.
void	remove(Locatable locatable) Remove the specified Locatable from this WorkLocation.
void	setOwner(Player p) Sets the owner of this Ownable.
void	setUnit(Unit unit) Sets a Unit to this ColonyTile.
java.lang.String	toString() Will return the position of the tile and the name of the colony in addition to the FreeColObject.toString().
protected void	toXMLImpl(javax.xml.stream.XMLStreamWriter out, Player player, boolean showAll, boolean toSavedGame) This method writes an XML-representation of this object to the given stream.

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

addModelMessage, addModelMessage, equals, equals, getGame, getGameOptions, getID, getIntegerID, hashCode, hasID, isDisposed, isUninitialized, readFromArrayElement, readFromArrayElement, readFromArrayElement, readFromArrayElement, readFromXML, readFromXMLElement, setFakeID, setGame, setID, toArrayElement, toArrayElement, toArrayElement, toArrayElement, toSavedXML, toXML, toXML, toXML, toXMLElement, toXMLElement, updateID

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.freecol.common.model.Location

getID

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

LICENSE

public static final java.lang.String LICENSE

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

ColonyTile

public ColonyTile(Game game,
                  Colony colony,
                  Tile workTile)

Creates a new ColonyTile.

Parameters:

game - The Game this object belongs to.

colony - The Colony this object belongs to.

workTile - The tile in which this ColonyTile represents a WorkLocation for.

ColonyTile

public ColonyTile(Game game,
                  javax.xml.stream.XMLStreamReader in)
           throws javax.xml.stream.XMLStreamException

Initiates a new Building from an XML representation.

Parameters:

game - The Game this object belongs to.

in - The input stream containing the XML.

Throws:

javax.xml.stream.XMLStreamException - if an error occured during parsing.

ColonyTile

public ColonyTile(Game game,
                  org.w3c.dom.Element e)

Initiates a new Building from an XML representation.

Parameters:

game - The Game this object belongs to.

e - An XML-element that will be used to initialize this object.

ColonyTile

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

Initiates a new ColonyTile with the given ID. The object should later be initialized by calling either FreeColGameObject.readFromXML(XMLStreamReader) or FreeColGameObject.readFromXMLElement(Element).

Parameters:

game - The Game in which this object belong.

id - The unique identifier for this object.

Method Detail

getLocationName

public java.lang.String getLocationName()

Returns the (non-unique) name of this ColonyTile.

Specified by:

getLocationName in interface Location

Returns:

The name of this ColonyTile.

getLabel

public java.lang.String getLabel()

Returns a description of the tile, with the name of the tile and any improvements made to it (road/plow)

Returns:

The description label for this tile

getOwner

public Player getOwner()

Gets the owner of this Ownable.

Specified by:

getOwner in interface Ownable

Returns:

The Player controlling this Ownable.

setOwner

public void setOwner(Player p)

Sets the owner of this Ownable.

Specified by:

setOwner in interface Ownable

Parameters:

p - The Player that should take ownership of this Ownable.

Throws:

java.lang.UnsupportedOperationException - is always thrown by this method.

isColonyCenterTile

public boolean isColonyCenterTile()

Checks if this is the tile where the Colony is located.

Returns:

The result.

getWorkTile

public Tile getWorkTile()

Gets the work tile.

Returns:

The tile in which this ColonyTile represents a WorkLocation for.

getTile

public Tile getTile()

Gets the tile where the colony is located.

Specified by:

getTile in interface Location

Returns:

The Tile.

getGoodsContainer

public GoodsContainer getGoodsContainer()

Description copied from interface: Location

Gets the GoodsContainer this Location use for storing it's goods.

Specified by:

getGoodsContainer in interface Location

Returns:

The GoodsContainer or null if the Location cannot store any goods.

getUnit

public Unit getUnit()

Gets the Unit currently working on this ColonyTile.

Returns:

The Unit or null if no unit is present.

See Also:

setUnit(net.sf.freecol.common.model.Unit)

getColony

public Colony getColony()

Gets a pointer to the colony containing this tile.

Specified by:

getColony in interface WorkLocation

Returns:

The Colony.

setUnit

public void setUnit(Unit unit)

Sets a Unit to this ColonyTile.

Parameters:

unit - The Unit.

See Also:

getUnit()

getUnitCount

public int getUnitCount()

Gets the amount of Units at this ColonyTile.

Specified by:

getUnitCount in interface Location

Returns:

The amount of Units at this ColonyTile.

relocateWorkers

public void relocateWorkers()

Relocates any worker on this ColonyTile. The workers are added to another WorkLocation within the Colony.

canAdd

public boolean canAdd(Locatable locatable)

Checks if the specified Locatable may be added to this WorkLocation.

Specified by:

canAdd in interface Location

Parameters:

locatable - the Locatable.

Returns:

true if the Unit may be added and false otherwise.

add

public void add(Locatable locatable)

Add the specified Locatable to this WorkLocation.

Specified by:

add in interface Location

Parameters:

locatable - The Locatable that shall be added to this WorkLocation.

remove

public void remove(Locatable locatable)

Remove the specified Locatable from this WorkLocation.

Specified by:

remove in interface Location

Parameters:

locatable - The Locatable that shall be removed from this WorkLocation.

getUnitList

public java.util.List<Unit> getUnitList()

Description copied from interface: Location

Returns a list containing all the Units present at this Location. The list is a cloned list, so no risk.

Specified by:

getUnitList in interface Location

Returns:

a list containing the Units present at this location.

getUnitIterator

public java.util.Iterator<Unit> getUnitIterator()

Description copied from interface: Location

Gets a Iterator of every Unit directly located on this Location.

Specified by:

getUnitIterator in interface Location

Returns:

The Iterator.

contains

public boolean contains(Locatable locatable)

Checks if this ColonyTile contains the given Locatable.

Specified by:

contains in interface Location

Parameters:

locatable - The Locatable.

Returns:

The result.

getFirstUnit

public Unit getFirstUnit()

Gets the Unit currently working on this ColonyTile.

Returns:

The Unit or null if no unit is present.

See Also:

setUnit(net.sf.freecol.common.model.Unit)

getLastUnit

public Unit getLastUnit()

Gets the Unit currently working on this ColonyTile.

Returns:

The Unit or null if no unit is present.

See Also:

setUnit(net.sf.freecol.common.model.Unit)

newTurn

public void newTurn()

Prepares this ColonyTile for a new turn.

getFoodProduction

public int getFoodProduction()

Returns the production of food on this tile. This is the same as calling: getProductionOf(Goods.FOOD).

Returns:

The production of food in this colony.

getWorkType

public int getWorkType(Unit unit)

Returns a worktype for a unit.

Parameters:

unit - a Unit value

Returns:

a workType

getProductionOf

public int getProductionOf(int goodsType)

Returns the production of the given type of goods.

Specified by:

getProductionOf in interface WorkLocation

Parameters:

goodsType - The type of goods to get the production of.

Returns:

The production of the given type of goods.

getExpertForProducing

public int getExpertForProducing(int goodsType)

Returns the unit type producing the greatest amount of the given goods at this tile.

Parameters:

goodsType - The type of goods.

Returns:

The unit type.

See Also:

Unit.getExpertWorkType(), Building.getExpertUnitType()

dispose

public void dispose()

Description copied from class: FreeColGameObject

Removes all references to this object.

Overrides:

dispose in class FreeColGameObject

toXMLImpl

protected void toXMLImpl(javax.xml.stream.XMLStreamWriter out,
                         Player player,
                         boolean showAll,
                         boolean toSavedGame)
                  throws javax.xml.stream.XMLStreamException

This method writes an XML-representation of this object to the given stream.

Only attributes visible to the given Player will be added to that representation if showAll is set to false.

Specified by:

toXMLImpl in class FreeColGameObject

Parameters:

out - The target stream.

player - The Player this XML-representation should be made for, or null if showAll == true.

showAll - Only attributes visible to player will be added to the representation if showAll is set to false.

toSavedGame - If true then information that is only needed when saving a game is added.

Throws:

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

readFromXMLImpl

protected void readFromXMLImpl(javax.xml.stream.XMLStreamReader in)
                        throws javax.xml.stream.XMLStreamException

Initialize this object from an XML-representation of this object.

Specified by:

readFromXMLImpl in class FreeColGameObject

Parameters:

in - The input stream with the XML.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

toString

public java.lang.String toString()

Will return the position of the tile and the name of the colony in addition to the FreeColObject.toString().

Overrides:

toString in class FreeColGameObject

Returns:

A representation of a colony-tile that can be used for debugging.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

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

Returns:

"colonyTile".