Announcer.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 | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| OPERATORS | Number of operators | |
| BLOCKS | Number of blocks | |
| COMPARISONS | Number of comparison operators | |
| RETURNS | Number of return points from functions | |
| PROGRAM_LENGTH | Halstead program length | |
| LOGICAL_LINES | Number of statements | |
| LINE_COMMENT | Number of line comments | |
| ELOC | Effective lines of code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOC | Lines of code | |
| JAVA0143 | JAVA0143 Synchronized method | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| EXITS | Procedure exits | |
| FUNCTIONS | Number of function declarations | |
| OPERANDS | Number of operands | |
| SIZE | Size of the file in bytes | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINES | Number of lines in the source file | |
| JAVA0170 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0266 | JAVA0266 Use of System.out | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0267 | JAVA0267 Use of System.err | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0035 | JAVA0035 Missing braces in for statement | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LOOPS | Number of loops | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| COMMENTS | Comment lines | |
| WHITESPACE | Number of whitespace lines | |
/* This code is part of Freenet. It is distributed under the GNU General
* Public License, version 2 (or at your option any later version). See
* http://www.gnu.org/ for further details of the GPL. */
package freenet.node;
import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.EOFException;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.InetAddress;
import java.util.HashSet;
import java.util.Vector;
import freenet.io.comm.PeerParseException;
import freenet.io.comm.ReferenceSignatureVerificationException;
import freenet.l10n.L10n;
import freenet.node.useralerts.SimpleUserAlert;
import freenet.node.useralerts.UserAlert;
import freenet.support.ByteArrayWrapper;
import freenet.support.HTMLNode;
import freenet.support.Logger;
import freenet.support.SimpleFieldSet;
import freenet.support.TimeUtil;
import freenet.support.io.Closer;
import freenet.support.transport.ip.IPUtil;
/**
* Decide whether to announce, and announce if necessary to a node in the
* routing table, or to a seednode.
* @author toad
*/
public class Announcer {
private static boolean logMINOR;
private final Node node;
private final OpennetManager om;
private static int status;
private static final int STATUS_LOADING = 0;
private static final int STATUS_CONNECTING_SEEDNODES = 1;
private static final int STATUS_NO_SEEDNODES = -1;
private int runningAnnouncements;
/** We want to announce to 5 different seednodes. */
private static final int WANT_ANNOUNCEMENTS = 5;
private int sentAnnouncements;
private long startTime;
private long timeAddedSeeds;
static final long MIN_ADDED_SEEDS_INTERVAL = 60*1000;
/** After we have sent 3 announcements, wait for 30 seconds before sending 3 more if we still have no connections. */
static final int COOLING_OFF_PERIOD = 30*1000;
/** Identities of nodes we have announced to */
private final HashSet announcedToIdentities;
/** IPs of nodes we have announced to. Maybe this should be first-two-bytes, but I'm not sure how to do that with IPv6. */
private final HashSet announcedToIPs;
/** How many nodes to connect to at once? */
static final int CONNECT_AT_ONCE = 15;
/** Do not announce if there are more than this many opennet peers connected */
private static final int MIN_OPENNET_CONNECTED_PEERS = 10;
private static final long NOT_ALL_CONNECTED_DELAY = 60*1000;
/** Identities of nodes we have tried to connect to */
private final HashSet connectedToIdentities;
/** Total nodes added by announcement so far */
private int announcementAddedNodes;
/** Total nodes that didn't want us so far */
private int announcementNotWantedNodes;
Announcer(OpennetManager om) {
this.om = om;
this.node = om.node;
announcedToIdentities = new HashSet();
announcedToIPs = new HashSet();
connectedToIdentities = new HashSet();
logMINOR = Logger.shouldLog(Logger.MINOR, this);
}
public void start() {
if(!node.isOpennetEnabled()) return;
registerAlert();
if(node.peers.getDarknetPeers().length + node.peers.getOpennetPeers().length + om.countOldOpennetPeers() == 0) {
// We know opennet is enabled.
// We have no peers AT ALL.
// So lets connect to a few seednodes, and attempt an announcement.
System.err.println("Attempting announcement to seednodes...");
synchronized(this) {
status = STATUS_LOADING;
}
connectSomeSeednodes();
} else {
// Wait a minute, then check whether we need to seed.
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
try {
maybeSendAnnouncement();
} catch (Throwable t) {
Logger.error(this, "Caught "+t+" trying to send announcements", t);
}
}
}, MIN_ADDED_SEEDS_INTERVAL);
}
}
private void registerAlert() {
node.clientCore.alerts.register(new AnnouncementUserAlert());
}
private void connectSomeSeednodes() {
if(!node.isOpennetEnabled()) return;
boolean announceNow = false;
if(logMINOR)
Logger.minor(this, "Connecting some seednodes...");
Vector/*<SimpleFieldSet>*/ seeds = Announcer.readSeednodes(node.nodeDir);
long now = System.currentTimeMillis();
synchronized(this) {
if(now - timeAddedSeeds < MIN_ADDED_SEEDS_INTERVAL) return;
timeAddedSeeds = now;
if(seeds.size() == 0) {
status = STATUS_NO_SEEDNODES;
return;
} else {
status = STATUS_CONNECTING_SEEDNODES;
}
}
// Try to connect to some seednodes.
// Once they are connected they will report back and we can attempt an announcement.
int count = connectSomeNodesInner(seeds);
synchronized(this) {
if(logMINOR)
Logger.minor(this, "count = "+count+" connected = "+connectedToIdentities.size()+
" announced = "+announcedToIdentities.size()+" running = "+runningAnnouncements);
if(count == 0 && runningAnnouncements == 0) {
if(connectedToIdentities.size() > announcedToIdentities.size()) {
// Some seednodes we haven't been able to connect to yet.
// Give it another minute, then clear all and try again.
if(logMINOR)
Logger.minor(this, "Will clear announced-to in 1 minute...");
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
if(logMINOR)
Logger.minor(this, "Clearing old announced-to list");
synchronized(Announcer.this) {
if(runningAnnouncements != 0) return;
announcedToIdentities.clear();
announcedToIPs.clear();
connectedToIdentities.clear();
}
maybeSendAnnouncement();
}
}, NOT_ALL_CONNECTED_DELAY);
} else if(connectedToIdentities.size() == announcedToIdentities.size()) {
// Clear it now
announcedToIdentities.clear();
announcedToIPs.clear();
connectedToIdentities.clear();
announceNow = true;
}
}
}
node.dnsr.forceRun();
// If none connect in a minute, try some more.
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
try {
maybeSendAnnouncement();
} catch (Throwable t) {
Logger.error(this, "Caught "+t+" trying to send announcements", t);
}
}
}, announceNow ? 0 : MIN_ADDED_SEEDS_INTERVAL);
}
// Synchronize to protect announcedToIdentities and prevent running in parallel.
private synchronized int connectSomeNodesInner(Vector seeds) {
if(logMINOR)
Logger.minor(this, "Connecting some seednodes from "+seeds.size());
int count = 0;
while(count < CONNECT_AT_ONCE) {
if(seeds.size() == 0) break;
SimpleFieldSet fs = (SimpleFieldSet) seeds.remove(node.random.nextInt(seeds.size()));
try {
SeedServerPeerNode seed =
new SeedServerPeerNode(fs, node, om.crypto, node.peers, false, om.crypto.packetMangler);
if(announcedToIdentities.contains(new ByteArrayWrapper(seed.identity))) {
if(logMINOR)
Logger.minor(this, "Not adding: already announced-to: "+seed.userToString());
continue;
}
if(logMINOR)
Logger.minor(this, "Trying to connect to seednode "+seed);
if(node.peers.addPeer(seed)) {
count++;
connectedToIdentities.add(new ByteArrayWrapper(seed.identity));
if(logMINOR)
Logger.minor(this, "Connecting to seednode "+seed);
} else {
if(logMINOR)
Logger.minor(this, "Not connecting to seednode "+seed);
}
} catch (FSParseException e) {
Logger.error(this, "Invalid seed in file: "+e+" for\n"+fs, e);
continue;
} catch (PeerParseException e) {
Logger.error(this, "Invalid seed in file: "+e+" for\n"+fs, e);
continue;
} catch (ReferenceSignatureVerificationException e) {
Logger.error(this, "Invalid seed in file: "+e+" for\n"+fs, e);
continue;
}
}
return count;
}
public static Vector readSeednodes(File nodeDir) {
File file = new File(nodeDir, "seednodes.fref");
Vector list = new Vector();
FileInputStream fis = null;
try {
fis = new FileInputStream(file);
BufferedInputStream bis = new BufferedInputStream(fis);
InputStreamReader isr = new InputStreamReader(bis, "UTF-8");
BufferedReader br = new BufferedReader(isr);
while(true) {
try {
SimpleFieldSet fs = new SimpleFieldSet(br, false, false);
if(!fs.isEmpty())
list.add(fs);
} catch (EOFException e) {
return list;
}
}
} catch (IOException e) {
return list;
} finally {
Closer.close(fis);
}
}
public void stop() {
// Do nothing at present
}
private long timeGotEnoughPeers = -1;
private boolean killedAnnouncementTooOld;
/** @return True if we have enough peers that we don't need to announce. */
boolean enoughPeers() {
// Do we want to send an announcement to the node?
int opennetCount = node.peers.countConnectedOpennetPeers();
// First, do we actually need to announce?
int target = Math.min(MIN_OPENNET_CONNECTED_PEERS, om.getNumberOfConnectedPeersToAim() / 2);
if(opennetCount >= target) {
if(logMINOR)
Logger.minor(this, "We have enough opennet peers: "+opennetCount+" > "+target+" since "+(System.currentTimeMillis()-timeGotEnoughPeers)+" ms");
synchronized(this) {
if(timeGotEnoughPeers <= 0)
timeGotEnoughPeers = System.currentTimeMillis();
}
return true;
}
if(node.nodeUpdater == null || (!node.nodeUpdater.isEnabled()) ||
(node.nodeUpdater.canUpdateNow() && !node.nodeUpdater.isArmed())) {
// If we also have 10 TOO_NEW peers, we should shut down the announcement,
// because we're obviously broken and would only be spamming the seednodes
if(node.peers.getPeerNodeStatusSize(PeerManager.PEER_NODE_STATUS_TOO_NEW, true) +
node.peers.getPeerNodeStatusSize(PeerManager.PEER_NODE_STATUS_TOO_NEW, false) > 10) {
synchronized(this) {
if(killedAnnouncementTooOld) return true;
killedAnnouncementTooOld = true;
}
Logger.error(this, "Shutting down announcement as we are older than the current mandatory build and auto-update is disabled or waiting for user input.");
System.err.println("Shutting down announcement as we are older than the current mandatory build and auto-update is disabled or waiting for user input.");
if(node.clientCore != null)
node.clientCore.alerts.register(new SimpleUserAlert(false, l10n("announceDisabledTooOldTitle"), l10n("announceDisabledTooOld"), l10n("announceDisabledTooOldShort"), UserAlert.CRITICAL_ERROR));
return true;
}
}
synchronized(this) {
timeGotEnoughPeers = -1;
}
return false;
}
/**
* Get the earliest time at which we had enough opennet peers. This is reset when we drop
* below the threshold.
*/
synchronized long timeGotEnoughPeers() {
return timeGotEnoughPeers;
}
private boolean ignoreIPUndetected;
static final int FORCE_ANNOUNCEMENT_NO_IP = 120*1000;
/** 1 minute after we have enough peers, remove all seednodes left (presumably disconnected ones) */
static final int FINAL_DELAY = 60*1000;
/** But if we don't have enough peers at that point, wait another minute and if the situation has not improved, reannounce. */
static final int RETRY_DELAY = 60*1000;
private boolean started = false;
public void maybeSendAnnouncement() {
started = true;
logMINOR = Logger.shouldLog(Logger.MINOR, this);
if(logMINOR)
Logger.minor(this, "maybeSendAnnouncement()");
long now = System.currentTimeMillis();
if(!node.isOpennetEnabled()) return;
if(enoughPeers()) {
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
synchronized(Announcer.this) {
if(runningAnnouncements > 0) return;
}
if(enoughPeers()) {
for(SeedServerPeerNode pn : node.peers.getConnectedSeedServerPeersVector(null)) {
node.peers.disconnect(pn, true, true);
}
// Re-check every minute. Something bad might happen (e.g. cpu starvation), causing us to have to reseed.
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
maybeSendAnnouncement();
}
}, RETRY_DELAY);
} else {
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
maybeSendAnnouncement();
}
}, RETRY_DELAY);
maybeSendAnnouncement();
}
}
}, FINAL_DELAY);
return;
}
if((!ignoreIPUndetected) && (!node.ipDetector.hasValidIP())) {
if(node.ipDetector.ipDetectorManager.hasDetectors()) {
// Wait a bit
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
synchronized(Announcer.this) {
if(ignoreIPUndetected) return;
ignoreIPUndetected = true;
}
maybeSendAnnouncement();
}
}, FORCE_ANNOUNCEMENT_NO_IP);
return;
}
}
synchronized(this) {
// Double check after taking the lock.
if(enoughPeers()) return;
// Second, do we have many announcements running?
if(runningAnnouncements > WANT_ANNOUNCEMENTS) {
if(logMINOR)
Logger.minor(this, "Running announcements already");
return;
}
// In cooling-off period?
if(System.currentTimeMillis() < startTime) {
if(logMINOR)
Logger.minor(this, "In cooling-off period for next "+TimeUtil.formatTime(startTime - System.currentTimeMillis()));
return;
}
if(sentAnnouncements >= WANT_ANNOUNCEMENTS) {
if(logMINOR)
Logger.minor(this, "Sent enough announcements");
return;
}
// Now find a node to announce to
Vector<SeedServerPeerNode> seeds = node.peers.getConnectedSeedServerPeersVector(announcedToIdentities);
while(sentAnnouncements < WANT_ANNOUNCEMENTS) {
if(seeds.isEmpty()) {
if(logMINOR)
Logger.minor(this, "No more seednodes, announcedTo = "+announcedToIdentities.size());
break;
}
final SeedServerPeerNode seed = seeds.remove(node.random.nextInt(seeds.size()));
InetAddress[] addrs = seed.getInetAddresses();
if(!newAnnouncedIPs(addrs)) {
if(logMINOR)
Logger.minor(this, "Not announcing to "+seed+" because already used those IPs");
continue;
}
addAnnouncedIPs(addrs);
sentAnnouncements++;
runningAnnouncements++;
announcedToIdentities.add(new ByteArrayWrapper(seed.getIdentity()));
sendAnnouncement(seed);
}
if(runningAnnouncements >= WANT_ANNOUNCEMENTS) {
if(logMINOR)
Logger.minor(this, "Running "+runningAnnouncements+" announcements");
return;
}
// Do we want to connect some more seednodes?
if(now - timeAddedSeeds < MIN_ADDED_SEEDS_INTERVAL) {
// Don't connect seednodes yet
Logger.minor(this, "Waiting for MIN_ADDED_SEEDS_INTERVAL");
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
try {
maybeSendAnnouncement();
} catch (Throwable t) {
Logger.error(this, "Caught "+t+" trying to send announcements", t);
}
}
}, (timeAddedSeeds + MIN_ADDED_SEEDS_INTERVAL) - now);
return;
}
}
connectSomeSeednodes();
}
private synchronized void addAnnouncedIPs(InetAddress[] addrs) {
for(int i=0;i<addrs.length;i++)
announcedToIPs.add(addrs[i]);
}
/**
* Have we already announced to this node?
* Return true if the node has new non-local addresses we haven't announced to.
* Return false if the node has non-local addresses we have announced to.
* Return true if the node has no non-local addresses.
* @param addrs
* @return
*/
private synchronized boolean newAnnouncedIPs(InetAddress[] addrs) {
boolean hasNonLocalAddresses = false;
for(int i=0;i<addrs.length;i++) {
if(!IPUtil.isValidAddress(addrs[i], false))
continue;
hasNonLocalAddresses = true;
if(!announcedToIPs.contains(addrs[i]))
return true;
}
return !hasNonLocalAddresses;
}
public void sendAnnouncement(final SeedServerPeerNode seed) {
if(!node.isOpennetEnabled()) {
if(logMINOR)
Logger.minor(this, "Not announcing to "+seed+" because opennet is disabled");
return;
}
System.out.println("Announcement to "+seed.userToString()+" starting...");
if(logMINOR)
Logger.minor(this, "Announcement to "+seed.userToString()+" starting...");
AnnounceSender sender = new AnnounceSender(node.getLocation(), om, node, new AnnouncementCallback() {
private int totalAdded;
private int totalNotWanted;
public void addedNode(PeerNode pn) {
synchronized(Announcer.this) {
announcementAddedNodes++;
totalAdded++;
}
Logger.normal(this, "Announcement to "+seed.userToString()+" added node "+pn+" for a total of "+announcementAddedNodes+" ("+totalAdded+" from this announcement)");
System.out.println("Announcement to "+seed.userToString()+" added node "+pn.userToString()+'.');
return;
}
public void bogusNoderef(String reason) {
Logger.normal(this, "Announcement to "+seed.userToString()+" got bogus noderef: "+reason, new Exception("debug"));
}
public void completed() {
synchronized(Announcer.this) {
runningAnnouncements--;
Logger.normal(this, "Announcement to "+seed.userToString()+" completed, now running "+runningAnnouncements+" announcements");
if(runningAnnouncements == 0) {
startTime = System.currentTimeMillis() + COOLING_OFF_PERIOD;
sentAnnouncements = 0;
// Wait for COOLING_OFF_PERIOD before trying again
node.getTicker().queueTimedJob(new Runnable() {
public void run() {
maybeSendAnnouncement();
}
}, COOLING_OFF_PERIOD);
}
}
// If it takes more than COOLING_OFF_PERIOD to disconnect, we might not be able to reannounce to this
// node. However, we can't reannounce to it anyway until announcedTo is cleared, which probably will
// be more than that period in the future.
node.peers.disconnect(seed, true, false);
System.out.println("Announcement to "+seed.userToString()+" completed.");
}
public void nodeFailed(PeerNode pn, String reason) {
Logger.normal(this, "Announcement to node "+pn.userToString()+" failed: "+reason);
}
public void noMoreNodes() {
Logger.normal(this, "Announcement to "+seed.userToString()+" ran out of nodes (route not found)");
}
public void nodeNotWanted() {
synchronized(Announcer.this) {
announcementNotWantedNodes++;
totalNotWanted++;
}
Logger.normal(this, "Announcement to "+seed.userToString()+" returned node not wanted for a total of "+announcementNotWantedNodes+" ("+totalNotWanted+" from this announcement)");
}
public void nodeNotAdded() {
Logger.normal(this, "Announcement to "+seed.userToString()+" : node not wanted (maybe already have it, opennet just turned off, etc)");
}
}, seed);
node.executor.execute(sender, "Announcer to "+seed);
}
public class AnnouncementUserAlert implements UserAlert {
public String dismissButtonText() {
return L10n.getString("UserAlert.hide");
}
public HTMLNode getHTMLText() {
return new HTMLNode("#", getText());
}
public short getPriorityClass() {
return UserAlert.ERROR;
}
public String getText() {
StringBuffer sb = new StringBuffer();
sb.append(l10n("announceAlertIntro"));
int status;
synchronized(this) {
status = Announcer.this.status;
}
if(status == STATUS_NO_SEEDNODES) {
return l10n("announceAlertNoSeednodes");
}
if(status == STATUS_LOADING) {
return l10n("announceLoading");
}
if(node.clientCore.isAdvancedModeEnabled()) {
// Detail
sb.append(' ');
int addedNodes;
int refusedNodes;
int recentSentAnnouncements;
int runningAnnouncements;
int connectedSeednodes = 0;
int disconnectedSeednodes = 0;
long coolingOffSeconds = Math.max(0, startTime - System.currentTimeMillis()) / 1000;
synchronized(this) {
addedNodes = announcementAddedNodes;
refusedNodes = announcementNotWantedNodes;
recentSentAnnouncements = sentAnnouncements;
runningAnnouncements = Announcer.this.runningAnnouncements;
}
Vector nodes = node.peers.getSeedServerPeersVector();
for(int i=0;i<nodes.size();i++) {
SeedServerPeerNode seed = (SeedServerPeerNode) nodes.get(i);
if(seed.isConnected())
connectedSeednodes++;
else
disconnectedSeednodes++;
}
sb.append(l10n("announceDetails",
new String[] { "addedNodes", "refusedNodes", "recentSentAnnouncements", "runningAnnouncements", "connectedSeednodes", "disconnectedSeednodes" },
new String[] {
Integer.toString(addedNodes),
Integer.toString(refusedNodes),
Integer.toString(recentSentAnnouncements),
Integer.toString(runningAnnouncements),
Integer.toString(connectedSeednodes),
Integer.toString(disconnectedSeednodes)
}));
if(coolingOffSeconds > 0) {
sb.append(' ');
sb.append(l10n("coolingOff", "time", Long.toString(coolingOffSeconds)));
}
}
return sb.toString();
}
public String getTitle() {
return l10n("announceAlertTitle");
}
public Object getUserIdentifier() {
return null;
}
public boolean isValid() {
return started && (!enoughPeers()) && node.isOpennetEnabled();
}
public void isValid(boolean validity) {
// Ignore
}
public void onDismiss() {
// Ignore
}
public boolean shouldUnregisterOnDismiss() {
return true;
}
public boolean userCanDismiss() {
return true;
}
public String anchor() {
return "announcer:"+hashCode();
}
public String getShortText() {
return l10n("announceAlertShort");
}
public boolean isEventNotification() {
return false;
}
}
private String l10n(String key) {
return L10n.getString("Announcer."+key);
}
public String l10n(String key, String[] patterns, String[] values) {
return L10n.getString("Announcer."+key, patterns, values);
}
public String l10n(String key, String pattern, String value) {
return L10n.getString("Announcer."+key, pattern, value);
}
}
The table below shows all metrics for Announcer.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 113.00 | Number of blocks | |
| BLOCK_COMMENT | 3.00 | Number of block comment lines | |
| COMMENTS | 63.00 | Comment lines | |
| COMMENT_DENSITY | 0.15 | Comment density | |
| COMPARISONS | 80.00 | Number of comparison operators | |
| CYCLOMATIC | 129.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 17.00 | Comments in declarations | |
| DOC_COMMENT | 29.00 | Number of javadoc comment lines | |
| ELOC | 425.00 | Effective lines of code | |
| EXEC_COMMENTS | 23.00 | Comments in executable code | |
| EXITS | 75.00 | Procedure exits | |
| FUNCTIONS | 46.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 84.00 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 88.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 | 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 | 36.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 1.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 | 1.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 | 1.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 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.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 | 7.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.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 | 1.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 | 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 | 4.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 10.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1876.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 | 3.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 3.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 | 5.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 2.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 | 0.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 | 2.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 3.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 2.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 2.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 | 635.00 | Number of lines in the source file | |
| LINE_COMMENT | 31.00 | Number of line comments | |
| LOC | 526.00 | Lines of code | |
| LOGICAL_LINES | 266.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1092.00 | Number of operands | |
| OPERATORS | 2414.00 | Number of operators | |
| PARAMS | 18.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3506.00 | Halstead program length | |
| PROGRAM_VOCAB | 420.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 70.00 | Number of return points from functions | |
| SIZE | 21678.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 364.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 56.00 | Number of unique operators | |
| WHITESPACE | 46.00 | Number of whitespace lines | |