Settlement.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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0016 | JAVA0016 Abstract class contains public constructor | |
| COMMENTS | Comment lines | |
| FUNCTIONS | Number of function declarations | |
| EXITS | Procedure exits | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| SIZE | Size of the file in bytes | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0094 | JAVA0094 Field hides a superclass field | |
| PROGRAM_VOLUME | Halstead program volume | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| BLOCKS | Number of blocks | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| RETURNS | Number of return points from functions | |
| LINES | Number of lines in the source file | |
| CYCLOMATIC | Cyclomatic complexity | |
| PARAMS | Number of formal parameter declarations | |
| 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.Iterator;
import java.util.List;
import java.util.logging.Logger;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import net.sf.freecol.FreeCol;
import net.sf.freecol.common.model.Map.Direction;
import net.sf.freecol.common.model.Map.Position;
import org.w3c.dom.Element;
/**
* The super class of all settlements on the map (that is colonies and indian settlements).
*/
abstract public class Settlement extends FreeColGameObject implements Location, Ownable {
private static final Logger logger = Logger.getLogger(Settlement.class.getName());
public static enum SettlementType {
SMALL, MEDIUM, LARGE,
SMALL_STOCKADE,
MEDIUM_STOCKADE, MEDIUM_FORT,
LARGE_STOCKADE, LARGE_FORT, LARGE_FORTRESS,
UNDEAD,
INDIAN_CAMP, INDIAN_VILLAGE, AZTEC_CITY, INCA_CITY }
public static final int RADIUS = 1;
public static final int FOOD_CONSUMPTION = 2;
public static final Modifier DEFENCE_MODIFIER =
new Modifier("model.modifier.defence", new BonusOrPenalty("modifiers.inSettlement"),
50, Modifier.Type.PERCENTAGE);
/** The <code>Player</code> owning this <code>Settlement</code>. */
protected Player owner;
/** The <code>Tile</code> where this <code>Settlement</code> is located. */
protected Tile tile;
protected GoodsContainer goodsContainer;
/**
* Contains the abilities and modifiers of this Colony.
*/
protected FeatureContainer featureContainer = new FeatureContainer();
/**
* Creates a new <code>Settlement</code>.
*
* @param game The <code>Game</code> in which this object belong.
* @param owner The owner of this <code>Settlement</code>.
* @param tile The location of the <code>Settlement</code>.
*/
public Settlement(Game game, Player owner, Tile tile) {
super(game);
this.tile = tile;
this.owner = owner;
featureContainer.addModifier(DEFENCE_MODIFIER);
Iterator<Position> exploreIt = game.getMap().getCircleIterator(tile.getPosition(), true,
getLineOfSight());
while (exploreIt.hasNext()) {
Tile t = game.getMap().getTile(exploreIt.next());
t.setExploredBy(owner, true);
}
this.tile.setExploredBy(owner, true);
owner.invalidateCanSeeTiles();
// Relocate any worker already on the Tile (from another Settlement):
if (tile.getOwningSettlement() != null) {
if (tile.getOwningSettlement() instanceof Colony) {
Colony oc = tile.getColony();
ColonyTile ct = oc.getColonyTile(tile);
ct.relocateWorkers();
} else if (tile.getOwningSettlement() instanceof IndianSettlement) {
logger.warning("An indian settlement is already owning the tile.");
} else {
logger.warning("An unknown type of settlement is already owning the tile.");
}
}
owner.addSettlement(this);
}
/**
* Initiates a new <code>Settlement</code> from an <code>Element</code>.
*
* @param game The <code>Game</code> in which this object belong.
* @param in The input stream containing the XML.
* @throws XMLStreamException if a problem was encountered
* during parsing.
*/
public Settlement(Game game, XMLStreamReader in) throws XMLStreamException {
super(game, in);
}
/**
* Initiates a new <code>Settlement</code> from an <code>Element</code>.
*
* @param game The <code>Game</code> in which this object belong.
* @param e An XML-element that will be used to initialize
* this object.
*/
public Settlement(Game game, Element e) {
super(game, e);
}
/**
* Initiates a new <code>Settlement</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 Settlement(Game game, String id) {
super(game, id);
}
/**
* Describe <code>getFeatureContainer</code> method here.
*
* @return a <code>FeatureContainer</code> value
*/
public FeatureContainer getFeatureContainer() {
return featureContainer;
}
/**
* Gets this colony's line of sight.
* @return The line of sight offered by this
* <code>Colony</code>.
* @see Player#canSee(Tile)
*/
public int getLineOfSight() {
return 2;
}
/**
* Gets the <code>Unit</code> that is currently defending this <code>Settlement</code>.
* @param attacker The target that would be attacking this <code>Settlement</code>.
* @return The <code>Unit</code> that has been chosen to defend this <code>Settlement</code>.
*/
abstract public Unit getDefendingUnit(Unit attacker);
/**
* Gets the <code>Tile</code> where this <code>Settlement</code> is located.
* @return The <code>Tile</code> where this <code>Settlement</code> is located.
*/
public Tile getTile() {
return tile;
}
/**
* Gets a <code>Tile</code> from the neighbourhood of this
* <code>Colony</code>.
*
* @param x The x-coordinate of the <code>Tile</code>.
* @param y The y-coordinate of the <code>Tile</code>.
* @return The <code>Tile</code>.
*/
public Tile getTile(int x, int y) {
if (x==0 && y==0) {
return getGame().getMap().getNeighbourOrNull(Direction.N, tile);
} else if (x==0 && y== 1) {
return getGame().getMap().getNeighbourOrNull(Direction.NE, tile);
} else if (x==0 && y== 2) {
return getGame().getMap().getNeighbourOrNull(Direction.E, tile);
} else if (x==1 && y== 0) {
return getGame().getMap().getNeighbourOrNull(Direction.NW, tile);
} else if (x==1 && y== 1) {
return tile;
} else if (x==1 && y== 2) {
return getGame().getMap().getNeighbourOrNull(Direction.SE, tile);
} else if (x==2 && y== 0) {
return getGame().getMap().getNeighbourOrNull(Direction.W, tile);
} else if (x==2 && y== 1) {
return getGame().getMap().getNeighbourOrNull(Direction.SW, tile);
} else if (x==2 && y== 2) {
return getGame().getMap().getNeighbourOrNull(Direction.S, tile);
} else {
return null;
}
}
/**
* Gets the owner of this <code>Settlement</code>.
*
* @return The owner of this <code>Settlement</code>.
* @see #setOwner
*/
public Player getOwner() {
return owner;
}
/**
* Sets the owner of this <code>Settlement</code>.
*
* @param owner The <code>Player</code> that shall own this <code>Settlement</code>.
* @see #getOwner
*/
public void setOwner(Player owner) {
Player oldOwner = this.owner;
this.owner = owner;
if (oldOwner.hasSettlement(this)) {
oldOwner.removeSettlement(this);
}
if (!owner.hasSettlement(this)) {
owner.addSettlement(this);
}
oldOwner.invalidateCanSeeTiles();
owner.setExplored(getTile());
Iterator<Position> positionIterator = getGame().getMap().getCircleIterator(getTile().getPosition(), true, getLineOfSight());
while (positionIterator.hasNext()) {
Map.Position p = positionIterator.next();
owner.setExplored(getGame().getMap().getTile(p));
}
if (getGame().getFreeColGameObjectListener() != null) {
getGame().getFreeColGameObjectListener().ownerChanged(this, oldOwner, owner);
}
}
public GoodsContainer getGoodsContainer() {
return goodsContainer;
}
/**
* Gets an <code>Iterator</code> of every <code>Goods</code> in this
* <code>GoodsContainer</code>. Each <code>Goods</code> have a maximum
* amount of 100.
*
* @return The <code>Iterator</code>.
*/
public Iterator<Goods> getGoodsIterator() {
return goodsContainer.getGoodsIterator();
}
/**
* Gets an <code>List</code> with every <code>Goods</code> in this
* <code>Colony</code>. There is only one <code>Goods</code> for each
* type of goods.
*
* @return The <code>Iterator</code>.
*/
public List<Goods> getCompactGoods() {
return goodsContainer.getCompactGoods();
}
/**
* Adds a <code>Locatable</code> to this Location.
*
* @param locatable The <code>Locatable</code> to add to this Location.
*/
public abstract void add(Locatable locatable);
/**
* Removes a <code>Locatable</code> from this Location.
*
* @param locatable The <code>Locatable</code> to remove from this Location.
*/
public abstract void remove(Locatable locatable);
public abstract boolean canAdd(Locatable locatable);
/**
* Returns the number of units in this settlement.
*
* @return The number of units in this settlement.
*/
public abstract int getUnitCount();
public abstract boolean contains(Locatable locatable);
public void dispose() {
Tile settlementTile = getTile();
Map map = getGame().getMap();
Position position = settlementTile.getPosition();
Iterator<Position> circleIterator = map.getCircleIterator(position, true, getRadius());
settlementTile.setOwner(null);
while (circleIterator.hasNext()) {
Tile tile = map.getTile(circleIterator.next());
if (tile.getOwningSettlement() == this) {
tile.setOwningSettlement(null);
tile.setOwner(null);
}
}
Player oldOwner = owner;
owner = null;
settlementTile.setSettlement(null);
oldOwner.removeSettlement(this);
oldOwner.invalidateCanSeeTiles();
goodsContainer.dispose();
super.dispose();
}
/**
* Gets the radius of what the <code>Settlement</code> considers
* as it's own land.
*
* @return Settlement radius
*/
public int getRadius() {
return Settlement.RADIUS;
}
public abstract void newTurn();
/**
* Removes a specified amount of a type of Goods from this Settlement.
*
* @param type The type of Goods to remove from this settlement.
* @param amount The amount of Goods to remove from this settlement.
*/
public void removeGoods(GoodsType type, int amount) {
goodsContainer.removeGoods(type, amount);
}
/**
* Removes the given Goods from the Settlement.
*
* @param goods a <code>Goods</code> value
*/
public void removeGoods(AbstractGoods goods) {
goodsContainer.removeGoods(goods);
}
/**
* Removes all Goods of the given type from the Settlement.
*
* @param type a <code>GoodsType</code> value
*/
public void removeGoods(GoodsType type) {
goodsContainer.removeGoods(type);
}
/**
* Describe <code>addGoods</code> method here.
*
* @param type a <code>GoodsType</code> value
* @param amount an <code>int</code> value
*/
public void addGoods(GoodsType type, int amount) {
if (type.getStoredAs() != null) {
goodsContainer.addGoods(type.getStoredAs(), amount);
} else {
goodsContainer.addGoods(type, amount);
}
}
public void addGoods(AbstractGoods goods) {
addGoods(goods.getType(), goods.getAmount());
}
/**
* Gets the amount of one type of Goods at this Settlement.
*
* @param type The type of goods to look for.
* @return The amount of this type of Goods at this Location.
*/
public int getGoodsCount(GoodsType type) {
if (type != null && type.getStoredAs() == null) {
return goodsContainer.getGoodsCount(type);
} else {
return 0;
}
}
/**
* Gives the food needed to keep all units alive in this Settlement.
*
* @return The amount of food eaten in this colony each this turn.
*/
public int getFoodConsumption() {
return FOOD_CONSUMPTION * getUnitCount();
}
protected void removeFood(final int amount) {
int rest = amount;
List<AbstractGoods> backlog = new ArrayList<AbstractGoods>();
for (GoodsType foodType : FreeCol.getSpecification().getGoodsFood()) {
int available = getGoodsCount(foodType);
if (available >= rest) {
removeGoods(foodType, rest);
for (AbstractGoods food : backlog) {
removeGoods(food.getType(), food.getAmount());
}
rest = 0;
} else {
backlog.add(new AbstractGoods(foodType, available));
rest -= available;
}
}
if (rest > 0) {
throw new IllegalStateException("Attempted to remove more food than was present.");
}
}
/**
* Returns the total amount of food present.
*
* @return an <code>int</code> value
*/
public int getFoodCount() {
int result = 0;
for (GoodsType foodType : FreeCol.getSpecification().getGoodsFood()) {
result += getGoodsCount(foodType);
}
return result;
}
/**
* Return true if this Colony could build at least one item of the
* given EquipmentType.
*
* @param equipmentType an <code>EquipmentType</code> value
* @return a <code>boolean</code> value
*/
public boolean canBuildEquipment(EquipmentType equipmentType) {
for (AbstractGoods requiredGoods : equipmentType.getGoodsRequired()) {
if (getGoodsCount(requiredGoods.getType()) < requiredGoods.getAmount()) {
return false;
}
}
return true;
}
}
The table below shows all metrics for Settlement.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 58.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 179.00 | Comment lines | |
| COMMENT_DENSITY | 1.00 | Comment density | |
| COMPARISONS | 33.00 | Number of comparison operators | |
| CYCLOMATIC | 59.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 30.00 | Comments in declarations | |
| DOC_COMMENT | 178.00 | Number of javadoc comment lines | |
| ELOC | 179.00 | Effective lines of code | |
| EXEC_COMMENTS | 1.00 | Comments in executable code | |
| EXITS | 49.00 | Procedure exits | |
| FUNCTIONS | 32.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 60.11 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 64.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 | 0.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 | 4.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 | 0.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 | 0.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 | 0.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 | 2.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 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.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 | 0.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 | 0.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 | 0.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 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 3.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 | 0.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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.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 | 1.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 | 3.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.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 | 0.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 | 476.00 | Number of lines in the source file | |
| LINE_COMMENT | 1.00 | Number of line comments | |
| LOC | 224.00 | Lines of code | |
| LOGICAL_LINES | 110.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 541.00 | Number of operands | |
| OPERATORS | 1113.00 | Number of operators | |
| PARAMS | 27.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1654.00 | Halstead program length | |
| PROGRAM_VOCAB | 264.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 37.00 | Number of return points from functions | |
| SIZE | 15264.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 216.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 73.00 | Number of whitespace lines | |