Colony.java
| Index Score | ||
|---|---|---|
 |
 |
net.sf.freecol.common.model |
 |
 |
FreeCol |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| EXITS | Procedure exits |  |
| DECL_COMMENTS | Comments in declarations | |
| SIZE | Size of the file in bytes | |
| BLOCKS | Number of blocks | |
| EXEC_COMMENTS | Comments in executable code | |
| COMPARISONS | Number of comparison operators | |
| DOC_COMMENT | Number of javadoc comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| COMMENTS | Comment lines | |
| OPERATORS | Number of operators | |
| LINE_COMMENT | Number of line comments | |
| PROGRAM_LENGTH | Halstead program length | |
| LINES | Number of lines in the source file | |
| RETURNS | Number of return points from functions | |
| LOC | Lines of code | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| FUNCTIONS | Number of function declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LOGICAL_LINES | Number of statements | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0081 | JAVA0081 Boolean literal in comparison | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0125 | JAVA0125 Continue statement with label | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0065 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0094 | JAVA0094 Field hides a superclass field | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| LOOPS | Number of loops | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**
* Copyright (C) 2002-2007 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.common.model;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map.Entry;
import java.util.Set;
import java.util.Collection;
import java.util.LinkedList;
import java.util.logging.Logger;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import net.sf.freecol.FreeCol;
import net.sf.freecol.client.gui.i18n.Messages;
import net.sf.freecol.common.Specification;
import net.sf.freecol.common.model.Map.Direction;
import org.w3c.dom.Element;
/**
* Represents a colony. A colony contains {@link Building}s and
* {@link ColonyTile}s. The latter represents the tiles around the
* <code>Colony</code> where working is possible.
*/
public final class Colony extends Settlement implements Location, Nameable {
private static final Logger logger = Logger.getLogger(Colony.class.getName());
public static final int BELLS_PER_REBEL = 200;
public static final int FOOD_PER_COLONIST = 200;
public static final Ability HAS_PORT = new Ability("model.ability.hasPort");
/** The name of the colony. */
private String name;
/** A list of ColonyTiles. */
private final List<ColonyTile> colonyTiles = new ArrayList<ColonyTile>();
/** A map of Buildings, indexed by the ID of their basic type. */
private final java.util.Map<String, Building> buildingMap = new HashMap<String, Building>();
/** A map of ExportData, indexed by the IDs of GoodsTypes. */
private final java.util.Map<String, ExportData> exportData = new HashMap<String, ExportData>();
/** The SoL membership this turn. */
private int sonsOfLiberty;
/** The SoL membership last turn. */
private int oldSonsOfLiberty;
/** The number of tories this turn. */
private int tories;
/** The number of tories last turn. */
private int oldTories;
/** The current production bonus. */
private int productionBonus;
// Whether this colony is landlocked
private boolean landLocked = true;
// Will only be used on enemy colonies:
private int unitCount = -1;
// Temporary variable:
private int lastVisited = -1;
/**
* A list of Buildable items, which is NEVER empty.
*/
private List<BuildableType> buildQueue = new ArrayList<BuildableType>();
/**
* Creates a new <code>Colony</code>.
*
* @param game The <code>Game</code> in which this object belongs.
* @param owner The <code>Player</code> owning this <code>Colony</code>.
* @param name The name of the new <code>Colony</code>.
* @param tile The location of the <code>Colony</code>.
*/
public Colony(Game game, Player owner, String name, Tile tile) {
super(game, owner, tile);
goodsContainer = new GoodsContainer(game, this);
this.name = name;
sonsOfLiberty = 0;
oldSonsOfLiberty = 0;
final Map map = game.getMap();
tile.setOwner(owner);
TileImprovement road = new TileImprovement(game, tile, FreeCol.getSpecification()
.getTileImprovementType("model.improvement.Road"));
road.setTurnsToComplete(0);
tile.add(road);
for (Direction direction : Direction.values()) {
Tile t = map.getNeighbourOrNull(direction, tile);
if (t == null) {
continue;
}
if (t.getOwner() == null) {
t.setOwner(owner);
}
colonyTiles.add(new ColonyTile(game, this, t));
if (t.getType().isWater()) {
landLocked = false;
}
}
if (!landLocked) {
featureContainer.addAbility(HAS_PORT);
}
colonyTiles.add(new ColonyTile(game, this, tile));
List<BuildingType> buildingTypes = FreeCol.getSpecification().getBuildingTypeList();
for (BuildingType buildingType : buildingTypes) {
if (buildingType.getUpgradesFrom() == null &&
buildingType.getGoodsRequired().isEmpty()) {
addBuilding(new Building(getGame(), this, buildingType));
} else if (isFree(buildingType)) {
addBuilding(new Building(getGame(), this, buildingType));
}
}
setCurrentlyBuilding(BuildableType.NOTHING);
}
/**
* Initiates a new <code>Colony</code> from an XML representation.
*
* @param game The <code>Game</code> this object belongs to.
* @param in The input stream containing the XML.
* @throws XMLStreamException if an error occurred during parsing.
*/
public Colony(Game game, XMLStreamReader in) throws XMLStreamException {
super(game, in);
readFromXML(in);
}
/**
* Initiates a new <code>Colony</code> from an XML representation.
*
* @param game The <code>Game</code> this object belongs to.
* @param e An XML-element that will be used to initialize this object.
*/
public Colony(Game game, Element e) {
super(game, e);
readFromXMLElement(e);
}
/**
* Initiates a new <code>Colony</code> with the given ID. The object
* should later be initialized by calling either
* {@link #readFromXML(XMLStreamReader)} or
* {@link #readFromXMLElement(Element)}.
*
* @param game The <code>Game</code> in which this object belong.
* @param id The unique identifier for this object.
*/
public Colony(Game game, String id) {
super(game, id);
}
/**
* Returns <code>true</code> if a building of the given type can
* be built for free.
*
* @param buildingType a <code>BuildingType</code> value
* @return a <code>boolean</code> value
*/
private boolean isFree(BuildingType buildingType) {
float value = owner.getFeatureContainer().applyModifier(100f,
"model.modifier.buildingPriceBonus", buildingType, getGame().getTurn());
return (value == 0f && canBuild(buildingType));
}
/**
* Add a Building to this Colony.
*
* @param building a <code>Building</code> value
*/
public void addBuilding(final Building building) {
BuildingType buildingType = building.getType().getFirstLevel();
buildingMap.put(buildingType.getId(), building);
featureContainer.add(building.getType().getFeatureContainer());
}
/**
* Updates SoL and builds Buildings that are free if possible.
*/
public void updatePopulation() {
// this means we might get a building for free
for (BuildingType buildingType : FreeCol.getSpecification().getBuildingTypeList()) {
if (isFree(buildingType)) {
Building b = createBuilding(buildingType);
if (b!=null) {
addBuilding(b);
}
}
}
getTile().updatePlayerExploredTiles();
if (getUnitCount() > 0) {
updateSoL();
}
}
/**
* Describe <code>getExportData</code> method here.
*
* @param goodsType a <code>GoodsType</code> value
* @return an <code>ExportData</code> value
*/
public ExportData getExportData(final GoodsType goodsType) {
ExportData result = exportData.get(goodsType.getId());
if (result == null) {
result = new ExportData(goodsType);
setExportData(result);
}
return result;
}
/**
* Describe <code>setExportData</code> method here.
*
* @param newExportData an <code>ExportData</code> value
*/
public final void setExportData(final ExportData newExportData) {
exportData.put(newExportData.getId(), newExportData);
}
/**
* Returns whether this colony is landlocked, or has access to the ocean.
*
* @return <code>true</code> if there are no adjacent tiles to this
* <code>Colony</code>'s tile being ocean tiles.
*/
public boolean isLandLocked() {
return landLocked;
}
/**
* Returns whether this colony has undead units.
*
* @return whether this colony has undead units.
*/
public boolean isUndead() {
final Iterator<Unit> unitIterator = getUnitIterator();
return unitIterator.hasNext() && unitIterator.next().isUndead();
}
/**
* Sets the owner of this <code>Colony</code>, including all units
* within, and change main tile nation ownership.
*
* @param owner The <code>Player</code> that shall own this
* <code>Settlement</code>.
* @see Settlement#getOwner
*/
@Override
public void setOwner(Player owner) {
// TODO: Erik - this only works if called on the server!
super.setOwner(owner);
tile.setOwner(owner);
for (Unit unit : getUnitList()) {
unit.setOwner(owner);
if (unit.getLocation() instanceof ColonyTile) {
((ColonyTile) unit.getLocation()).getWorkTile().setOwner(owner);
}
}
for (Unit target : tile.getUnitList()) {
target.setOwner(getOwner());
}
for (ExportData exportDatum : exportData.values()) {
exportDatum.setExported(false);
}
// Changing the owner might alter bonuses applied by founding fathers:
updatePopulation();
}
/**
* Sets the number of units inside the colony, used in enemy colonies
*
* @param unitCount The units inside the colony
* @see #getUnitCount
*/
public void setUnitCount(int unitCount) {
this.unitCount = unitCount;
}
/**
* Returns the building for producing the given type of goods.
*
* @param goodsType The type of goods.
* @return The <code>Building</code> which produces the given type of
* goods, or <code>null</code> if such a building cannot be found.
*/
public Building getBuildingForProducing(GoodsType goodsType) {
// TODO: it should search for more than one building?
for (Building building : buildingMap.values()) {
if (building.getGoodsOutputType() == goodsType) {
return building;
}
}
return null;
}
/** COMEBACKHEREs
* Returns the colony's existing building for the given goods type.
*
* @param goodsType The goods type.
* @return The Building for the <code>goodsType</code>, or
* <code>null</code> if not exists or not fully built.
* @see Goods
*/
public Building getBuildingForConsuming(GoodsType goodsType) {
// TODO: it should search for more than one building?
for (Building building : buildingMap.values()) {
if (building.getGoodsInputType() == goodsType) {
return building;
}
}
return null;
}
/**
* Gets a <code>List</code> of every {@link WorkLocation} in this
* <code>Colony</code>.
*
* @return The <code>List</code>.
* @see WorkLocation
*/
public List<WorkLocation> getWorkLocations() {
List<WorkLocation> result = new ArrayList<WorkLocation>(colonyTiles);
result.addAll(buildingMap.values());
return result;
}
/**
* Gets a <code>List</code> of every {@link Building} in this
* <code>Colony</code>.
*
* @return The <code>List</code>.
* @see Building
*/
public List<Building> getBuildings() {
return new ArrayList<Building>(buildingMap.values());
}
/**
* Gets a <code>List</code> of every {@link ColonyTile} in this
* <code>Colony</code>.
*
* @return The <code>List</code>.
* @see ColonyTile
*/
public List<ColonyTile> getColonyTiles() {
return colonyTiles;
}
/**
* Gets a <code>Building</code> of the specified type.
*
* @param type The type of the building to get.
* @return The <code>Building</code>.
*/
public Building getBuilding(BuildingType type) {
return buildingMap.get(type.getFirstLevel().getId());
}
/**
* Returns a <code>Building</code> with the given
* <code>Ability</code>, or null, if none exists.
*
* @param ability a <code>String</code> value
* @return a <code>Building</code> value
*/
public Building getBuildingWithAbility(String ability) {
for (Building building : buildingMap.values()) {
if (building.getType().hasAbility(ability)) {
return building;
}
}
return null;
}
/**
* Gets the specified <code>ColonyTile</code>.
*
* @param x The x-coordinate of the <code>Tile</code>.
* @param y The y-coordinate of the <code>Tile</code>.
* @return The <code>ColonyTile</code> for the <code>Tile</code>
* returned by {@link #getTile(int, int)}.
*/
public ColonyTile getColonyTile(int x, int y) {
Tile t = getTile(x, y);
for (ColonyTile c : colonyTiles) {
if (c.getWorkTile() == t) {
return c;
}
}
return null;
}
/**
* Returns the <code>ColonyTile</code> matching the given
* <code>Tile</code>.
*
* @param t The <code>Tile</code> to get the <code>ColonyTile</code>
* for.
* @return The <code>ColonyTile</code>
*/
public ColonyTile getColonyTile(Tile t) {
for (ColonyTile c : colonyTiles) {
if (c.getWorkTile() == t) {
return c;
}
}
return null;
}
/**
* Adds a <code>Locatable</code> to this Location.
*
* @param locatable The <code>Locatable</code> to add to this Location.
*/
@Override
public void add(Locatable locatable) {
if (locatable instanceof Unit) {
if (((Unit) locatable).isColonist()) {
WorkLocation w = getVacantWorkLocationFor((Unit) locatable);
if (w == null) {
logger.warning("Could not find a 'WorkLocation' for " + locatable + " in " + this);
} else {
locatable.setLocation(w);
}
} else {
locatable.setLocation(getTile());
}
updatePopulation();
} else if (locatable instanceof Goods) {
goodsContainer.addGoods((Goods) locatable);
} else {
logger.warning("Tried to add an unrecognized 'Locatable' to a 'Colony'.");
}
}
/**
* Removes a <code>Locatable</code> from this Location.
*
* @param locatable The <code>Locatable</code> to remove from this
* Location.
*/
@Override
public void remove(Locatable locatable) {
if (locatable instanceof Unit) {
for (WorkLocation w : getWorkLocations()) {
if (w.contains(locatable)) {
w.remove(locatable);
updatePopulation();
return;
}
}
} else if (locatable instanceof Goods) {
goodsContainer.removeGoods((Goods) locatable);
} else {
logger.warning("Tried to remove an unrecognized 'Locatable' from a 'Colony'.");
}
}
/**
* Gets the amount of Units at this Location. These units are located in a
* {@link WorkLocation} in this <code>Colony</code>.
*
* @return The amount of Units at this Location.
*/
@Override
public int getUnitCount() {
int count = 0;
if (unitCount != -1) {
return unitCount;
}
for (WorkLocation w : getWorkLocations()) {
count += w.getUnitCount();
}
return count;
}
public List<Unit> getUnitList() {
ArrayList<Unit> units = new ArrayList<Unit>();
for (WorkLocation wl : getWorkLocations()) {
for (Unit unit : wl.getUnitList()) {
units.add(unit);
}
}
return units;
}
public Iterator<Unit> getUnitIterator() {
return getUnitList().iterator();
}
@Override
public boolean contains(Locatable locatable) {
throw new UnsupportedOperationException();
}
@Override
public boolean canAdd(Locatable locatable) {
if (locatable instanceof Unit && ((Unit) locatable).getOwner() == getOwner()) {
return true;
} else if (locatable instanceof Goods) {
return true;
} else {
return false;
}
}
/**
* Returns true if this colony has a schoolhouse and the unit type is a
* skilled unit type with a skill level not exceeding the level of the
* schoolhouse. @see Building#canAdd
*
* @param unit The unit to add as a teacher.
* @return <code>true</code> if this unit type could be added.
*/
public boolean canTrain(Unit unit) {
return canTrain(unit.getType());
}
/**
* Returns true if this colony has a schoolhouse and the unit type is a
* skilled unit type with a skill level not exceeding the level of the
* schoolhouse. The number of units already in the schoolhouse and
* the availability of pupils are not taken into account. @see
* Building#canAdd
*
* @param unitType The unit type to add as a teacher.
* @return <code>true</code> if this unit type could be added.
*/
public boolean canTrain(UnitType unitType) {
if (!hasAbility("model.ability.teach")) {
return false;
}
for (Building building : buildingMap.values()) {
if (building.getType().hasAbility("model.ability.teach") &&
building.canAdd(unitType)) {
return true;
}
}
return false;
}
public List<Unit> getTeachers() {
List<Unit> teachers = new ArrayList<Unit>();
for (Building building : buildingMap.values()) {
if (building.getType().hasAbility("model.ability.teach")) {
teachers.addAll(building.getUnitList());
}
}
return teachers;
}
/**
* Gets the <code>Unit</code> that is currently defending this
* <code>Colony</code>.
* <p>
* Note that this function will only return a unit working inside the colony.
* Typically, colonies are also defended by units outside the colony on the same tile.
* To consider units outside the colony as well, use (@see Tile#getDefendingUnit) instead.
* <p>
* Returns an arbitrary unarmed land unit unless Paul Revere is present
* as founding father, in which case the unit can be armed as well.
*
* @param attacker The unit that would be attacking this colony.
* @return The <code>Unit</code> that has been chosen to defend this
* colony.
* @see Tile#getDefendingUnit(Unit)
* @throws IllegalStateException if there are units in the colony
*/
@Override
public Unit getDefendingUnit(Unit attacker) {
Unit defender = null;
float defencePower = -1.0f;
for (Unit nextUnit : getUnitList()) {
float tmpPower = getGame().getCombatModel().getDefencePower(attacker, nextUnit);
if (tmpPower > defencePower) {
defender = nextUnit;
defencePower = tmpPower;
}
}
if (defender == null) {
throw new IllegalStateException("Colony " + name + " contains no units!");
} else {
return defender;
}
}
/**
* Returns a <code>List</code> with every unit type this colony may
* build.
*
* @return A <code>List</code> with <code>UnitType</code>
*/
public List<UnitType> getBuildableUnits() {
ArrayList<UnitType> buildableUnits = new ArrayList<UnitType>();
List<UnitType> unitTypes = FreeCol.getSpecification().getUnitTypeList();
for (UnitType unitType : unitTypes) {
if (unitType.getGoodsRequired().isEmpty() == false && canBuild(unitType)) {
buildableUnits.add(unitType);
}
}
return buildableUnits;
}
/**
* Returns the type of building currently being built.
*
* @return The type of building currently being built.
*/
public BuildableType getCurrentlyBuilding() {
return buildQueue.get(0);
}
/**
* Sets the type of building to be built.
*
* @param buildable The type of building to be built.
*/
public void setCurrentlyBuilding(BuildableType buildable) {
buildQueue.add(0, buildable);
}
/**
* Sets the type of building to None, so no building is done.
*/
public void stopBuilding() {
if (getCurrentlyBuilding() != BuildableType.NOTHING) {
setCurrentlyBuilding(BuildableType.NOTHING);
}
}
/**
* Get the <code>BuildQueue</code> value.
*
* @return a <code>List<Buildable></code> value
*/
public List<BuildableType> getBuildQueue() {
return buildQueue;
}
/**
* Set the <code>BuildQueue</code> value.
*
* @param newBuildQueue The new BuildQueue value.
*/
public void setBuildQueue(final List<BuildableType> newBuildQueue) {
this.buildQueue = newBuildQueue;
}
/**
* Adds to the bell count of the colony. Used only by DebugMenu.
*
* @param amount The number of bells to add.
*/
public void addBells(int amount) {
if (FreeCol.isInDebugMode()) {
GoodsType bells = FreeCol.getSpecification().getGoodsType("model.goods.bells");
getOwner().incrementBells(amount);
if (getMembers() <= getUnitCount() + 1 && amount > 0) {
addGoods(bells, amount);
}
updateSoL();
}
}
/**
* Returns the current SoL membership of the colony.
*
* @return The current SoL membership of the colony.
*/
public int getSoL() {
return sonsOfLiberty;
}
/**
* Calculates the current SoL membership of the colony based on the number
* of bells and colonists.
*/
private void updateSoL() {
int units = getUnitCount();
if (units <= 0) {
return;
}
// Update "addSol(int)" and "getMembers()" if this formula gets changed:
GoodsType bells = FreeCol.getSpecification().getGoodsType("model.goods.bells");
int membership = (getGoodsCount(bells) * 100) / (BELLS_PER_REBEL * units);
if (membership < 0) {
membership = 0;
} else if (membership > 100) {
membership = 100;
}
sonsOfLiberty = membership;
tories = (units - getMembers());
}
/**
* Return the number of sons of liberty
*/
public int getMembers() {
float result = (sonsOfLiberty * getUnitCount()) / 100f;
return Math.round(result);
}
/**
* Returns the Tory membership of the colony.
*
* @return The current Tory membership of the colony.
*/
public int getTory() {
return 100 - getSoL();
}
/**
* Returns the production bonus, if any, of the colony.
*
* @return The current production bonus of the colony.
*/
public int getProductionBonus() {
return productionBonus;
}
/**
* Gets a string representation of the Colony. Currently this method just
* returns the name of the <code>Colony</code>, but that may change
* later.
*
* @return The name of the colony.
* @see #getName
*/
@Override
public String toString() {
return name;
}
/**
* Gets the name of this <code>Colony</code>.
*
* @return The name as a <code>String</code>.
*/
public String getName() {
return name;
}
/**
* Sets the name of this <code>Colony</code>.
*
* @param newName The new name of this Colony.
*/
public void setName(String newName) {
this.name = newName;
}
/**
* Returns the name of this location.
*
* @return The name of this location.
*/
public String getLocationName() {
return name;
}
/**
* Gets the combined production of all food types.
*
* @return an <code>int</code> value
*/
public int getFoodProduction() {
int result = 0;
for (GoodsType foodType : FreeCol.getSpecification().getGoodsFood()) {
result += getProductionOf(foodType);
}
return result;
}
/**
* Returns the production of the given type of goods.
*
* @param goodsType The type of goods to get the production for.
* @return The production of the given type of goods the current turn by all
* of the <code>Colony</code>'s {@link Building buildings} and
* {@link ColonyTile tiles}.
*/
public int getProductionOf(GoodsType goodsType) {
int amount = 0;
for (WorkLocation workLocation : getWorkLocations()) {
amount += workLocation.getProductionOf(goodsType);
}
return amount;
}
/**
* Gets a vacant <code>WorkLocation</code> for the given <code>Unit</code>.
*
* @param unit The <code>Unit</code>
* @return A vacant <code>WorkLocation</code> for the given
* <code>Unit</code> or <code>null</code> if there is no such
* location.
*/
public WorkLocation getVacantWorkLocationFor(Unit unit) {
for (GoodsType foodType : FreeCol.getSpecification().getGoodsFood()) {
WorkLocation colonyTile = getVacantColonyTileFor(unit, foodType);
if (colonyTile != null) {
return colonyTile;
}
}
for (Building building : buildingMap.values()) {
if (building.canAdd(unit)) {
return building;
}
}
return null;
}
/**
* Returns a vacant <code>ColonyTile</code> where the given
* <code>unit</code> produces the maximum output of the given
* <code>goodsType</code>.
*
* @param unit The <code>Unit</code> to find a vacant
* <code>ColonyTile</code> for.
* @param goodsType The type of goods that should be produced.
* @return The <code>ColonyTile</code> giving the highest production of
* the given goods for the given unit or <code>null</code> if
* there is no available <code>ColonyTile</code> for producing
* that goods.
*/
public ColonyTile getVacantColonyTileFor(Unit unit, GoodsType goodsType) {
ColonyTile bestPick = null;
int highestProduction = 0;
for (ColonyTile colonyTile : colonyTiles) {
if (colonyTile.canAdd(unit)) {
Tile workTile = colonyTile.getWorkTile();
/*
* canAdd ensures workTile it's empty or unit it's working in it
* so unit can work in it if it's owned by none, by europeans or
* unit's owner has the founding father Peter Minuit
*/
if (owner.getLandPrice(workTile) == 0) {
int potential = colonyTile.getProductionOf(unit, goodsType);
if (potential > highestProduction) {
highestProduction = potential;
bestPick = colonyTile;
}
}
}
}
return bestPick;
}
/**
* Returns the production of a vacant <code>ColonyTile</code> where the
* given <code>unit</code> produces the maximum output of the given
* <code>goodsType</code>.
*
* @param unit The <code>Unit</code> to find the highest possible
* <code>ColonyTile</code>-production for.
* @param goodsType The type of goods that should be produced.
* @return The highest possible production on a vacant
* <code>ColonyTile</code> for the given goods and the given unit.
*/
public int getVacantColonyTileProductionFor(Unit unit, GoodsType goodsType) {
ColonyTile bestPick = getVacantColonyTileFor(unit, goodsType);
return bestPick == null ? 0 : bestPick.getProductionOf(unit, goodsType);
}
/**
* Returns how much of a Good will be produced by this colony this turn
*
* @param goodsType The goods' type.
* @return The amount of the given goods will be produced for next turn.
*/
public int getProductionNextTurn(GoodsType goodsType) {
int count = 0;
Building building = getBuildingForProducing(goodsType);
if (building == null) {
count = getProductionOf(goodsType);
} else {
count = building.getProductionNextTurn();
}
return count;
}
/**
* Returns how much of a Good will be produced by this colony this turn,
* taking into account how much is consumed - by workers, horses, etc.
*
* @param goodsType The goods' type.
* @return The amount of the given goods currently unallocated for next
* turn.
*/
public int getProductionNetOf(GoodsType goodsType) {
int count = getProductionNextTurn(goodsType);
int used = 0;
Building bldg = getBuildingForConsuming(goodsType);
if (bldg != null) {
used = bldg.getGoodsInputNextTurn();
}
if (goodsType.isStorable()) {
if (goodsType.isFoodType()) {
used += getFoodConsumption();
}
BuildableType currentBuildable = getCurrentlyBuilding();
if (currentBuildable != null &&
currentBuildable != BuildableType.NOTHING &&
currentBuildable.getGoodsRequired().isEmpty() == false) {
boolean willBeFinished = true;
int possiblyUsed = 0;
for (AbstractGoods goodsRequired : currentBuildable.getGoodsRequired()) {
GoodsType requiredType = goodsRequired.getType();
int requiredAmount = goodsRequired.getAmount();
int presentAmount = getGoodsCount(requiredType);
if (requiredType.equals(goodsType)) {
if (presentAmount + (count - used) < requiredAmount) {
willBeFinished = false;
break;
} else if (presentAmount < requiredAmount) {
possiblyUsed = requiredAmount - presentAmount;
}
} else if (getGoodsCount(requiredType) + getProductionNextTurn(requiredType) <
goodsRequired.getAmount()) {
willBeFinished = false;
break;
}
}
if (willBeFinished && possiblyUsed > 0) {
used += possiblyUsed;
}
}
}
return count - used;
}
/**
* Returns <code>true</code> if this Colony can breed the given
* type of Goods. Only animals (such as horses) are expected to be
* breedable.
*
* @param goodsType a <code>GoodsType</code> value
* @return a <code>boolean</code> value
*/
public boolean canBreed(GoodsType goodsType) {
int breedingNumber = goodsType.getBreedingNumber();
return (breedingNumber != GoodsType.NO_BREEDING &&
breedingNumber <= getGoodsCount(goodsType));
}
/**
* Describe <code>canBuild</code> method here.
*
* @return a <code>boolean</code> value
*/
public boolean canBuild() {
return canBuild(getCurrentlyBuilding());
}
/**
* Returns true if this Colony can build the given BuildableType.
*
* @param buildableType a <code>BuildableType</code> value
* @return a <code>boolean</code> value
*/
public boolean canBuild(BuildableType buildableType) {
if (buildableType == null || buildableType == BuildableType.NOTHING) {
return false;
} else if (buildableType.getGoodsRequired().isEmpty()) {
return false;
} else if (buildableType.getPopulationRequired() > getUnitCount()) {
return false;
} else {
java.util.Map<String, Boolean> requiredAbilities = buildableType.getAbilitiesRequired();
for (Entry<String, Boolean> entry : requiredAbilities.entrySet()) {
if (hasAbility(entry.getKey()) != entry.getValue()) {
return false;
}
}
}
if (buildableType instanceof BuildingType) {
BuildingType newBuildingType = (BuildingType) buildableType;
Building colonyBuilding = this.getBuilding(newBuildingType);
if (colonyBuilding == null) {
// the colony has no similar building yet
if (newBuildingType.getUpgradesFrom() != null) {
// we are trying to build an advanced factory, we should build lower level shop first
return false;
}
} else {
// a building of the same family already exists
if (colonyBuilding.getType().getUpgradesTo() != newBuildingType) {
// the existing building's next upgrade is not the new one we want to build
return false;
}
}
}
return true;
}
/**
* Ask the server to create a building for us.
*
* @param buildingType a <code>BuildingType</code> value
* @return a <code>Building</code> value
*/
public Building createBuilding(BuildingType buildingType) {
return getGame().getModelController().createBuilding(getId() + "buildBuilding", this, buildingType);
}
private void checkBuildableComplete() {
// In order to avoid duplicate messages:
if (lastVisited == getGame().getTurn().getNumber()) {
return;
}
lastVisited = getGame().getTurn().getNumber();
if (canBuild()) {
BuildableType buildable = getCurrentlyBuilding();
ArrayList<ModelMessage> messages = new ArrayList<ModelMessage>();
for (AbstractGoods goodsRequired : buildable.getGoodsRequired()) {
GoodsType requiredGoodsType = goodsRequired.getType();
int available = getGoodsCount(requiredGoodsType);
int required = goodsRequired.getAmount();
if (available < required) {
if (!requiredGoodsType.isStorable()) {
// buildable is not complete and we don't care
// about missing goods because unstorable
// goods (e.g. hammers) are still missing
return;
}
messages.add(new ModelMessage(this, ModelMessage.MessageType.MISSING_GOODS,
requiredGoodsType,
"model.colony.buildableNeedsGoods",
"%colony%", getName(),
"%buildable%", buildable.getName(),
"%amount%", String.valueOf(required - available),
"%goodsType%", requiredGoodsType.getName()));
}
}
if (messages.isEmpty()) {
// no messages means all goods are present
for (AbstractGoods goodsRequired : buildable.getGoodsRequired()) {
if (getGameOptions().getBoolean(GameOptions.SAVE_PRODUCTION_OVERFLOW) ||
goodsRequired.getType().isStorable()) {
removeGoods(goodsRequired);
} else {
// waste excess goods
removeGoods(goodsRequired.getType());
}
}
if (buildable instanceof UnitType) {
// artillery/ship/wagon completed
Unit unit = getGame().getModelController().createUnit(getId() + "buildUnit", getTile(), getOwner(),
(UnitType) buildable);
addModelMessage(this, ModelMessage.MessageType.UNIT_ADDED, unit,
"model.colony.unitReady",
"%colony%", getName(),
"%unit%", unit.getName());
} else if (buildable instanceof BuildingType) {
// building completed
BuildingType upgradesFrom = ((BuildingType) buildable).getUpgradesFrom();
if (upgradesFrom == null) {
addBuilding(createBuilding((BuildingType) buildable));
} else {
getBuilding(upgradesFrom).upgrade();
}
addModelMessage(this, ModelMessage.MessageType.BUILDING_COMPLETED, this,
"model.colony.buildingReady",
"%colony%", getName(),
"%building%", buildable.getName());
buildQueue.remove(0);
if (buildQueue.isEmpty()) {
buildQueue.add(BuildableType.NOTHING);
}
if (buildQueue.size()==1 && buildQueue.get(0)==BuildableType.NOTHING) {
addModelMessage(this, ModelMessage.MessageType.WARNING, this,
"model.colony.cannotBuild",
"%colony%", getName());
}
}
} else {
for (ModelMessage message : messages) {
owner.addModelMessage(message);
}
}
}
}
/**
* Returns the price for the remaining hammers and tools for the
* {@link Building} that is currently being built.
*
* @return The price.
* @see #payForBuilding
*/
public int getPriceForBuilding() {
// Any changes in this method should also be reflected in
// "payForBuilding()"
int price = 0;
for (AbstractGoods goodsRequired : getCurrentlyBuilding().getGoodsRequired()) {
GoodsType requiredGoodsType = goodsRequired.getType();
int remaining = goodsRequired.getAmount() - getGoodsCount(requiredGoodsType);
if (remaining > 0) {
if (requiredGoodsType.isStorable()) {
price += (getOwner().getMarket().getBidPrice(requiredGoodsType, remaining) * 110) / 100;
} else {
price += requiredGoodsType.getPrice() * remaining;
}
}
}
return price;
}
/**
* Buys the remaining hammers and tools for the {@link Building} that is
* currently being built.
*
* @exception IllegalStateException If the owner of this <code>Colony</code>
* has an insufficient amount of gold.
* @see #getPriceForBuilding
*/
public void payForBuilding() {
// Any changes in this method should also be reflected in
// "getPriceForBuilding()"
if (getPriceForBuilding() > getOwner().getGold()) {
throw new IllegalStateException("Not enough gold.");
}
for (AbstractGoods goodsRequired : getCurrentlyBuilding().getGoodsRequired()) {
GoodsType requiredGoodsType = goodsRequired.getType();
int remaining = goodsRequired.getAmount() - getGoodsCount(requiredGoodsType);
if (remaining > 0) {
if (requiredGoodsType.isStorable()) {
getOwner().getMarket().buy(requiredGoodsType, remaining, getOwner());
} else {
getOwner().modifyGold(-remaining * requiredGoodsType.getPrice());
}
addGoods(requiredGoodsType, remaining);
}
}
}
/**
* determine if there is a problem with the production of the specified good
*
* @param goodsType for this good
* @param amount warehouse amount
* @param production production per turn
* @return all warnings
*/
public Collection<String> getWarnings(GoodsType goodsType, int amount, int production) {
List<String> result = new LinkedList<String>();
if (goodsType.isFoodType() && goodsType.isStorable()) {
if (amount + production < 0) {
result.add(Messages.message("model.colony.famineFeared",
"%colony%", getName(),
"%number%", "0"));
}
} else {
//food is never wasted -> new settler is produced
int waste = (amount + production - getWarehouseCapacity());
if (waste > 0 && !getExportData(goodsType).isExported() && !goodsType.limitIgnored()) {
result.add(Messages.message("model.building.warehouseSoonFull",
"%goods%", goodsType.getName(),
"%colony%", getName(),
"%amount%", String.valueOf(waste)));
}
}
BuildableType currentlyBuilding = getCurrentlyBuilding();
if (currentlyBuilding != BuildingType.NOTHING) {
for (AbstractGoods goods : currentlyBuilding.getGoodsRequired()) {
if (goods.getType().equals(goodsType) && amount < goods.getAmount()) {
result.add(Messages.message("model.colony.buildableNeedsGoods",
"%colony%", getName(),
"%buildable%", currentlyBuilding.getName(),
"%amount%", String.valueOf(goods.getAmount() - amount),
"%goodsType%", goodsType.getName()));
}
}
}
addInsufficientProductionMessage(result, getBuildingForProducing(goodsType));
Building buildingForConsuming = getBuildingForConsuming(goodsType);
if (buildingForConsuming != null && !buildingForConsuming.getGoodsOutputType().isStorable()) {
//the warnings are for a non-storable good, which is not displayed in the trade report
addInsufficientProductionMessage(result, buildingForConsuming);
}
return result;
}
/**
* adds a message about insufficient production for a building
*
* @param warnings where to add the warnings
* @param building for this building
*/
private void addInsufficientProductionMessage(List<String> warnings, Building building) {
if (building != null) {
int delta = building.getMaximumProduction() - building.getProductionNextTurn();
if (delta > 0) {
warnings.add(createInsufficientProductionMessage(
building.getGoodsOutputType(),
delta,
building.getGoodsInputType(),
building.getMaximumGoodsInput() - building.getGoodsInputNextTurn()));
}
}
}
/**
* create a message about insufficient production
*
* @param outputType output type
* @param missingOutput missing output
* @param inputType input type
* @param missingInput missing input
* @return message
*/
private String createInsufficientProductionMessage(GoodsType outputType, int missingOutput,
GoodsType inputType, int missingInput) {
return Messages.message("model.colony.insufficientProduction",
"%outputAmount%", String.valueOf(missingOutput),
"%outputType%", outputType.getName(),
"%colony%", getName(),
"%inputAmount%", String.valueOf(missingInput),
"%inputType%", inputType.getName());
}
/**
* Returns a random unit from this colony. At this moment, this method
* always returns the first unit in the colony.
*
* @return A random unit from this <code>Colony</code>. This
* <code>Unit</code> will either be working in a {@link Building}
* or a {@link ColonyTile}.
*/
public Unit getRandomUnit() {
return getFirstUnit();
// return getUnitIterator().hasNext() ? getUnitIterator().next() : null;
}
private Unit getFirstUnit() {
for (WorkLocation wl : getWorkLocations()) {
Iterator<Unit> unitIterator = wl.getUnitIterator();
while (unitIterator.hasNext()) {
Unit o = unitIterator.next();
if (o != null) {
return o;
}
}
}
return null;
}
// Save state of warehouse
private void saveWarehouseState() {
logger.finest("Saving state of warehouse in " + getName());
getGoodsContainer().saveState();
}
// Update all colony tiles
private void addColonyTileProduction() {
for (ColonyTile colonyTile : colonyTiles) {
logger.finest("Calling newTurn for colony tile " + colonyTile.toString());
colonyTile.newTurn();
}
}
// Eat food:
void updateFood() {
int required = getFoodConsumption();
int available = getFoodCount();
int production = getFoodProduction();
if (required > available) {
// Kill a colonist:
getRandomUnit().dispose();
removeFood(available);
addModelMessage(this, ModelMessage.MessageType.UNIT_LOST,
"model.colony.colonistStarved", "%colony%", getName());
} else {
removeFood(required);
if (required > production){
int turnsToLive = (available - required) / (required - production);
if(turnsToLive <= 3) {
addModelMessage(this, ModelMessage.MessageType.WARNING,
"model.colony.famineFeared", "%colony%", getName(),
"%number%", String.valueOf(turnsToLive));
}
}
}
}
// Create a new colonist if there is enough food:
private void checkForNewColonist() {
if (getFoodCount() >= FOOD_PER_COLONIST) {
List<UnitType> unitTypes = FreeCol.getSpecification().getUnitTypesWithAbility("model.ability.bornInColony");
if (!unitTypes.isEmpty()) {
int random = getGame().getModelController().getRandom(getId() + "bornInColony", unitTypes.size());
Unit u = getGame().getModelController().createUnit(getId() + "newTurn200food",
getTile(), getOwner(), unitTypes.get(random));
removeFood(FOOD_PER_COLONIST);
addModelMessage(this, ModelMessage.MessageType.UNIT_ADDED, u,
"model.colony.newColonist", "%colony%", getName());
logger.info("New colonist created in " + getName() + " with ID=" + u.getId());
}
}
}
// Export goods if custom house is built
private void exportGoods() {
if (hasAbility("model.ability.export")) {
List<Goods> exportGoods = getCompactGoods();
for (Goods goods : exportGoods) {
GoodsType type = goods.getType();
ExportData data = getExportData(type);
if (data.isExported() && (owner.canTrade(goods, Market.CUSTOM_HOUSE))) {
int amount = goods.getAmount() - data.getExportLevel();
if (amount > 0) {
removeGoods(type, amount);
getOwner().getMarket().sell(type, amount, owner, Market.CUSTOM_HOUSE);
}
}
}
}
}
// Warn about levels that will be exceeded next turn
private void createWarehouseCapacityWarning() {
List<Goods> storedGoods = getGoodsContainer().getFullGoods();
for (Goods goods : storedGoods) {
GoodsType goodsType = goods.getType();
if (!goodsType.isStorable() || goodsType.limitIgnored()) {
// no need to do anything about bells or crosses
continue;
} else if (getExportData(goodsType).isExported() &&
owner.canTrade(goods, Market.CUSTOM_HOUSE)) {
// capacity will never be exceeded
continue;
} else if (goods.getAmount() < getWarehouseCapacity()) {
int waste = (goods.getAmount() + getProductionNetOf(goodsType) -
getWarehouseCapacity());
if (waste > 0) {
addModelMessage(this, ModelMessage.MessageType.WAREHOUSE_CAPACITY, goodsType,
"model.building.warehouseSoonFull",
"%goods%", goods.getName(),
"%colony%", getName(),
"%amount%", String.valueOf(waste));
}
}
}
}
private void createSoLMessages() {
final int veryBadGovernment = Specification.getSpecification().getIntegerOption("model.option.veryBadGovernmentLimit").getValue();
final int badGovernment = Specification.getSpecification().getIntegerOption("model.option.badGovernmentLimit").getValue();
if (sonsOfLiberty / 10 != oldSonsOfLiberty / 10) {
if (sonsOfLiberty > oldSonsOfLiberty) {
addModelMessage(this, ModelMessage.MessageType.SONS_OF_LIBERTY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.SoLIncrease",
"%oldSoL%", String.valueOf(oldSonsOfLiberty),
"%newSoL%", String.valueOf(sonsOfLiberty),
"%colony%", getName());
} else {
addModelMessage(this, ModelMessage.MessageType.SONS_OF_LIBERTY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.SoLDecrease",
"%oldSoL%", String.valueOf(oldSonsOfLiberty),
"%newSoL%", String.valueOf(sonsOfLiberty),
"%colony%", getName());
}
}
int bonus = 0;
if (sonsOfLiberty == 100) {
// there are no tories left
bonus = 2;
if (oldSonsOfLiberty < 100) {
addModelMessage(this, ModelMessage.MessageType.SONS_OF_LIBERTY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.SoL100", "%colony%", getName());
}
} else {
if (sonsOfLiberty >= 50) {
bonus += 1;
if (oldSonsOfLiberty < 50) {
addModelMessage(this, ModelMessage.MessageType.SONS_OF_LIBERTY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.SoL50", "%colony%", getName());
}
}
if (tories > veryBadGovernment) {
bonus -= 2;
if (oldTories <= veryBadGovernment) {
// government has become very bad
addModelMessage(this, ModelMessage.MessageType.GOVERNMENT_EFFICIENCY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.veryBadGovernment", "%colony%", getName());
}
} else if (tories > badGovernment) {
bonus -= 1;
if (oldTories <= badGovernment) {
// government has become bad
addModelMessage(this, ModelMessage.MessageType.GOVERNMENT_EFFICIENCY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.badGovernment", "%colony%", getName());
} else if (oldTories > veryBadGovernment) {
// government has improved, but is still bad
addModelMessage(this, ModelMessage.MessageType.GOVERNMENT_EFFICIENCY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.governmentImproved1", "%colony%", getName());
}
} else if (oldTories > badGovernment) {
// government was bad, but has improved
addModelMessage(this, ModelMessage.MessageType.GOVERNMENT_EFFICIENCY,
FreeCol.getSpecification().getGoodsType("model.goods.bells"),
"model.colony.governmentImproved2", "%colony%", getName());
}
}
// TODO-LATER: REMOVE THIS WHEN THE AI CAN HANDLE PRODUCTION PENALTIES:
if (getOwner().isAI()) {
productionBonus = Math.max(0, bonus);
} else {
productionBonus = bonus;
}
}
/**
* Prepares this <code>Colony</code> for a new turn.
*/
@Override
public void newTurn() {
// Skip doing work in enemy colonies.
if (unitCount != -1) {
return;
}
if (getTile() == null) {
// Fix NullPointerException below
logger.warning("Colony " + getName() + " lacks a tile!");
return;
}
// TODO: make warehouse a building
saveWarehouseState();
addColonyTileProduction();
updateFood();
if (getUnitCount() == 0) {
dispose();
return;
}
List<GoodsType> goodsForBuilding = new ArrayList<GoodsType>();
if (canBuild()) {
for (AbstractGoods goodsRequired : getCurrentlyBuilding().getGoodsRequired()) {
goodsForBuilding.add(goodsRequired.getType());
}
} else {
// something is preventing construction
BuildableType currentlyBuilding = getCurrentlyBuilding();
if ((currentlyBuilding == null || currentlyBuilding == BuildableType.NOTHING)) {
for (GoodsType goodsType : Specification.getSpecification().getGoodsTypeList()) {
if (goodsType.isBuildingMaterial() &&
!goodsType.isStorable() &&
getProductionOf(goodsType) > 0) {
// production idle
addModelMessage(this, ModelMessage.MessageType.WARNING, this,
"model.colony.cannotBuild",
"%colony%", getName());
}
}
} else if (currentlyBuilding.getPopulationRequired() > getUnitCount()) {
// not enough units
addModelMessage(this, ModelMessage.MessageType.WARNING, this,
"model.colony.buildNeedPop",
"%colony%", getName(),
"%building%", currentlyBuilding.getName());
}
}
List<Building> buildings1 = new ArrayList<Building>();
List<Building> buildings2 = new ArrayList<Building>();
for (Building building : getBuildings()) {
if (building.getType().hasAbility("model.ability.autoProduction")) {
// call auto-producing buildings immediately
logger.finest("Calling newTurn for building " + building.getName());
building.newTurn();
} else if (goodsForBuilding.contains(building.getGoodsOutputType())) {
buildings1.add(building);
} else {
buildings2.add(building);
}
}
// buildings that produce building materials
for (Building building : buildings1) {
logger.finest("Calling newTurn for building " + building.getName());
building.newTurn();
}
// The following tasks consume building materials or may do so
// in the future
checkBuildableComplete();
// buildings that do not produce building materials, but might
// consume them
for (Building building : buildings2) {
logger.finest("Calling newTurn for building " + building.getName());
building.newTurn();
}
// must be after building production because horse production
// consumes some food
checkForNewColonist();
exportGoods();
// Throw away goods there is no room for.
goodsContainer.cleanAndReport();
// TODO: make warehouse a building
createWarehouseCapacityWarning();
// Remove bells:
int bellsToRemove = getUnitCount() - 2;
if (bellsToRemove > 0) {
removeGoods(Goods.BELLS, bellsToRemove);
}
// Update SoL:
updateSoL();
createSoLMessages();
// Remember current SoL and tories for check changes at the next turn
oldSonsOfLiberty = sonsOfLiberty;
oldTories = tories;
}
/**
* Returns the capacity of this colony's warehouse. All goods above this
* limit, except {@link Goods#FOOD}, will be removed when calling
* {@link #newTurn}.
*
* @return The capacity of this <code>Colony</code>'s warehouse.
*/
public int getWarehouseCapacity() {
return (int) featureContainer.applyModifier(0, "model.modifier.warehouseStorage",
null, getGame().getTurn());
}
public Building getWarehouse() {
// TODO: it should search for more than one building?
for (Building building : buildingMap.values()) {
if (!building.getType().getModifierSet("model.modifier.warehouseStorage").isEmpty()) {
return building;
}
}
return null;
}
/**
* Disposes this <code>Colony</code>. All <code>WorkLocation</code>s
* owned by this <code>Colony</code> will also be destroyed.
*/
@Override
public void dispose() {
for (WorkLocation workLocation : getWorkLocations()) {
((FreeColGameObject) workLocation).dispose();
}
super.dispose();
}
/**
* This method writes an XML-representation of this object to the given
* stream. <br>
* <br>
* Only attributes visible to the given <code>Player</code> will be added
* to that representation if <code>showAll</code> is set to
* <code>false</code>.
*
* @param out The target stream.
* @param player The <code>Player</code> this XML-representation should be
* made for, or <code>null</code> if
* <code>showAll == true</code>.
* @param showAll Only attributes visible to <code>player</code> will be
* added to the representation if <code>showAll</code> is set
* to <i>false</i>.
* @param toSavedGame If <code>true</code> then information that is only
* needed when saving a game is added.
* @throws XMLStreamException if there are any problems writing to the
* stream.
*/
@Override
protected void toXMLImpl(XMLStreamWriter out, Player player, boolean showAll, boolean toSavedGame)
throws XMLStreamException {
// Start element:
out.writeStartElement(getXMLElementTagName());
// Add attributes:
out.writeAttribute("ID", getId());
out.writeAttribute("name", name);
out.writeAttribute("owner", owner.getId());
out.writeAttribute("tile", tile.getId());
if (getGame().isClientTrusted() || showAll || player == getOwner()) {
out.writeAttribute("sonsOfLiberty", Integer.toString(sonsOfLiberty));
out.writeAttribute("oldSonsOfLiberty", Integer.toString(oldSonsOfLiberty));
out.writeAttribute("tories", Integer.toString(tories));
out.writeAttribute("oldTories", Integer.toString(oldTories));
out.writeAttribute("productionBonus", Integer.toString(productionBonus));
if (!BuildableType.NOTHING.equals(getCurrentlyBuilding())) {
out.writeAttribute("currentlyBuilding", getCurrentlyBuilding().getId());
}
out.writeAttribute("landLocked", Boolean.toString(landLocked));
for (ExportData data : exportData.values()) {
data.toXML(out);
}
/**
* Don't write other features, they will be added from buildings in readFromXMLImpl
*/
for (Modifier modifier : featureContainer.getModifierSet("model.goods.bells",
null, getGame().getTurn())) {
if (Modifier.COLONY_GOODS_PARTY.equals(modifier.getSource())) {
modifier.toXML(out);
}
}
for (WorkLocation workLocation : getWorkLocations()) {
((FreeColGameObject) workLocation).toXML(out, player, showAll, toSavedGame);
}
} else {
out.writeAttribute("unitCount", Integer.toString(getUnitCount()));
if (getStockade() != null) {
getStockade().toXML(out, player, showAll, toSavedGame);
}
}
goodsContainer.toXML(out, player, showAll, toSavedGame);
// End element:
out.writeEndElement();
}
/**
* Initialize this object from an XML-representation of this object.
*
* @param in The input stream with the XML.
*/
@Override
protected void readFromXMLImpl(XMLStreamReader in) throws XMLStreamException {
setId(in.getAttributeValue(null, "ID"));
name = in.getAttributeValue(null, "name");
owner = getFreeColGameObject(in, "owner", Player.class);
tile = getFreeColGameObject(in, "tile", Tile.class);
owner.addSettlement(this);
sonsOfLiberty = getAttribute(in, "sonsOfLiberty", 0);
oldSonsOfLiberty = getAttribute(in, "oldSonsOfLiberty", 0);
tories = getAttribute(in, "tories", 0);
oldTories = getAttribute(in, "oldTories", 0);
productionBonus = getAttribute(in, "productionBonus", 0);
setCurrentlyBuilding(FreeCol.getSpecification().getType(in, "currentlyBuilding", BuildableType.class,
BuildableType.NOTHING));
landLocked = getAttribute(in, "landLocked", true);
if (!landLocked) {
featureContainer.addAbility(HAS_PORT);
}
unitCount = getAttribute(in, "unitCount", -1);
featureContainer.addModifier(Settlement.DEFENCE_MODIFIER);
// Read child elements:
loop: while (in.nextTag() != XMLStreamConstants.END_ELEMENT) {
if (in.getLocalName().equals(ColonyTile.getXMLElementTagName())) {
ColonyTile ct = (ColonyTile) getGame().getFreeColGameObject(in.getAttributeValue(null, "ID"));
if (ct == null) {
colonyTiles.add(new ColonyTile(getGame(), in));
} else {
ct.readFromXML(in);
}
} else if (in.getLocalName().equals(Building.getXMLElementTagName())) {
Building b = (Building) getGame().getFreeColGameObject(in.getAttributeValue(null, "ID"));
if (b == null) {
addBuilding(new Building(getGame(), in));
} else {
b.readFromXML(in);
}
} else if (in.getLocalName().equals(GoodsContainer.getXMLElementTagName())) {
GoodsContainer gc = (GoodsContainer) getGame().getFreeColGameObject(in.getAttributeValue(null, "ID"));
if (gc == null) {
goodsContainer = new GoodsContainer(getGame(), this, in);
} else {
goodsContainer.readFromXML(in);
}
} else if (in.getLocalName().equals(ExportData.getXMLElementTagName())) {
ExportData data = new ExportData();
data.readFromXML(in);
exportData.put(data.getId(), data);
} else if (Modifier.getXMLElementTagName().equals(in.getLocalName())) {
Modifier modifier = new Modifier(in);
if (Modifier.COLONY_GOODS_PARTY.equals(modifier.getSource())) {
Set<Modifier> bellsBonus = featureContainer.getModifierSet("model.goods.bells");
for (Modifier existingModifier : bellsBonus) {
if (Modifier.COLONY_GOODS_PARTY.equals(existingModifier.getSource()) &&
modifier.getType() == existingModifier.getType() ) {
// there is a already existing goods party modifier.. dont add again..
/* TODO: this is only a work-around; the
actual problem is that we did not
override equals() and hashcode() for
Feature and subclasses. I *think* this
is the only place where this is a
problem, but I may be mistaken.
*/
continue loop;
}
}
// found no matching modifier
featureContainer.addModifier(modifier);
}
} else {
logger.warning("Unknown tag: " + in.getLocalName() + " loading colony " + name);
in.nextTag();
}
}
}
/**
* Gets the tag name of the root element representing this object.
*
* @return "colony".
*/
public static String getXMLElementTagName() {
return "colony";
}
/**
* Returns just this Colony itself.
*
* @return this colony.
*/
public Colony getColony() {
return this;
}
/**
* Returns true when colony has a stockade
*
* @return whether the colony has a stockade
*/
public boolean hasStockade() {
return (getStockade() != null);
}
/**
* Returns the stockade building
*
* @return a <code>Building</code>
*/
public Building getStockade() {
// TODO: it should search for more than one building?
for (Building building : buildingMap.values()) {
if (!building.getType().getModifierSet("model.modifier.defence").isEmpty()) {
return building;
}
}
return null;
}
/**
* Get the <code>Modifier</code> value.
*
* @param id a <code>String</code> value
* @return a <code>Modifier</code> value
*/
public final Set<Modifier> getModifierSet(String id) {
Set<Modifier> result = featureContainer.getModifierSet(id, null, getGame().getTurn());
result.addAll(owner.getFeatureContainer().getModifierSet(id, null, getGame().getTurn()));
return result;
}
/**
* Returns true if the Colony, or its owner has the ability
* identified by <code>id</code>.
*
* @param id a <code>String</code> value
* @return a <code>boolean</code> value
*/
public boolean hasAbility(String id) {
HashSet<Ability> colonyAbilities =
new HashSet<Ability>(featureContainer.getAbilitySet(id, null, getGame().getTurn()));
Set<Ability> playerAbilities = owner.getFeatureContainer().getAbilitySet(id, null, getGame().getTurn());
colonyAbilities.addAll(playerAbilities);
return FeatureContainer.hasAbility(colonyAbilities);
}
public FeatureContainer getFeatureContainer() {
return featureContainer;
}
}
The table below shows all metrics for Colony.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 302.00 | Number of blocks | |
| BLOCK_COMMENT | 12.00 | Number of block comment lines | |
| COMMENTS | 599.00 | Comment lines | |
| COMMENT_DENSITY | 0.72 | Comment density | |
| COMPARISONS | 199.00 | Number of comparison operators | |
| CYCLOMATIC | 255.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 93.00 | Comments in declarations | |
| DOC_COMMENT | 517.00 | Number of javadoc comment lines | |
| ELOC | 836.00 | Effective lines of code | |
| EXEC_COMMENTS | 57.00 | Comments in executable code | |
| EXITS | 254.00 | Procedure exits | |
| FUNCTIONS | 88.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 93.36 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 205.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 3.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 1.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 2.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 13.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 1.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 2.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 1.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 2.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 1.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 6.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 1.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 2.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 1836.00 | Number of lines in the source file | |
| LINE_COMMENT | 70.00 | Number of line comments | |
| LOC | 1092.00 | Lines of code | |
| LOGICAL_LINES | 432.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 2444.00 | Number of operands | |
| OPERATORS | 5169.00 | Number of operators | |
| PARAMS | 61.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 7613.00 | Halstead program length | |
| PROGRAM_VOCAB | 789.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 144.00 | Number of return points from functions | |
| SIZE | 69900.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 733.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 56.00 | Number of unique operators | |
| WHITESPACE | 145.00 | Number of whitespace lines | |