NodeIPDetector.java
| Index Score | ||
|---|---|---|
 |
 |
freenet.node |
 |
 |
Freenet |
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 | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0143 | JAVA0143 Synchronized method | |
| COMPARISONS | Number of comparison operators | |
| LOGICAL_LINES | Number of statements | |
| BLOCKS | Number of blocks | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| EXITS | Procedure exits | |
| ELOC | Effective lines of code | |
| FUNCTIONS | Number of function declarations | |
| LOC | Lines of code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| OPERANDS | Number of operands | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| RETURNS | Number of return points from functions | |
| SIZE | Size of the file in bytes | |
| JAVA0267 | JAVA0267 Use of System.err | |
| LOOPS | Number of loops | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0035 | JAVA0035 Missing braces in for statement | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| LINES | Number of lines in the source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| COMMENTS | Comment lines | |
| LINE_COMMENT | Number of line comments | |
| DOC_COMMENT | Number of javadoc comment lines | |
package freenet.node;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Vector;
import freenet.config.InvalidConfigValueException;
import freenet.config.SubConfig;
import freenet.io.comm.FreenetInetAddress;
import freenet.io.comm.Peer;
import freenet.io.comm.UdpSocketHandler;
import freenet.l10n.L10n;
import freenet.node.useralerts.IPUndetectedUserAlert;
import freenet.node.useralerts.InvalidAddressOverrideUserAlert;
import freenet.node.useralerts.SimpleUserAlert;
import freenet.node.useralerts.UserAlert;
import freenet.pluginmanager.DetectedIP;
import freenet.pluginmanager.FredPluginBandwidthIndicator;
import freenet.pluginmanager.FredPluginIPDetector;
import freenet.pluginmanager.FredPluginPortForward;
import freenet.support.HTMLNode;
import freenet.support.Logger;
import freenet.support.api.BooleanCallback;
import freenet.support.api.StringCallback;
import freenet.support.transport.ip.HostnameSyntaxException;
import freenet.support.transport.ip.IPAddressDetector;
import freenet.support.transport.ip.IPUtil;
/**
* Detect the IP address of the node. Doesn't return port numbers, doesn't have access to per-port
* information (NodeCrypto - UdpSocketHandler etc).
*/
public class NodeIPDetector {
/** Parent node */
final Node node;
/** Ticker */
/** Explicit forced IP address */
FreenetInetAddress overrideIPAddress;
/** Explicit forced IP address in string form because we want to keep it even if it's invalid and therefore unused */
String overrideIPAddressString;
/** IP address from last time */
FreenetInetAddress oldIPAddress;
/** Detected IP's and their NAT status from plugins */
DetectedIP[] pluginDetectedIPs;
/** Last detected IP address */
FreenetInetAddress[] lastIPAddress;
/** The minimum reported MTU on all detected interfaces */
private int minimumMTU = Integer.MAX_VALUE;
/** IP address detector */
private final IPAddressDetector ipDetector;
/** Plugin manager for plugin IP address detectors e.g. STUN */
final IPDetectorPluginManager ipDetectorManager;
/** UserAlert shown when ipAddressOverride has a hostname/IP address syntax error */
private static InvalidAddressOverrideUserAlert invalidAddressOverrideAlert;
private boolean hasValidAddressOverride;
/** UserAlert shown when we can't detect an IP address */
private static IPUndetectedUserAlert primaryIPUndetectedAlert;
// FIXME redundant? see lastIPAddress
FreenetInetAddress[] lastIP;
/** If true, include local addresses on noderefs */
public boolean includeLocalAddressesInNoderefs;
/** Set when we have grounds to believe that we may be behind a symmetric NAT. */
boolean maybeSymmetric;
private boolean hasDetectedPM;
private boolean hasDetectedIAD;
/** Subsidiary detectors: NodeIPPortDetector's which rely on this object */
private NodeIPPortDetector[] portDetectors;
private boolean hasValidIP;
SimpleUserAlert maybeSymmetricAlert;
public NodeIPDetector(Node node) {
this.node = node;
ipDetectorManager = new IPDetectorPluginManager(node, this);
ipDetector = new IPAddressDetector(10*1000, this);
invalidAddressOverrideAlert = new InvalidAddressOverrideUserAlert(node);
primaryIPUndetectedAlert = new IPUndetectedUserAlert(node);
portDetectors = new NodeIPPortDetector[0];
}
public synchronized void addPortDetector(NodeIPPortDetector detector) {
NodeIPPortDetector[] newDetectors = new NodeIPPortDetector[portDetectors.length+1];
System.arraycopy(portDetectors, 0, newDetectors, 0, portDetectors.length);
newDetectors[portDetectors.length] = detector;
portDetectors = newDetectors;
}
/**
* What is my IP address? Use all globally available information (everything which isn't
* specific to a given port i.e. opennet or darknet) to determine our current IP addresses.
* Will include more than one IP in many cases when we are not strictly multi-homed. For
* example, if we have a DNS name set, we will usually return an IP as well.
*
* Will warn the user with a UserAlert if we don't have sufficient information.
*/
FreenetInetAddress[] detectPrimaryIPAddress() {
boolean addedValidIP = false;
Logger.minor(this, "Redetecting IPs...");
Vector addresses = new Vector();
if(overrideIPAddress != null) {
// If the IP is overridden and the override is valid, the override has to be the first element.
// overrideIPAddress will be null if the override is invalid
addresses.add(overrideIPAddress);
if(overrideIPAddress.isRealInternetAddress(false, true, false))
addedValidIP = true;
}
if(!node.dontDetect()) {
addedValidIP |= innerDetect(addresses);
}
if(node.clientCore != null) {
boolean hadValidIP;
synchronized(this) {
hadValidIP = hasValidIP;
hasValidIP = addedValidIP;
}
if(hadValidIP != addedValidIP) {
if (addedValidIP) {
onAddedValidIP();
} else {
onNotAddedValidIP();
}
}
}
synchronized(this) {
hasValidIP = addedValidIP;
}
lastIPAddress = (FreenetInetAddress[]) addresses.toArray(new FreenetInetAddress[addresses.size()]);
return lastIPAddress;
}
boolean hasValidIP() {
synchronized(this) {
return hasValidIP;
}
}
private void onAddedValidIP() {
node.clientCore.alerts.unregister(primaryIPUndetectedAlert);
node.onAddedValidIP();
}
private void onNotAddedValidIP() {
node.clientCore.alerts.register(primaryIPUndetectedAlert);
}
/**
* Core of the IP detection algorithm.
* @param addresses
* @param addedValidIP
* @return
*/
private boolean innerDetect(Vector addresses) {
boolean logMINOR = Logger.shouldLog(Logger.MINOR, this);
boolean addedValidIP = false;
InetAddress[] detectedAddrs = ipDetector.getAddress();
assert(detectedAddrs != null);
synchronized(this) {
hasDetectedIAD = true;
}
for(int i=0;i<detectedAddrs.length;i++) {
FreenetInetAddress addr = new FreenetInetAddress(detectedAddrs[i]);
if(!addresses.contains(addr)) {
Logger.normal(this, "Detected IP address: "+addr);
addresses.add(addr);
if(addr.isRealInternetAddress(false, false, false))
addedValidIP = true;
}
}
if((pluginDetectedIPs != null) && (pluginDetectedIPs.length > 0)) {
for(int i=0;i<pluginDetectedIPs.length;i++) {
InetAddress addr = pluginDetectedIPs[i].publicAddress;
if(addr == null) continue;
FreenetInetAddress a = new FreenetInetAddress(addr);
if(!addresses.contains(a)) {
Logger.normal(this, "Plugin detected IP address: "+a);
addresses.add(a);
if(a.isRealInternetAddress(false, false, false))
addedValidIP = true;
}
}
}
if((!addedValidIP) && (oldIPAddress != null) && !oldIPAddress.equals(overrideIPAddress)) {
addresses.add(oldIPAddress);
if(oldIPAddress.isRealInternetAddress(false, true, false))
addedValidIP = true;
}
// Try to pick it up from our connections
if(node.peers != null) {
PeerNode[] peerList = node.peers.connectedPeers;
HashMap countsByPeer = new HashMap();
// FIXME use a standard mutable int object, we have one somewhere
for(int i=0;i<peerList.length;i++) {
Peer p = peerList[i].getRemoteDetectedPeer();
if(p == null || p.isNull()) continue;
FreenetInetAddress addr = p.getFreenetAddress();
if(addr == null) continue;
if(!IPUtil.isValidAddress(addr.getAddress(false), false)) continue;
if(logMINOR)
Logger.minor(this, "Peer "+peerList[i].getPeer()+" thinks we are "+addr);
if(countsByPeer.containsKey(addr)) {
Integer count = (Integer) countsByPeer.get(addr);
Integer newCount = new Integer(count.intValue()+1);
countsByPeer.put(addr, newCount);
} else {
countsByPeer.put(addr, new Integer(1));
}
}
if(countsByPeer.size() == 1) {
Iterator it = countsByPeer.keySet().iterator();
FreenetInetAddress addr = (FreenetInetAddress) (it.next());
Logger.minor(this, "Everyone agrees we are "+addr);
if(!addresses.contains(addr)) {
if(addr.isRealInternetAddress(false, false, false))
addedValidIP = true;
addresses.add(addr);
}
} else if(countsByPeer.size() > 1) {
Iterator it = countsByPeer.keySet().iterator();
// Take two most popular addresses.
FreenetInetAddress best = null;
FreenetInetAddress secondBest = null;
int bestPopularity = 0;
int secondBestPopularity = 0;
while(it.hasNext()) {
FreenetInetAddress cur = (FreenetInetAddress) (it.next());
int curPop = ((Integer) (countsByPeer.get(cur))).intValue();
Logger.minor(this, "Detected peer: "+cur+" popularity "+curPop);
if(curPop >= bestPopularity) {
secondBestPopularity = bestPopularity;
bestPopularity = curPop;
secondBest = best;
best = cur;
}
}
if(best != null) {
if((bestPopularity > 1) || (detectedAddrs.length == 0)) {
if(!addresses.contains(best)) {
Logger.minor(this, "Adding best peer "+best+" ("+bestPopularity+ ')');
addresses.add(best);
if(best.isRealInternetAddress(false, false, false))
addedValidIP = true;
}
if((secondBest != null) && (secondBestPopularity > 1)) {
if(!addresses.contains(secondBest)) {
Logger.minor(this, "Adding second best peer "+secondBest+" ("+secondBest+ ')');
addresses.add(secondBest);
if(secondBest.isRealInternetAddress(false, false, false))
addedValidIP = true;
}
}
}
}
}
}
return addedValidIP;
}
private String l10n(String key) {
return L10n.getString("NodeIPDetector."+key);
}
private String l10n(String key, String pattern, String value) {
return L10n.getString("NodeIPDetector."+key, pattern, value);
}
FreenetInetAddress[] getPrimaryIPAddress() {
if(lastIPAddress == null) return detectPrimaryIPAddress();
return lastIPAddress;
}
public boolean hasDirectlyDetectedIP() {
InetAddress[] addrs = ipDetector.getAddress();
if(addrs == null || addrs.length == 0) return false;
for(int i=0;i<addrs.length;i++) {
if(IPUtil.isValidAddress(addrs[i], false)) {
if(Logger.shouldLog(Logger.MINOR, this))
Logger.minor(this, "Has a directly detected IP: "+addrs[i]);
return true;
}
}
return false;
}
/**
* Process a list of DetectedIP's from the IP detector plugin manager.
* DetectedIP's can tell us what kind of NAT we are behind as well as our public
* IP address.
*/
public void processDetectedIPs(DetectedIP[] list) {
pluginDetectedIPs = list;
for(int i=0; i<pluginDetectedIPs.length; i++){
int mtu = pluginDetectedIPs[i].mtu;
if(minimumMTU > mtu && mtu > 0){
minimumMTU = mtu;
Logger.normal(this, "Reducing the MTU to "+minimumMTU);
if(mtu < UdpSocketHandler.MIN_MTU)
node.onTooLowMTU(minimumMTU, UdpSocketHandler.MIN_MTU);
}
}
redetectAddress();
}
public void redetectAddress() {
FreenetInetAddress[] newIP = detectPrimaryIPAddress();
NodeIPPortDetector[] detectors;
synchronized(this) {
if(Arrays.equals(newIP, lastIP)) return;
lastIP = newIP;
detectors = portDetectors;
}
for(int i=0;i<detectors.length;i++)
detectors[i].update();
node.writeNodeFile();
}
public void setOldIPAddress(FreenetInetAddress freenetAddress) {
this.oldIPAddress = freenetAddress;
}
public boolean includeLocalAddressesInNoderefs() {
return includeLocalAddressesInNoderefs;
}
public int registerConfigs(SubConfig nodeConfig, int sortOrder) {
// IP address override
nodeConfig.register("ipAddressOverride", "", sortOrder++, true, false, "NodeIPDectector.ipOverride",
"NodeIPDectector.ipOverrideLong",
new StringCallback() {
public String get() {
if(overrideIPAddressString == null) return "";
else return overrideIPAddressString;
}
public void set(String val) throws InvalidConfigValueException {
boolean hadValidAddressOverride = hasValidAddressOverride();
// FIXME do we need to tell anyone?
if(val.length() == 0) {
// Set to null
overrideIPAddressString = val;
overrideIPAddress = null;
lastIPAddress = null;
redetectAddress();
return;
}
FreenetInetAddress addr;
try {
addr = new FreenetInetAddress(val, false, true);
} catch (HostnameSyntaxException e) {
throw new InvalidConfigValueException(l10n("unknownHostErrorInIPOverride", "error", "hostname or IP address syntax error"));
} catch (UnknownHostException e) {
throw new InvalidConfigValueException(l10n("unknownHostErrorInIPOverride", "error", e.getMessage()));
}
// Compare as IPs.
if(addr.equals(overrideIPAddress)) return;
overrideIPAddressString = val;
overrideIPAddress = addr;
lastIPAddress = null;
synchronized(this) {
hasValidAddressOverride = true;
}
if(!hadValidAddressOverride) {
onGetValidAddressOverride();
}
redetectAddress();
}
});
hasValidAddressOverride = true;
overrideIPAddressString = nodeConfig.getString("ipAddressOverride");
if(overrideIPAddressString.length() == 0)
overrideIPAddress = null;
else {
try {
overrideIPAddress = new FreenetInetAddress(overrideIPAddressString, false, true);
} catch (HostnameSyntaxException e) {
synchronized(this) {
hasValidAddressOverride = false;
}
String msg = "Invalid IP override syntax: "+overrideIPAddressString+" in config: "+e.getMessage();
Logger.error(this, msg);
System.err.println(msg+" but starting up anyway, ignoring the configured IP override");
overrideIPAddress = null;
} catch (UnknownHostException e) {
// **FIXME** This never happens for this reason with current FreenetInetAddress(String, boolean, boolean) code; perhaps it needs review?
String msg = "Unknown host: "+overrideIPAddressString+" in config: "+e.getMessage();
Logger.error(this, msg);
System.err.println(msg+" but starting up anyway with no IP override");
overrideIPAddress = null;
}
}
// Temporary IP address hint
nodeConfig.register("tempIPAddressHint", "", sortOrder++, true, false, "NodeIPDectector.tempAddressHint", "NodeIPDectector.tempAddressHintLong", new StringCallback() {
public String get() {
return "";
}
public void set(String val) throws InvalidConfigValueException {
if(val.length() == 0) {
return;
}
if(overrideIPAddress != null) return;
try {
oldIPAddress = new FreenetInetAddress(val, false);
} catch (UnknownHostException e) {
throw new InvalidConfigValueException("Unknown host: "+e.getMessage());
}
redetectAddress();
}
});
String ipHintString = nodeConfig.getString("tempIPAddressHint");
if(ipHintString.length() > 0) {
try {
oldIPAddress = new FreenetInetAddress(ipHintString, false);
} catch (UnknownHostException e) {
String msg = "Unknown host: "+ipHintString+" in config: "+e.getMessage();
Logger.error(this, msg);
System.err.println(msg+"");
oldIPAddress = null;
}
}
// Include local IPs in noderef file
nodeConfig.register("includeLocalAddressesInNoderefs", false, sortOrder++, true, false, "NodeIPDectector.inclLocalAddress", "NodeIPDectector.inclLocalAddressLong", new BooleanCallback() {
public Boolean get() {
return includeLocalAddressesInNoderefs;
}
public void set(Boolean val) throws InvalidConfigValueException {
includeLocalAddressesInNoderefs = val;
lastIPAddress = null;
ipDetector.clearCached();
}
});
includeLocalAddressesInNoderefs = nodeConfig.getBoolean("includeLocalAddressesInNoderefs");
return sortOrder;
}
/** Start all IP detection related processes */
public void start() {
boolean haveValidAddressOverride = hasValidAddressOverride();
if(!haveValidAddressOverride) {
onNotGetValidAddressOverride();
}
ipDetectorManager.start();
node.executor.execute(ipDetector, "IP address re-detector");
redetectAddress();
// 60 second delay for inserting ARK to avoid reinserting more than necessary if we don't detect IP on startup.
// Not a FastRunnable as it can take a while to start the insert
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
NodeIPPortDetector[] detectors;
synchronized(this) {
detectors = portDetectors;
}
for(int i=0;i<detectors.length;i++)
detectors[i].startARK();
}
}, 60*1000);
}
public void onConnectedPeer() {
ipDetectorManager.maybeRun();
}
public void registerIPDetectorPlugin(FredPluginIPDetector detector) {
ipDetectorManager.registerDetectorPlugin(detector);
}
public void unregisterIPDetectorPlugin(FredPluginIPDetector detector) {
ipDetectorManager.unregisterDetectorPlugin(detector);
}
public synchronized boolean isDetecting() {
return !(hasDetectedPM && hasDetectedIAD);
}
void hasDetectedPM() {
synchronized(this) {
hasDetectedPM = true;
}
}
public int getMinimumDetectedMTU() {
return minimumMTU > 0 ? minimumMTU : 1500;
}
public void setMaybeSymmetric() {
if(ipDetectorManager != null && ipDetectorManager.isEmpty()) {
if(maybeSymmetricAlert == null) {
maybeSymmetricAlert = new SimpleUserAlert(true, l10n("maybeSymmetricTitle"),
l10n("maybeSymmetric"), l10n("maybeSymmetricShort"), UserAlert.ERROR);
}
if(node.clientCore != null && node.clientCore.alerts != null)
node.clientCore.alerts.register(maybeSymmetricAlert);
} else {
if(maybeSymmetricAlert != null)
node.clientCore.alerts.unregister(maybeSymmetricAlert);
}
}
public void registerPortForwardPlugin(FredPluginPortForward forward) {
ipDetectorManager.registerPortForwardPlugin(forward);
}
public void unregisterPortForwardPlugin(FredPluginPortForward forward) {
ipDetectorManager.unregisterPortForwardPlugin(forward);
}
//TODO: ugly: deal with multiple instances properly
public synchronized void registerBandwidthIndicatorPlugin(FredPluginBandwidthIndicator indicator) {
bandwidthIndicator = indicator;
}
public synchronized void unregisterBandwidthIndicatorPlugin(FredPluginBandwidthIndicator indicator) {
bandwidthIndicator = null;
}
public synchronized FredPluginBandwidthIndicator getBandwidthIndicator() {
return bandwidthIndicator;
}
private FredPluginBandwidthIndicator bandwidthIndicator;
boolean hasValidAddressOverride() {
synchronized(this) {
return hasValidAddressOverride;
}
}
private void onGetValidAddressOverride() {
node.clientCore.alerts.unregister(invalidAddressOverrideAlert);
}
private void onNotGetValidAddressOverride() {
node.clientCore.alerts.register(invalidAddressOverrideAlert);
}
public void addConnectionTypeBox(HTMLNode contentNode) {
ipDetectorManager.addConnectionTypeBox(contentNode);
}
}
The table below shows all metrics for NodeIPDetector.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 99.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 55.00 | Comment lines | |
| COMMENT_DENSITY | 0.15 | Comment density | |
| COMPARISONS | 73.00 | Number of comparison operators | |
| CYCLOMATIC | 117.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 22.00 | Comments in declarations | |
| DOC_COMMENT | 39.00 | Number of javadoc comment lines | |
| ELOC | 356.00 | Effective lines of code | |
| EXEC_COMMENTS | 12.00 | Comments in executable code | |
| EXITS | 67.00 | Procedure exits | |
| FUNCTIONS | 40.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 80.93 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 73.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.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 | 1.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 | 24.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 2.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 | 2.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 | 1.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 19.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 | 2.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 | 5.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 4.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1345.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 | 1.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 | 4.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 2.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 1.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 | 3.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 7.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 | 556.00 | Number of lines in the source file | |
| LINE_COMMENT | 16.00 | Number of line comments | |
| LOC | 446.00 | Lines of code | |
| LOGICAL_LINES | 248.00 | Number of statements | |
| LOOPS | 8.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 949.00 | Number of operands | |
| OPERATORS | 2008.00 | Number of operators | |
| PARAMS | 21.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2957.00 | Halstead program length | |
| PROGRAM_VOCAB | 350.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 52.00 | Number of return points from functions | |
| SIZE | 18766.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 299.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 51.00 | Number of unique operators | |
| WHITESPACE | 55.00 | Number of whitespace lines | |