ServerModelController.java
| Index Score | ||
|---|---|---|
 |
 |
net.sf.freecol.server.control |
 |
 |
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 | |
|---|---|---|
| JAVA0143 | JAVA0143 Synchronized method |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| SIZE | Size of the file in bytes | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| EXITS | Procedure exits | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| COMPARISONS | Number of comparison operators | |
| PARAMS | Number of formal parameter declarations | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| COMMENTS | Comment lines | |
| OPERATORS | Number of operators | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| DECL_COMMENTS | Comments in declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOLUME | Halstead program volume | |
| LOGICAL_LINES | Number of statements | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LINE_COMMENT | Number of line comments | |
| BLOCKS | Number of blocks | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| ELOC | Effective lines of code | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
/**
* 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.server.control;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Logger;
import net.sf.freecol.common.PseudoRandom;
import net.sf.freecol.common.model.Building;
import net.sf.freecol.common.model.BuildingType;
import net.sf.freecol.common.model.Colony;
import net.sf.freecol.common.model.FreeColGameObject;
import net.sf.freecol.common.model.Game;
import net.sf.freecol.common.model.Location;
import net.sf.freecol.common.model.ModelController;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.Player.Stance;
import net.sf.freecol.common.model.Tile;
import net.sf.freecol.common.model.TradeRoute;
import net.sf.freecol.common.model.Unit;
import net.sf.freecol.common.model.Unit.UnitState;
import net.sf.freecol.common.model.UnitType;
import net.sf.freecol.common.networking.Connection;
import net.sf.freecol.common.networking.Message;
import net.sf.freecol.server.FreeColServer;
import net.sf.freecol.server.model.ServerPlayer;
import org.w3c.dom.Element;
/**
* A server-side implementation of the <code>ModelController</code> interface.
*/
public class ServerModelController implements ModelController {
private static final Logger logger = Logger.getLogger(ServerModelController.class.getName());
private final FreeColServer freeColServer;
private final HashMap<String, TaskEntry> taskRegister = new HashMap<String, TaskEntry>();
/**
* Creates a new <code>ServerModelController</code>.
*
* @param freeColServer The main controller.
*/
public ServerModelController(FreeColServer freeColServer) {
this.freeColServer = freeColServer;
}
/**
* Returns a pseudorandom int, uniformly distributed between 0 (inclusive)
* and the specified value (exclusive).
*
* @param taskID The <code>taskID</code> should be a unique identifier.
* One method to make a unique <code>taskID</code>: <br>
* <br>
* getId() + "methodName:taskDescription" <br>
* <br>
* As long as the "taskDescription" is unique within the method
* ("methodName"), you get a unique identifier.
* @param n The specified value.
* @return The generated number.
*/
public synchronized int getRandom(String taskID, int n) {
int turnNumber = freeColServer.getGame().getTurn().getNumber();
String extendedTaskID = taskID + Integer.toString(turnNumber);
logger.info("Entering getRandom with taskID " + taskID);
if (taskRegister.containsKey(extendedTaskID)) {
return ((Integer) taskRegister.get(extendedTaskID).entry).intValue();
} else {
int value = getPseudoRandom().nextInt(n);
taskRegister.put(extendedTaskID, new TaskEntry(extendedTaskID, turnNumber, true, new Integer(value)));
return value;
}
}
/**
* Get random number generator.
*
* @return random number generator.
*/
public PseudoRandom getPseudoRandom() {
return this.freeColServer.getPseudoRandom();
}
/**
* Removes any entries older than {@link TaskEntry#TASK_ENTRY_TIME_OUT}.
*/
public synchronized void clearTaskRegister() {
int currentTurn = freeColServer.getGame().getTurn().getNumber();
List<String> idsToRemove = new ArrayList<String>();
for (TaskEntry te : taskRegister.values()) {
if (te.hasExpired(currentTurn)) {
if (!te.isSecure()) {
logger.warning("Possibly a cheating attempt.");
}
idsToRemove.add(te.taskID);
}
}
if (!idsToRemove.isEmpty()) {
StringBuffer sb = new StringBuffer();
sb.append("Clearing the task register. Removing the following items:");
for (String id : idsToRemove) {
taskRegister.remove(id);
sb.append(" ");
sb.append(id);
}
logger.info(sb.toString());
}
}
/**
* Creates a new unit. This method is the same as running
* {@link #createUnit(String, Location, Player, UnitType, boolean, Connection)}
* with <code>secure = true</code> and <code>connection = null</code>.
*
* @param taskID The <code>taskID</code> should be a unique identifier.
* One method to make a unique <code>taskID</code>: <br>
* <br>
* getId() + "methodName:taskDescription" <br>
* br> As long as the "taskDescription" is unique within the
* method ("methodName"), you get a unique identifier.
* @param location The <code>Location</code> where the <code>Unit</code>
* will be created.
* @param owner The <code>Player</code> owning the <code>Unit</code>.
* @param type The type of unit (Unit.FREE_COLONIST...).
* @return A reference to the <code>Unit</code> which has been created.
*/
public synchronized Unit createUnit(String taskID, Location location, Player owner, UnitType type) {
return createUnit(taskID, location, owner, type, true, null);
}
/**
* Creates a new unit.
*
* @param taskID The <code>taskID</code> should be a unique identifier.
* One method to make a unique <code>taskID</code>: <br>
* <br>
* getId() + "methodName:taskDescription" <br>
* br> As long as the "taskDescription" is unique within the
* method ("methodName"), you get a unique identifier.
* @param location The <code>Location</code> where the <code>Unit</code>
* will be created.
* @param owner The <code>Player</code> owning the <code>Unit</code>.
* @param type The type of unit (Unit.FREE_COLONIST...).
* @param secure This variable should be set to <code>false</code> in case
* this method is called when serving a client. Setting this
* variable to <code>false</code> signals that the request
* might be illegal.
* @param connection The connection that has requested to create the unit,
* or null if this request is internal to the server.
* @return A reference to the <code>Unit</code> which has been created.
*/
public synchronized Unit createUnit(String taskID, Location location, Player owner, UnitType type, boolean secure,
Connection connection) {
String extendedTaskID = taskID + owner.getId()
+ Integer.toString(freeColServer.getGame().getTurn().getNumber());
Unit unit;
TaskEntry taskEntry;
logger.info("Entering createUnit.");
if (taskRegister.containsKey(extendedTaskID)) {
taskEntry = taskRegister.get(extendedTaskID);
unit = (Unit) taskEntry.entry;
if (unit.getLocation().getTile() != location.getTile() || unit.getOwner() != owner
|| unit.getType() != type) {
logger
.warning("Unsynchronization between the client and the server. Maybe a cheating attempt! Differences: "
+ ((unit.getLocation().getTile() != location.getTile()) ? "location: "
+ unit.getLocation().getTile() + "!=" + location.getTile() : "")
+ ((unit.getOwner() != owner) ? "owner: " + unit.getOwner() + "!=" + owner : "")
+ ((unit.getType() != type) ? "type: " + unit.getType() + "!=" + type : ""));
taskRegister.remove(extendedTaskID);
unit.dispose();
return null;
}
if (secure) {
taskEntry.secure = true;
}
} else {
unit = new Unit(freeColServer.getGame(), location, owner, type, UnitState.ACTIVE);
taskEntry = new TaskEntry(extendedTaskID, freeColServer.getGame().getTurn().getNumber(), secure, unit);
taskRegister.put(extendedTaskID, taskEntry);
}
/*
* if (connection != null) { update(unit,
* freeColServer.getPlayer(connection)); }
*/
return unit;
}
/**
* Creates a new building. This method is the same as running
* {@link #createBuilding(String, Colony, BuildingType, boolean, Connection)}
* with <code>secure = true</code> and <code>connection = null</code>.
*
* @param taskID The <code>taskID</code> should be a unique identifier.
* One method to make a unique <code>taskID</code>: <br>
* <br>
* getId() + "methodName:taskDescription" <br>
* <br> As long as the "taskDescription" is unique within the
* method ("methodName"), you get a unique identifier.
* @param colony The <code>Colony</code> where the <code>Building</code>
* will be created.
* @param type The type of building.
* @return A reference to the <code>Building</code> which has been created.
*/
public synchronized Building createBuilding(String taskID, Colony colony, BuildingType type) {
return createBuilding(taskID, colony, type, true, null);
}
/**
* Creates a new building.
*
* @param taskID The <code>taskID</code> should be a unique identifier.
* One method to make a unique <code>taskID</code>: <br>
* <br>
* getId() + "methodName:taskDescription" <br>
* <br> As long as the "taskDescription" is unique within the
* method ("methodName"), you get a unique identifier.
* @param colony The <code>Colony</code> where the <code>Building</code>
* will be created.
* @param type The type of building.
* @param secure This variable should be set to <code>false</code> in case
* this method is called when serving a client. Setting this
* variable to <code>false</code> signals that the request
* might be illegal.
* @param connection The connection that has requested to create the building,
* or null if this request is internal to the server.
* @return A reference to the <code>Building</code> which has been created.
*/
public synchronized Building createBuilding(String taskID, Colony colony, BuildingType type, boolean secure,
Connection connection) {
String extendedTaskID = taskID + colony.getOwner().getId()
+ Integer.toString(freeColServer.getGame().getTurn().getNumber());
Building building;
TaskEntry taskEntry;
Player owner = colony.getOwner();
logger.info("Entering createBuilding.");
if (taskRegister.containsKey(extendedTaskID)) {
taskEntry = taskRegister.get(extendedTaskID);
building = (Building) taskEntry.entry;
if (building.getColony().getTile() != colony.getTile() ||
building.getOwner() != colony.getOwner() ||
building.getType() != type) {
logger.warning("Unsynchronization between the client and the server. Maybe a cheating attempt! Differences: "
+ ((building.getColony().getTile() != colony.getTile()) ? "colony: "
+ building.getColony().getTile() + "!=" + colony.getTile() : "")
+ ((building.getOwner() != owner) ? "owner: " + building.getOwner() + "!=" + owner : "")
+ ((building.getType() != type) ? "type: " + building.getType() + "!=" + type : ""));
taskRegister.remove(extendedTaskID);
building.dispose();
return null;
}
if (secure) {
taskEntry.secure = true;
}
} else {
building = new Building(freeColServer.getGame(), colony,type);
taskEntry = new TaskEntry(extendedTaskID, freeColServer.getGame().getTurn().getNumber(), secure, building);
taskRegister.put(extendedTaskID, taskEntry);
}
/*
* if (connection != null) { update(building,
* freeColServer.getPlayer(connection)); }
*/
return building;
}
/**
* Puts the specified <code>Unit</code> in America.
*
* @param unit The <code>Unit</code>.
* @return The <code>Location</code> where the <code>Unit</code>
* appears.
*/
public synchronized Location setToVacantEntryLocation(Unit unit) {
Game game = freeColServer.getGame();
ServerPlayer player = (ServerPlayer) unit.getOwner();
Location entryLocation;
String taskID = unit.getId() + Integer.toString(freeColServer.getGame().getTurn().getNumber());
if (taskRegister.containsKey(taskID)) {
entryLocation = (Location) taskRegister.get(taskID).entry;
// taskRegister.remove(taskID);
} else {
entryLocation = unit.getVacantEntryLocation();
taskRegister.put(taskID, new TaskEntry(taskID, freeColServer.getGame().getTurn().getNumber(), true,
entryLocation));
}
unit.setLocation(entryLocation);
unit.setState(UnitState.ACTIVE);
// Display the tiles surrounding the Unit:
Element updateElement = Message.createNewRootElement("update");
List<Tile> surroundingTiles = game.getMap().getSurroundingTiles(unit.getTile(), unit.getLineOfSight());
for (int i = 0; i < surroundingTiles.size(); i++) {
Tile t = surroundingTiles.get(i);
updateElement.appendChild(t.toXMLElement(player, updateElement.getOwnerDocument()));
}
try {
player.getConnection().send(updateElement);
} catch (IOException e) {
logger.warning("Could not send message to: " + player.getName() + " with connection "
+ player.getConnection());
}
// Send update to enemy players:
update(unit.getTile(), player);
return entryLocation;
}
/**
* Sends an update of the given <code>Tile</code> to all the players.
*
* @param tile The <code>Tile</code> to be updated.
*/
public void update(Tile tile) {
update(tile, null);
}
/**
* Explores the given tiles for the given player.
*
* @param player The <code>Player</code> that should see more tiles.
* @param tiles The tiles to explore.
*/
public void exploreTiles(Player player, ArrayList<Tile> tiles) {
Element updateElement = Message.createNewRootElement("update");
for (int i = 0; i < tiles.size(); i++) {
Tile t = tiles.get(i);
t.setExploredBy(player, true);
updateElement.appendChild(t.toXMLElement(player, updateElement.getOwnerDocument()));
}
try {
((ServerPlayer) player).getConnection().send(updateElement);
} catch (IOException e) {
logger.warning("Could not send message to: " + ((ServerPlayer) player).getName() + " with connection "
+ ((ServerPlayer) player).getConnection());
}
}
/**
* Updates stances.
*
* @param first The first <code>Player</code>.
* @param second The second <code>Player</code>.
* @param stance The new stance.
*/
public void setStance(Player first, Player second, Stance stance) {
Element element = Message.createNewRootElement("setStance");
element.setAttribute("stance", stance.toString());
element.setAttribute("first", first.getId());
element.setAttribute("second", second.getId());
Iterator<Player> enemyPlayerIterator = first.getGame().getPlayerIterator();
while (enemyPlayerIterator.hasNext()) {
ServerPlayer enemyPlayer = (ServerPlayer) enemyPlayerIterator.next();
if (!enemyPlayer.equals(first)) {
try {
enemyPlayer.getConnection().send(element);
} catch (IOException e) {
logger.warning("Could not send message to: " + enemyPlayer.getName() + " with connection "
+ enemyPlayer.getConnection());
}
}
}
}
/**
* Sends an update of the given <code>Tile</code> to the other players.
*
* @param newTile The <code>Tile</code> to be updated.
* @param p The player which should not receive an update (the source of the
* change).
*/
public void update(Tile newTile, Player p) {
ServerPlayer player = (ServerPlayer) p;
Game game = freeColServer.getGame();
Iterator<Player> enemyPlayerIterator = game.getPlayerIterator();
while (enemyPlayerIterator.hasNext()) {
ServerPlayer enemyPlayer = (ServerPlayer) enemyPlayerIterator.next();
if (player != null && player.equals(enemyPlayer)) {
continue;
}
try {
if (enemyPlayer.canSee(newTile)) {
Element updateElement = Message.createNewRootElement("update");
updateElement.appendChild(newTile.toXMLElement(enemyPlayer, updateElement.getOwnerDocument()));
enemyPlayer.getConnection().send(updateElement);
}
} catch (IOException e) {
logger.warning("Could not send message to: " + enemyPlayer.getName() + " with connection "
+ enemyPlayer.getConnection());
}
}
}
/**
* Sends an update of the unit to the other players.
*
* @param unit The <code>Unit</code> to be updated.
* @param p The player which should not receive an update (the source of the
* change).
*/
public void update(Unit unit, Player p) {
ServerPlayer player = (ServerPlayer) p;
Game game = freeColServer.getGame();
Iterator<Player> enemyPlayerIterator = game.getPlayerIterator();
while (enemyPlayerIterator.hasNext()) {
ServerPlayer enemyPlayer = (ServerPlayer) enemyPlayerIterator.next();
if (player != null && player.equals(enemyPlayer)) {
continue;
}
try {
if (unit.isVisibleTo(enemyPlayer)) {
Element updateElement = Message.createNewRootElement("update");
updateElement.appendChild(unit.getTile()
.toXMLElement(enemyPlayer, updateElement.getOwnerDocument()));
enemyPlayer.getConnection().send(updateElement);
}
} catch (IOException e) {
logger.warning("Could not send message to: " + enemyPlayer.getName() + " with connection "
+ enemyPlayer.getConnection());
}
}
}
/**
* Returns a new <code>TradeRoute</code> object.
*
* @return a new <code>TradeRoute</code> object.
*/
public TradeRoute getNewTradeRoute(Player player) {
Game game = freeColServer.getGame();
String name = "";
return new TradeRoute(game, name, player);
}
/**
* Check if game object should receive newTurn call. On the server side
* all objects should get this.
*
* @param freeColGameObject The game object.
* @return true.
*/
public boolean shouldCallNewTurn(FreeColGameObject freeColGameObject) {
return true;
}
/**
* A single entry in the task register.
*/
private static class TaskEntry {
final String taskID;
final int createdTurn;
final Object entry;
private boolean secure;
TaskEntry(String taskID, int createdTurn, boolean secure, Object entry) {
this.taskID = taskID;
this.createdTurn = createdTurn;
this.secure = secure;
this.entry = entry;
}
synchronized void setSecure(boolean secure) {
this.secure = secure;
}
synchronized boolean isSecure() {
return this.secure;
}
boolean hasExpired(int currentTurn) {
return createdTurn + TASK_ENTRY_TIME_OUT < currentTurn;
}
/** The number of turns before a <code>TaskEntry</code> has expired. */
private static final int TASK_ENTRY_TIME_OUT = 5;
}
}
The table below shows all metrics for ServerModelController.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 57.00 | Number of blocks | |
| BLOCK_COMMENT | 8.00 | Number of block comment lines | |
| COMMENTS | 188.00 | Comment lines | |
| COMMENT_DENSITY | 0.82 | Comment density | |
| COMPARISONS | 57.00 | Number of comparison operators | |
| CYCLOMATIC | 58.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 20.00 | Comments in declarations | |
| DOC_COMMENT | 177.00 | Number of javadoc comment lines | |
| ELOC | 230.00 | Effective lines of code | |
| EXEC_COMMENTS | 5.00 | Comments in executable code | |
| EXITS | 66.00 | Procedure exits | |
| FUNCTIONS | 20.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 76.22 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 70.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 | 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 | 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 | 0.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 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.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 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.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 | 9.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 | 2.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 | 5.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 | 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 | 0.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 | 536.00 | Number of lines in the source file | |
| LINE_COMMENT | 3.00 | Number of line comments | |
| LOC | 280.00 | Lines of code | |
| LOGICAL_LINES | 152.00 | Number of statements | |
| LOOPS | 5.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 911.00 | Number of operands | |
| OPERATORS | 1564.00 | Number of operators | |
| PARAMS | 40.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2475.00 | Halstead program length | |
| PROGRAM_VOCAB | 293.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 30.00 | Number of return points from functions | |
| SIZE | 21549.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 251.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 42.00 | Number of unique operators | |
| WHITESPACE | 68.00 | Number of whitespace lines | |