OpenNapDownload.java
| Index Score | ||
|---|---|---|
 |
 |
org.xnap.plugin.opennap.net |
 |
|
XNap 3 |
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 | |
|---|---|---|
| EXITS | Procedure exits |  |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| CYCLOMATIC | Cyclomatic complexity | |
| LINE_COMMENT | Number of line comments | |
| DECL_COMMENTS | Comments in declarations | |
| OPERATORS | Number of operators | |
| LINES | Number of lines in the source file | |
| ELOC | Effective lines of code | |
| PROGRAM_LENGTH | Halstead program length | |
| FUNCTIONS | Number of function declarations | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| UNIQUE_OPERANDS | Number of unique operands | |
| SIZE | Size of the file in bytes | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| COMPARISONS | Number of comparison operators | |
| EXEC_COMMENTS | Comments in executable code | |
| RETURNS | Number of return points from functions | |
| JAVA0237 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0077 | JAVA0077 Private field not used in declaring class | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0113 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0143 | JAVA0143 Synchronized method | |
| JAVA0094 | JAVA0094 Field hides a superclass field | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| COMMENTS | Comment lines | |
/*
* XNap - A P2P framework and client.
*
* See the file AUTHORS for copyright information.
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.xnap.plugin.opennap.net;
import java.awt.event.ActionEvent;
import java.io.File;
import java.io.IOException;
import java.util.Hashtable;
import javax.swing.Action;
import org.apache.log4j.Logger;
import org.xnap.XNap;
import org.xnap.event.StateEvent;
import org.xnap.event.StateListener;
import org.xnap.gui.util.IconHelper;
import org.xnap.peer.Peer;
import org.xnap.plugin.Plugin;
import org.xnap.plugin.opennap.OpenNapPlugin;
import org.xnap.plugin.opennap.net.msg.ExceptionListener;
import org.xnap.plugin.opennap.net.msg.FilenameMessage;
import org.xnap.plugin.opennap.net.msg.MessageHandler;
import org.xnap.plugin.opennap.net.msg.MessageListener;
import org.xnap.plugin.opennap.net.msg.client.AltDownloadRequestMessage;
import org.xnap.plugin.opennap.net.msg.client.DownloadRequestMessage;
import org.xnap.plugin.opennap.net.msg.client.PrivateMessage;
import org.xnap.plugin.opennap.net.msg.server.AcceptFailedMessage;
import org.xnap.plugin.opennap.net.msg.server.DownloadAckMessage;
import org.xnap.plugin.opennap.net.msg.server.GetErrorMessage;
import org.xnap.plugin.opennap.net.msg.server.QueueLimitMessage;
import org.xnap.plugin.opennap.net.msg.server.ServerMessage;
import org.xnap.plugin.opennap.net.msg.server.UserSignoffMessage;
import org.xnap.plugin.opennap.net.msg.server.UserSignonMessage;
import org.xnap.transfer.AbstractTransfer;
import org.xnap.transfer.Download;
import org.xnap.transfer.Segment;
import org.xnap.transfer.action.AbstractRaisePriorityAction;
import org.xnap.transfer.action.AbstractStartAction;
import org.xnap.transfer.action.AbstractStopAction;
import org.xnap.transfer.action.AbstractTransferAction;
import org.xnap.util.FileHelper;
import org.xnap.util.FiniteStateMachine;
import org.xnap.util.IllegalOperationException;
import org.xnap.util.Scheduler;
import org.xnap.util.State;
import org.xnap.util.XNapTask;
/**
* Downloads a file.
*/
public class OpenNapDownload extends AbstractTransfer
implements Download, ExceptionListener, MessageListener, SocketListener,
StateListener {
//--- Constant(s) ---
/**
* Do not send //WantQueue more times than this. Once should be
* enough anyway. */
public static final int MAX_WANT_QUEUE = 2;
/**
* Requests are sent in this interval if this download could not
* be remotely queued. */
public static final int REQUEST_INTERVAL = 1 * 60 * 1000;
/**
* Requests are sent in REQUEST_INTERVAL * QUEUED_REQUEST_FACTOR
* if the download is remotely queued. */
public static final int QUEUED_REQUEST_FACTOR = 5;
/**
* If no reponse is received within MAX_RESPONSE_LAG milli seconds
* the peer is considered to be offline and the download is
* stopped.
*
* <p>This should be greater than REQUEST_INTERVAL *
* QUEUED_REQUEST_FACTOR. */
public static final int MAX_RESPONSE_LAG
= 2 * REQUEST_INTERVAL * QUEUED_REQUEST_FACTOR + 2 * 1000;
/**
* The maximum time to wait for a connect from the other peer in
* case of a firewalled download.
*/
public static final int WAITING_TIMEOUT = 2 * 60 * 1000;
/**
* Operation has been aborted.
*/
public static final State AQUIRING_SLOT
= new State(XNap.tr("Waiting for local download slot"));
/**
* The state transition table.
*
* <p>Once State.SUCCEEDED is entered the download was successful
* and the state will not change anymore.
*/
private static final Hashtable TRANSITION_TABLE;
static {
State[][] table = new State[][] {
{ State.NOT_STARTED, // the initial state
AQUIRING_SLOT, },
{ AQUIRING_SLOT, // aquires a slot from the local peer object
State.REQUESTING, State.STOPPING, },
{ State.REQUESTING, // sends requests by starting the requestor task
State.CONNECTING, State.FAILED, State.STOPPING, State.WAITING, },
{ State.WAITING, // in case peer is firewalled: waits for a connect
State.DOWNLOADING, State.FAILED, State.STOPPING, },
{ State.CONNECTING, // connects to peer by opening a socket
State.DOWNLOADING, State.FAILED, State.STOPPING, },
{ State.DOWNLOADING, // transfers the data
State.SUCCEEDED, State.FAILED, State.STOPPING, },
{ State.STOPPING, // user has aborted download
State.NOT_STARTED, State.FAILED, },
{ State.FAILED, // the download was stopped due to an error
// and maybe cleaned up
AQUIRING_SLOT, },
};
TRANSITION_TABLE = FiniteStateMachine.createStateTable(table);
}
//--- Data field(s) ---
private static Logger logger = Logger.getLogger(OpenNapDownload.class);
private OpenNapDownloadContainer parent;
private OpenNapSegment[] segments = new OpenNapSegment[0];
private OpenNapSegment currentSegment;
private OpenNapSearchResult result;
private StateMachine sm = new StateMachine();
private OpenNapDownloadRunner runner;
private OpenNapServer server;
private int queuePos = -1;
private DownloadSocket inSocket;
private AbstractTransferAction startAction = new StartAction();
private AbstractTransferAction stopAction = new StopAction();
private AbstractTransferAction requestAction = new RequestAction();
private long bytesTransferred = 0;
private long offset = 0;
/**
* The number of //WantQueue messages that have been sent.
*/
private int wantQueueCount = 0;
private int priority = 1;
/**
* The number of times we have waited for the peer to connect to us.
*/
private int waitingCount = 0;
/**
* The time of the answer of the last response to a download request.
*/
private long lastResponseReceived;
private long lastRequestSend;
//--- Constructor(s) ---
public OpenNapDownload(OpenNapDownloadContainer parent, OpenNapSearchResult result)
{
this.parent = parent;
this.result = result;
this.server = result.getOpenNapUser().getServer();
startAction.setEnabledLater(true);
stopAction.setEnabledLater(false);
// send whois query to update clientInfo, in case we need it later
result.getOpenNapUser().update();
}
//--- Method(s) ---
/**
* Tries to aquire a download slot. */
private void aquireDownloadSlot()
{
synchronized(getResult().getOpenNapUser()) {
if (!getResult().getOpenNapUser().isDownloadLimitReached()) {
try {
setState(State.REQUESTING);
}
catch (IllegalOperationException e) {
logger.warn("unexpected state", e);
}
}
}
}
/**
* Increased the number of transferred bytes.
*
* <p>Invoked by {@link OpenNapDownloadRunner#requestSegment()}.
*/
void commit(int bytes)
{
parent.commit(bytes);
bytesTransferred += bytes;
}
public long getBytesTransferred()
{
return bytesTransferred;
}
public Action[] getActions()
{
return new Action[] { startAction, stopAction, requestAction, };
}
public File getFile()
{
OpenNapSegment segment = getSegment();
return (segment != null) ? segment.getFile() : null;
}
public long getFilesize()
{
OpenNapSegment segment = getSegment();
return (segment != null) ? segment.getEnd() - offset : 0;
}
public Peer getPeer()
{
return getResult().getPeer();
}
public Plugin getPlugin()
{
return OpenNapPlugin.getInstance();
}
public OpenNapSearchResult getResult()
{
return result;
}
public OpenNapSegment getSegment()
{
return currentSegment;
}
public Segment[] getSegments()
{
return segments;
}
public String getStatus()
{
return sm.getDescription();
}
public long getTotalBytesTransferred()
{
return getBytesTransferred();
}
public boolean isDone()
{
State s = sm.getState();
return s == State.SUCCEEDED || s == State.FAILED;
}
public boolean isRestartable()
{
return sm.getState() != State.SUCCEEDED;
}
public boolean isRunning()
{
return sm.getState() == State.DOWNLOADING;
}
public boolean isQueued()
{
return (getQueuePosition() > 0);
}
public boolean socketReceived(IncomingSocket s)
{
if (s instanceof DownloadSocket) {
DownloadSocket d = (DownloadSocket)s;
if (getPeer().getName().equals(d.nick)
&& getResult().getFilename().equals(d.filename)) {
inSocket = d;
try {
setState(State.CONNECTING);
}
catch (IllegalOperationException e) {
logger.warn("unexpected state", e);
}
return true;
}
}
return false;
}
public int getQueuePosition()
{
return queuePos;
}
File createIncompleteFile() throws IOException
{
return FileHelper.createIncompleteFile(parent.getFilename());
}
OpenNapDownloadContainer getParent()
{
return parent;
}
OpenNapServer getServer()
{
return server;
}
/**
* Requests a segment from the parent {@link OpenNapDownloadContainer}
* and adds it to the list of segments if successful.
*
* <p>Invoked by {@link OpenNapDownloadRunner#requestSegment()}.
*
* @see #getSegments()
*/
OpenNapSegment requestSegment()
{
currentSegment = parent.getSegmentManager().requestSegment(this);
if (currentSegment != null) {
OpenNapSegment[] tmp = new OpenNapSegment[segments.length + 1];
System.arraycopy(segments, 0, tmp, 0, segments.length);
tmp[segments.length] = currentSegment;
segments = tmp;
bytesTransferred = 0;
offset = currentSegment.getStart()
+ currentSegment.getTransferred();
}
return currentSegment;
}
/**
* Clones segment and returns it to the parent
* {@link OpenNapDownloadContainer}.
*
* <p>Invoked by {@link OpenNapDownloadRunner}.
*/
void returnSegment(OpenNapSegment segment) throws IOException
{
// copy segment and trim down to transferred data
currentSegment = (OpenNapSegment)segment.clone();
segments[segments.length - 1] = currentSegment;
currentSegment.trim();
parent.getSegmentManager().returnSegment(segment);
}
void setState(State newState, String description)
{
sm.setState(newState, description);
stateChanged();
}
void setState(State newState)
{
sm.setState(newState);
stateChanged();
}
void setStateDescription(String description)
{
sm.setDescription(description);
stateChanged();
}
void setTotalMinimum(String description)
{
sm.setDescription(description);
stateChanged();
}
/**
* Invoked by {@link OpenNapDownloadContainer}.
*/
void start()
{
try {
setState(AQUIRING_SLOT);
}
catch (IllegalOperationException e) {
logger.warn("unexpected state", e);
}
}
void stop(String reason)
{
setQueuePosition(-1);
try {
setState(State.STOPPING, reason);
}
catch (IllegalOperationException e) {
// ignore exception, usually when this occurs we are
// usually already stopped and stop() is only invoked as a
// safe-guard
//logger.warn("unexpected state", e);
}
}
private void setQueuePosition(int queuePos)
{
this.queuePos = queuePos;
parent.remotelyQueued(queuePos);
}
/**
* Sends a download request.
*/
private void sendRequest()
{
DownloadRequestMessage ms = new DownloadRequestMessage
(getPeer().getName(), getResult().getFilename());
ms.setExceptionListener(this);
MessageHandler.send(getServer(), ms);
lastRequestSend = System.currentTimeMillis();
setStateDescription(XNap.tr("Requesting"));
}
/**
* Sends a '//WantQueue' message, if client is known to honor
* want queue requests.
*
* Returns true, if a download request should be sent.
*/
private boolean sendWantQueue()
{
if (wantQueueCount >= MAX_WANT_QUEUE) {
// avoid sending to many requests, some clients might not
// queue us at all or return 0 as a valid queue position
return false;
}
// some clients might obfuscate their client info so we might fail
// to recognize them as WinMX 2.6, therefore we send WantQueues
// to them too.
String client = getResult().getOpenNapUser().getClientInfo();
boolean send = false;
if (client != null) {
send |= client.startsWith("WinMX v2.6");
send |= client.startsWith("Napigator");
send |= client.startsWith("TrippyMX");
send |= client.startsWith("Utatane");
send |= wantQueueCount > 1 && client.startsWith("WinMX");
}
if (send) {
MessageHandler.send
(getServer(),
new PrivateMessage(getPeer().getName(), "//WantQueue"));
}
wantQueueCount++;
return true;
}
/**
* Invoked when the user download slot state changes.
*/
public void stateChanged(StateEvent e)
{
aquireDownloadSlot();
}
public void exceptionThrown(Exception e)
{
try {
setState(State.NOT_STARTED, e.getLocalizedMessage());
}
catch (IllegalOperationException e2) {
logger.warn("unexpected state", e2);
}
}
/**
* Handles messages received from the server as response to the download
* request. Notifies the parent download container if download is ready to
* start or if it should be removed due to an error message received from
* the server.
*/
public void messageReceived(ServerMessage m)
{
if (m instanceof FilenameMessage) {
FilenameMessage msg = (FilenameMessage)m;
if (m.getServer() == getServer()
&& msg.getFilename().equals(getResult().getFilename())
&& msg.getNick().equals(getResult().getPeer().getName())) {
// this msg is only for us
m.consume();
try {
handleMessage(m);
}
catch (IllegalOperationException e) {
logger.warn("unexpected state", e);
}
}
}
else if (m instanceof UserSignonMessage) {
// FIX: we should try again
}
else if (m instanceof UserSignoffMessage) {
if (((UserSignoffMessage)m).nick.equals
(getResult().getPeer().getName())) {
stop(XNap.tr("User is offline"));
}
}
}
/**
* @throws IllegalOperationException
*/
private void handleMessage(ServerMessage m)
{
if (m instanceof QueueLimitMessage) {
lastResponseReceived = System.currentTimeMillis();
int pos = ((QueueLimitMessage)m).maxDownloads;
if (pos == 0 || pos >= 10000) {
setQueuePosition(0);
if (sendWantQueue()) {
sendRequest();
}
}
else if (pos > 0 && pos < 10000) {
setQueuePosition(pos);
}
else { // pos < 0, should never happen
setQueuePosition(-1);
}
setStateDescription(XNap.tr("Remotely queued"));
logger.debug(getPeer().getName() + " has queued us at pos "
+ getQueuePosition());
}
else if (m instanceof AcceptFailedMessage
|| m instanceof GetErrorMessage) {
setState(State.FAILED, XNap.tr("Request was rejected"));
}
else if (m instanceof DownloadAckMessage) {
DownloadAckMessage ackMsg = (DownloadAckMessage)m;
getResult().getOpenNapUser().setHost(ackMsg.ip);
getResult().getOpenNapUser().setPort(ackMsg.port);
if (ackMsg.port != 0) {
setState(State.CONNECTING);
}
else if (getServer().getLocalPort() == 0) {
setState(State.FAILED, XNap.tr("Both parties are firewalled"));
}
else {
setState(State.WAITING, XNap.tr("Waiting for connect") + "...");
}
}
}
private void subscribe(MessageListener ms)
{
MessageHandler.subscribe(DownloadAckMessage.TYPE, ms);
MessageHandler.subscribe(QueueLimitMessage.TYPE, ms);
MessageHandler.subscribe(GetErrorMessage.TYPE, ms);
MessageHandler.subscribe(AcceptFailedMessage.TYPE, ms);
}
private void unsubscribe(MessageListener ms)
{
MessageHandler.unsubscribe(DownloadAckMessage.TYPE, ms);
MessageHandler.unsubscribe(QueueLimitMessage.TYPE, ms);
MessageHandler.unsubscribe(GetErrorMessage.TYPE, ms);
MessageHandler.unsubscribe(AcceptFailedMessage.TYPE, ms);
}
//--- Inner Class(es) ---
private class StateMachine extends FiniteStateMachine
{
//--- Data Field(s) ---
private Thread t;
private RequestorTask requestSender;
private WaitingTimeoutTask waitingTask;
//--- Constructor(s) ---
public StateMachine()
{
super(State.NOT_STARTED, TRANSITION_TABLE);
}
//--- Method(s) ---
protected synchronized void stateChanged(State oldState,
State newState)
{
if (oldState == AQUIRING_SLOT) {
getResult().getOpenNapUser().getParent().removeStateListener
(OpenNapDownload.this);
}
if (newState == AQUIRING_SLOT) {
MessageHandler.subscribe
(UserSignonMessage.TYPE, OpenNapDownload.this);
MessageHandler.subscribe
(UserSignoffMessage.TYPE, OpenNapDownload.this);
waitingCount = 0;
getResult().getOpenNapUser().getParent().addStateListener
(OpenNapDownload.this);
aquireDownloadSlot();
}
else if (newState == State.REQUESTING) {
if (!getParent().started(OpenNapDownload.this)) {
this.setState
(State.FAILED,
XNap.tr("Could not start download"));
return;
}
// initialize variables
queuePos = -1;
wantQueueCount = 0;
lastResponseReceived = System.currentTimeMillis();
subscribe(OpenNapDownload.this);
requestSender = new RequestorTask();
Scheduler.run(0, REQUEST_INTERVAL, requestSender);
startAction.setEnabledLater(false);
stopAction.setEnabledLater(true);
requestAction.setEnabledLater(true);
}
else if (newState == State.WAITING) {
getServer().getListener().addSocketListener
(OpenNapDownload.this);
AltDownloadRequestMessage msg
= new AltDownloadRequestMessage
(getPeer().getName(), getResult().getFilename());
MessageHandler.send(getServer(), msg);
waitingCount++;
waitingTask = new WaitingTimeoutTask();
Scheduler.run(WAITING_TIMEOUT, waitingTask);
}
else if (newState == State.CONNECTING) {
runner = new OpenNapDownloadRunner
(OpenNapDownload.this, inSocket);
t = new Thread(runner, "OpenNapDownload");
t.start();
}
else if (newState == State.DOWNLOADING) {
transferStarted();
parent.transferStarted();
}
else if (newState == State.STOPPING) {
if (runner != null) {
// the runner will transfer the state to NOT_STARTED
runner.stop();
t.interrupt();
}
else {
this.setState(State.NOT_STARTED, getDescription());
}
}
else if (newState == State.NOT_STARTED
|| newState == State.FAILED) {
startAction.setEnabledLater(true);
}
if (newState == State.STOPPING
|| newState == State.FAILED) {
// free the aquired local download slot
getResult().getOpenNapUser().getParent().downloadStopped();
}
if (newState == State.NOT_STARTED
|| newState == State.FAILED
|| newState == State.SUCCEEDED) {
// the download is done
runner = null;
t = null;
MessageHandler.unsubscribe
(UserSignonMessage.TYPE, OpenNapDownload.this);
MessageHandler.unsubscribe
(UserSignoffMessage.TYPE, OpenNapDownload.this);
stopAction.setEnabledLater(false);
getParent().stopped(OpenNapDownload.this);
setQueuePosition(-1);
}
if (oldState == State.REQUESTING) {
requestAction.setEnabledLater(false);
// the state could have changed to FAILED right away
// and the requestSender might not have been started
if (requestSender != null) {
requestSender.cancel();
requestSender = null;
unsubscribe(OpenNapDownload.this);
}
}
else if (oldState == State.WAITING) {
getServer().getListener().removeSocketListener
(OpenNapDownload.this);
if (waitingTask != null) {
waitingTask.cancel();
waitingTask = null;
}
}
else if (oldState == State.DOWNLOADING) {
transferStopped();
parent.transferStopped();
}
}
}
/**
* Resends the download request in regular intervals. */
private class RequestorTask extends XNapTask {
int skippedRequests = 0;
public void run()
{
if (lastResponseReceived + MAX_RESPONSE_LAG
< System.currentTimeMillis()) {
stop(XNap.tr("Request timed out."));
}
if (getQueuePosition() >= 0) {
String client = getResult().getOpenNapUser().getClientInfo();
if (client != null
&& client.startsWith("nap")) {
// nap does not support real queueing, it will
// never notify us that the slot was free
sendRequest();
}
else {
// only send request every nth time once we are queued
// to avoid superfluous server load
if (skippedRequests == QUEUED_REQUEST_FACTOR - 1) {
skippedRequests = 0;
sendRequest();
}
else {
skippedRequests++;
}
}
}
else {
sendRequest();
}
}
}
/**
* Resends the download request in regular intervals. */
private class WaitingTimeoutTask extends XNapTask {
public void run()
{
if (waitingCount < 3) {
setState(State.REQUESTING,
XNap.tr("Rerequesting, wait for connect timed out"));
}
else {
setState(State.FAILED,
XNap.tr("Giving up, wait timed out 3 times"));
}
}
}
private class RaisePriorityAction extends AbstractRaisePriorityAction {
public void actionPerformed(ActionEvent e)
{
priority += 1;
}
}
private class StartAction extends AbstractStartAction {
public void actionPerformed(ActionEvent e)
{
start();
}
}
private class StopAction extends AbstractStopAction {
public void actionPerformed(ActionEvent e)
{
stop(XNap.tr("Download stopped"));
}
}
private class RequestAction extends AbstractTransferAction {
public RequestAction()
{
putValue(Action.NAME, XNap.tr("Send Request"));
putValue(Action.SHORT_DESCRIPTION,
XNap.tr("Requeries the selected transfers."));
putValue(IconHelper.XNAP_ICON, "reload.png");
setEnabled(false);
}
public void actionPerformed(ActionEvent e)
{
sendRequest();
}
}
}
The table below shows all metrics for OpenNapDownload.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 112.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 140.00 | Comment lines | |
| COMMENT_DENSITY | 0.33 | Comment density | |
| COMPARISONS | 60.00 | Number of comparison operators | |
| CYCLOMATIC | 112.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 32.00 | Comments in declarations | |
| DOC_COMMENT | 90.00 | Number of javadoc comment lines | |
| ELOC | 426.00 | Effective lines of code | |
| EXEC_COMMENTS | 16.00 | Comments in executable code | |
| EXITS | 90.00 | Procedure exits | |
| FUNCTIONS | 49.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.56 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 78.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains non-protected 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 | 2.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 2.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 1.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 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 | 3.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.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 | 3.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 3.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 7.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 | 2.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 | 1.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1541.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 4.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 | 4.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 | 1.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 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 | |
| JAVA0289 | 3.00 | null | |
| LINES | 871.00 | Number of lines in the source file | |
| LINE_COMMENT | 32.00 | Number of line comments | |
| LOC | 596.00 | Lines of code | |
| LOGICAL_LINES | 252.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1191.00 | Number of operands | |
| OPERATORS | 2282.00 | Number of operators | |
| PARAMS | 24.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3473.00 | Halstead program length | |
| PROGRAM_VOCAB | 392.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 54.00 | Number of return points from functions | |
| SIZE | 22280.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 338.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 54.00 | Number of unique operators | |
| WHITESPACE | 135.00 | Number of whitespace lines | |