TileItemContainer.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 |  |
| EXITS | Procedure exits | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| RETURNS | Number of return points from functions | |
| BLOCKS | Number of blocks | |
| DOC_COMMENT | Number of javadoc comment lines | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| FUNCTIONS | Number of function declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| SIZE | Size of the file in bytes | |
| COMMENTS | Comment lines | |
| COMPARISONS | Number of comparison operators | |
| PARAMS | Number of formal parameter declarations | |
| LINES | Number of lines in the source file | |
| OPERATORS | Number of operators | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| NEST_DEPTH | Maximum nesting depth | |
| 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) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| 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.HashSet;
import java.util.List;
import java.util.Set;
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 org.w3c.dom.Element;
/**
* Contains <code>TileItem</code>s and can be used by a {@link Tile}
* to make certain tasks easier.
*/
public class TileItemContainer extends FreeColGameObject {
@SuppressWarnings("unused")
private static final Logger logger = Logger.getLogger(Location.class.getName());
/** The list of TileItems stored in this <code>TileItemContainer</code>. */
private final List<TileImprovement> improvements = new ArrayList<TileImprovement>();
private Resource resource = null;
/** Quick Pointers */
private TileImprovement road = null;
private TileImprovement river = null;
/** The owner of this <code>TileItemContainer</code>. */
private Tile tile;
// ------------------------------------------------------------ constructor
/**
* Creates an empty <code>TileItemContainer</code>.
*
* @param game The <code>Game</code> in which this <code>TileItemContainer</code> belong.
* @param tile The <code>Tile</code> this <code>TileItemContainer</code> will be containg TileItems for.
*/
public TileItemContainer(Game game, Tile tile) {
super(game);
if (tile == null) {
throw new IllegalArgumentException("Tile must not be 'null'.");
}
this.tile = tile;
}
/**
* Initiates a new <code>TileItemContainer</code> from an <code>Element</code>.
*
* @param game The <code>Game</code> in which this <code>TileItemContainer</code>
* belong.
* @param tile The <code>Tile</code> using this <code>TileItemContainer</code>
* for storing it's TileItem.
* @param in The input stream containing the XML.
* @throws XMLStreamException if a problem was encountered
* during parsing.
*/
public TileItemContainer(Game game, Tile tile, XMLStreamReader in) throws XMLStreamException {
super(game, in);
if (tile == null) {
throw new IllegalArgumentException("Tile must not be 'null'.");
}
this.tile = tile;
readFromXML(in);
}
/**
* Initiates a new <code>TileItemContainer</code> from an <code>Element</code>.
*
* @param game The <code>Game</code> in which this <code>TileItemContainer</code>
* belong.
* @param tile The <code>Tile</code> using this <code>TileItemContainer</code>
* for storing it's TileItem.
* @param e An XML-element that will be used to initialize
* this object.
*/
public TileItemContainer(Game game, Tile tile, Element e) {
super(game, e);
if (tile == null) {
throw new IllegalArgumentException("Tile must not be 'null'.");
}
this.tile = tile;
readFromXMLElement(e);
}
/**
* Clone functions for making a clone of this TileItemContainer
*/
public TileItemContainer clone() {
return clone(true, false);
}
public TileItemContainer clone(boolean importBonuses) {
return clone(importBonuses, false);
}
public TileItemContainer clone(boolean importBonuses, boolean copyOnlyNatural) {
TileItemContainer ticClone = new TileItemContainer(getGame(), getTile());
ticClone.copyFrom(this, importBonuses, copyOnlyNatural);
return ticClone;
}
// ------------------------------------------------------------ checking/retrieval functions
public Tile getTile() {
return tile;
}
public boolean hasRoad() {
return (road != null && road.isComplete());
}
public boolean hasRiver() {
return (river != null);
}
public boolean hasResource() {
return (resource != null);
}
public TileImprovement getRoad() {
return road;
}
public TileImprovement getRiver() {
return river;
}
public Resource getResource() {
return resource;
}
public void clearResource() {
if (hasResource()) {
resource.dispose();
resource = null;
}
}
public void clear() {
clearResource();
for (TileImprovement t : improvements) {
t.dispose();
}
improvements.clear();
road = null;
river = null;
}
/**
* Remove improvements incompatible with the given TileType. This
* method is called whenever the type of the container's tile
* changes, i.e. due to clearing.
*/
public void removeIncompatibleImprovements() {
TileType tileType = tile.getType();
Iterator<TileImprovement> improvementIterator = getImprovementIterator();
while (improvementIterator.hasNext()) {
TileImprovement improvement = improvementIterator.next();
if (!improvement.getType().isTileTypeAllowed(tileType)) {
improvementIterator.remove();
if (improvement == road) {
road = null;
} else if (improvement == river) {
river = null;
}
improvement.dispose();
}
}
// TODO: we could discover another one
clearResource();
}
/**
* Gets an <code>Iterator</code> of every <code>TileImprovement</code> in this
* <code>TileItemContainer</code>.
*
* @return The <code>Iterator</code>.
*/
public Iterator<TileImprovement> getImprovementIterator() {
return getImprovements().iterator();
}
/**
* Returns a <code>List</code> of the <code>TileImprovement</code>s
* in this <code>TileItemContainer</code>.
*
* @return The <code>List</code>.
* @see #getImprovementIterator
*/
public List<TileImprovement> getImprovements() {
return improvements;
}
/**
* Determine the total bonus from all Improvements
* @return The total bonus
*/
public int getImprovementBonusPotential(GoodsType g) {
int bonus = 0;
for (TileImprovement ti : improvements) {
bonus += ti.getBonus(g);
}
return bonus;
}
/**
* Determine the total bonus from Resource if any
* @return The total bonus
*/
public int getResourceBonusPotential(GoodsType g, int potential) {
if (hasResource()) {
potential = resource.getBonus(g, potential);
}
return potential;
}
/**
* Determine the total bonus for a GoodsType. Checks Resource and all Improvements.
* @return The total bonus
*/
public int getTotalBonusPotential(GoodsType g, int tilePotential) {
int potential = tilePotential + getImprovementBonusPotential(g);
potential = getResourceBonusPotential(g, potential);
return potential;
}
/**
* Describe <code>getProductionBonus</code> method here.
*
* @param goodsType a <code>GoodsType</code> value
* @return a <code>Modifier</code> value
*/
public Set<Modifier> getProductionBonus(GoodsType goodsType) {
Set<Modifier> result = new HashSet<Modifier>();
for (TileImprovement improvement : improvements) {
result.add(improvement.getProductionBonus(goodsType));
}
return result;
}
/**
* Determine the movement cost to this <code>Tile</code> from another <code>Tile</code>.
* Does not consider special unit abilities.
* @return The movement cost
*/
public int getMoveCost(int basicMoveCost, Tile fromTile) {
// Go through the TileImprovements to find reductions to Movement Cost
int moveCost = basicMoveCost;
for (TileImprovement ti : improvements) {
moveCost = ti.getMovementCost(moveCost, fromTile);
}
return moveCost;
}
/**
* Returns a description of the tile, with the name of the tile
* and any improvements made to it (road/plow)
* @param separator The separator to be used (e.g. "/")
* @return The description label for this tile
*/
public String getLabel(String separator) {
String label = new String();
for (TileImprovement ti : improvements) {
label += separator + Messages.message(ti.getName());
}
return label;
}
public String getLabel() {
return getLabel("/");
}
// ------------------------------------------------------------ add/remove from container
/**
* Adds a <code>TileItem</code> to this container.
* @param t The TileItem to add to this container.
* @return The added TileItem or the existing TileItem or <code>null</code> on error
*/
public TileItem addTileItem(TileItem t) {
if (t == null) {
return null;
}
if (t instanceof Resource) {
// Disposes existing resource and replaces with new one
if (resource != null) {
resource.dispose();
}
resource = (Resource) t;
return t;
} else if (t instanceof TileImprovement) {
TileImprovement improvement = (TileImprovement) t;
// Check all improvements to find any to replace
String typeId = improvement.getType().getId();
if (typeId != null) {
Iterator<TileImprovement> ti = improvements.iterator();
while (ti.hasNext()) {
TileImprovement imp = ti.next();
if (imp.getType().getId().equals(typeId)) {
if (imp.getMagnitude() < improvement.getMagnitude()) {
removeTileItem(imp);
break;
} else {
// Found it, but not replacing.
return imp;
}
}
}
}
if (improvement.isRoad()) {
road = improvement;
} else if (improvement.isRiver()) {
river = improvement;
}
improvements.add(improvement);
return improvement;
} else {
logger.warning("TileItem " + t.getClass().getSimpleName() + " has not be implemented yet.");
return null;
}
}
/**
* Removes TileItem from this container.
*
* @param t The TileItem to remove from this container.
* @return The TileItem that has been removed from this container (if any).
*/
public TileItem removeTileItem(TileItem t) {
if (t == null) {
return null;
}
if (t instanceof Resource && resource == t) {
resource = null;
return t;
} else if (t instanceof TileImprovement) {
if (river == t) {
river = null;
} else if (road == t) {
road = null;
}
return (improvements.remove(t)) ? t : null;
} else {
logger.warning("TileItem " + t.getClass().getSimpleName() + " has not be implemented yet.");
return null;
}
}
public void copyFrom(TileItemContainer tic) {
copyFrom(tic, true, false);
}
public void copyFrom(TileItemContainer tic, boolean importBonuses) {
copyFrom(tic, importBonuses, false);
}
public void copyFrom(TileItemContainer tic, boolean importBonuses, boolean copyOnlyNatural) {
clear();
if (tic.hasResource() && importBonuses) {
Resource ticR = tic.getResource();
Resource r = new Resource(getGame(), tile, ticR.getType());
r.setQuantity(ticR.getQuantity());
addTileItem(r);
}
for (TileImprovement ti : tic.getImprovements()) {
if (!copyOnlyNatural || ti.getType().isNatural()) {
TileImprovement newTI = new TileImprovement(getGame(), tile, ti.getType());
newTI.setMagnitude(ti.getMagnitude());
newTI.setStyle(ti.getStyle());
newTI.setTurnsToComplete(ti.getTurnsToComplete());
addTileItem(newTI);
}
}
}
/**
* Removes all TileItems.
*/
public void removeAll() {
clear();
}
/**
* Checks if the specified <code>TileItem</code> is in this container.
*
* @param t The <code>TileItem</code> to test the presence of.
* @return The result.
*/
public boolean contains(TileItem t) {
if (t instanceof Resource) {
return ((Resource) t) == resource;
} else if (t instanceof TileImprovement) {
return (improvements.indexOf((TileImprovement) t) >= 0);
}
return false;
}
/**
* Checks if a TileImprovement of this Type is already in this container.
*
* @param type The <code>TileImprovementType</code> to test the presence of.
* @return The result.
*/
public TileImprovement findTileImprovementType(TileImprovementType type) {
for (TileImprovement ti : improvements) {
if (ti.getType() == type) {
return ti;
}
}
return null;
}
/**
* Will check whether this tile has a completed improvement of the given
* type.
*
* Useful for checking whether the tile for instance has a road or is
* plowed.
*
* @param type
* The type to check for.
* @return Whether the tile has the improvement and the improvement is
* completed.
*/
public boolean hasImprovement(TileImprovementType type) {
TileImprovement improvement = findTileImprovementType(type);
return improvement != null && improvement.isComplete();
}
/**
* Removes all references to this object.
*/
public void dispose() {
clear();
super.dispose();
}
// ------------------------------------------------------------ manipulation methods
/**
* Creates a river <code>TileImprovement</code> and adds to this Tile/Container.
* Checking for overwrite is done by {@link #addTileItem}.
* @param magnitude The Magnitude of the river to be created
* @param style an <code>int</code> value
* @return The new river added, or the existing river TileImprovement
*/
public TileImprovement addRiver(int magnitude, int style) {
if (magnitude == TileImprovement.NO_RIVER) {
return null;
}
if (!hasRiver()) {
river = new TileImprovement(getGame(), tile, FreeCol.getSpecification()
.getTileImprovementType("model.improvement.River"));
addTileItem(river);
}
river.setMagnitude(magnitude);
river.setStyle(style);
return river;
}
/**
* Removes the river <code>TileImprovement</code> from this Tile/Container.
* Change neighbours' River Style with {@link #adjustNeighbourRiverStyle}.
*/
public TileImprovement removeRiver() {
return (TileImprovement) removeTileItem(river);
}
public int getRiverStyle() {
if (river == null) {
return 0;
}
return river.getStyle();
}
/**
* Disposes all <code>TileItem</code>s in this <code>TileItemContainer</code>.
*/
public void disposeAllTileItems() {
clear();
}
// ------------------------------------------------------------ API methods
/**
* 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.
*/
protected void toXMLImpl(XMLStreamWriter out, Player player, boolean showAll, boolean toSavedGame)
throws XMLStreamException {
// Start element:
out.writeStartElement(getXMLElementTagName());
out.writeAttribute("ID", getId());
out.writeAttribute("tile", tile.getId());
if (hasResource()) {
resource.toXML(out, player, showAll, toSavedGame);
}
Iterator<TileImprovement> ti = getImprovementIterator();
while (ti.hasNext()) {
TileImprovement t = ti.next();
t.toXML(out, player, showAll, toSavedGame);
}
out.writeEndElement();
}
/**
* Initialize this object from an XML-representation of this object.
* @param in The input stream with the XML.
*/
protected void readFromXMLImpl(XMLStreamReader in) throws XMLStreamException {
setId(in.getAttributeValue(null, "ID"));
tile = (Tile) getGame().getFreeColGameObject(in.getAttributeValue(null, "tile"));
if (tile == null) {
tile = new Tile(getGame(), in.getAttributeValue(null, "tile"));
}
improvements.clear();
while (in.nextTag() != XMLStreamConstants.END_ELEMENT) {
if (in.getLocalName().equals(Resource.getXMLElementTagName())) {
resource = (Resource) getGame().getFreeColGameObject(in.getAttributeValue(null, "ID"));
if (resource == null) {
resource = new Resource(getGame(), in);
} else {
resource.readFromXML(in);
}
} else if (in.getLocalName().equals(TileImprovement.getXMLElementTagName())) {
TileImprovement ti = (TileImprovement) getGame().getFreeColGameObject(in.getAttributeValue(null, "ID"));
if (ti == null) {
ti = new TileImprovement(getGame(), in);
improvements.add(ti);
} else {
ti.readFromXML(in);
if (!improvements.contains(ti)) {
improvements.add(ti);
}
}
if (ti.isRoad()) {
road = ti;
} else if (ti.isRiver()) {
river = ti;
}
}
}
}
/**
* Gets the tag name of the root element representing this object.
* @return "tileitemcontainer".
*/
public static String getXMLElementTagName() {
return "tileitemcontainer";
}
/**
* Creates a <code>String</code> representation of this
* <code>TileItemContainer</code>.
*/
public String toString() {
StringBuffer sb = new StringBuffer(60);
sb.append("TileItemContainer with: ");
if (hasResource()) {
sb.append(resource.toString() + ", ");
}
for (TileImprovement i : improvements) {
sb.append(i.toString() + ", ");
}
return sb.toString();
}
}
The table below shows all metrics for TileItemContainer.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 100.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 202.00 | Comment lines | |
| COMMENT_DENSITY | 0.76 | Comment density | |
| COMPARISONS | 54.00 | Number of comparison operators | |
| CYCLOMATIC | 93.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 37.00 | Comments in declarations | |
| DOC_COMMENT | 191.00 | Number of javadoc comment lines | |
| ELOC | 267.00 | Effective lines of code | |
| EXEC_COMMENTS | 6.00 | Comments in executable code | |
| EXITS | 80.00 | Procedure exits | |
| FUNCTIONS | 43.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 69.28 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 106.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 | 2.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 | 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 | 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 | 7.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 3.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 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 16.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 | 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 | 2.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 | 1.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 | 1.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 | 627.00 | Number of lines in the source file | |
| LINE_COMMENT | 11.00 | Number of line comments | |
| LOC | 355.00 | Lines of code | |
| LOGICAL_LINES | 163.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 713.00 | Number of operands | |
| OPERATORS | 1540.00 | Number of operators | |
| PARAMS | 38.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2253.00 | Halstead program length | |
| PROGRAM_VOCAB | 295.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 68.00 | Number of return points from functions | |
| SIZE | 20669.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 247.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 70.00 | Number of whitespace lines | |