OpenNapDownloadContainer.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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| EXITS | Procedure exits | |
| FUNCTIONS | Number of function declarations | |
| BLOCKS | Number of blocks | |
| JAVA0143 | JAVA0143 Synchronized method | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOC | Lines of code | |
| LINES | Number of lines in the source file | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| PROGRAM_LENGTH | Halstead program length | |
| RETURNS | Number of return points from functions | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOGICAL_LINES | Number of statements | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| OPERANDS | Number of operands | |
| COMPARISONS | Number of comparison operators | |
| JAVA0237 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| SIZE | Size of the file in bytes | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0043 | JAVA0043 Inner class does not use outer class | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0113 | JAVA0113 Incorrect javadoc: no @author tag | |
| LOOPS | Number of loops | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LINE_COMMENT | Number of line comments | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
/*
* 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 java.util.Iterator;
import javax.swing.Action;
import javax.swing.Icon;
import org.xnap.gui.XNapFrame;
import org.xnap.XNap;
import org.xnap.action.*;
import org.xnap.gui.action.*;
import org.xnap.peer.Peer;
import org.xnap.plugin.Plugin;
import org.xnap.plugin.opennap.OpenNapPlugin;
import org.xnap.plugin.opennap.gui.OpenNapDownloadContainerEditorDialog;
import org.xnap.search.DefaultSearchFilter;
import org.xnap.search.Search;
import org.xnap.search.SearchFilter;
import org.xnap.search.SearchHandler;
import org.xnap.search.SearchResult;
import org.xnap.transfer.AbstractDownload;
import org.xnap.transfer.DownloadManager;
import org.xnap.transfer.Queueable;
import org.xnap.transfer.Segment;
import org.xnap.transfer.action.AbstractDeleteAction;
import org.xnap.transfer.action.AbstractEditAction;
import org.xnap.transfer.action.AbstractFindMoreSourcesAction;
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.Preferences;
import org.xnap.util.*;
import org.xnap.util.State;
/**
*
*/
public class OpenNapDownloadContainer extends AbstractDownload
implements Queueable, SearchHandler {
//--- Constant(s) ---
/**
* The initial auto search interval. The interval is doubled with
* each search. */
public static final int INITIAL_SEARCH_INTERVAL = 30 * 60 * 1000; // 30 min
/**
* The upper bound for the search interval. */
public static final int MAX_SEARCH_INTERVAL = 3 * 60 * 60 * 1000; // 3 h
/**
* Maximum number of auto searches. */
public static final int MAX_SEARCH_COUNT = 10;
/**
* The state transition table. */
private static final Hashtable TRANSITION_TABLE;
static {
State[][] table = new State[][] {
{ State.NOT_STARTED,
State.RUNNING, State.DELETED, },
{ State.RUNNING,
State.STOPPING, State.SUCCEEDED, },
{ State.STOPPING,
State.NOT_STARTED, },
{ State.SUCCEEDED,
State.DELETED, },
};
TRANSITION_TABLE = FiniteStateMachine.createStateTable(table);
}
//--- Data Field(s) ---
private OpenNapDownloadContainerData data;
private OpenNapSegmentManager segmentManager;
private long enqueueTime;
private int queuePosition;
private StateMachine sm = new StateMachine();
private long bytesTransferred;
private long totalBytesTransferred;
private DefaultSearchFilter filter;
private int runningCount = 0;
private int minQueuePos = -1;
private ToggleAction autoSearchAction = new AutoSearchAction();
private AbstractTransferAction deleteAction = new DeleteAction();
private AbstractTransferAction startAction = new StartAction();
private AbstractTransferAction stopAction = new StopAction();
/**
* The number of children that are in downloading state.
*/
private int downloadingCount = 0;
//--- Constructor(s) ---
public OpenNapDownloadContainer(OpenNapSearchResult results[])
{
data = new OpenNapDownloadContainerData();
data.filename = results[0].getShortFilename();
data.filesize = results[0].getFilesize();
data.autoSearchingEnabled
= Preferences.getInstance().getAlwaysAutoDownload();
if (results[0].getFilter() != null) {
setSearchFilter(results[0].getFilter());
}
else {
DefaultSearchFilter filter = new DefaultSearchFilter();
filter.put
(SearchFilter.TEXT,
StringHelper.stripExtra(FileHelper.name(data.filename)));
setSearchFilter(filter);
}
segmentManager = new OpenNapSegmentManager
(this, OpenNapPlugin.getPreferences().getMultiSourceDownloading());
for (int i = 0; i < results.length; i++) {
add(results[i], false);
}
initialize();
File path = new File(Preferences.getInstance().getIncompleteDir());
OpenNapPlugin.getTransferManager().getResumeRepository().add
(path, this.data);
enqueueTime = System.currentTimeMillis();
DownloadManager.getInstance().getQueue().add(this);
}
/**
* Invoked by {@link OpenNapResumeRepository} when restoring download from
* resume data.
*/
public OpenNapDownloadContainer(OpenNapDownloadContainerData data)
{
this.data = data;
this.filter = createFilterFromData();
segmentManager = new OpenNapSegmentManager
(this, OpenNapPlugin.getPreferences().getMultiSourceDownloading(),
data.segments);
totalBytesTransferred = segmentManager.getBytesTransferred();
initialize();
}
//--- Methods ---
private void initialize()
{
deleteAction.setEnabledLater(true);
startAction.setEnabledLater(true);
stopAction.setEnabledLater(false);
autoSearchAction.setSelected(data.autoSearchingEnabled);
}
/**
* Creates a new download for result and adds it as a child. If a
* download for result is already existing, starts it if not
* running.
*
* @return true, if download for result was added or already
* existing; false, otherwise */
public boolean add(OpenNapSearchResult result, boolean matchFilter)
{
synchronized (sm) {
// check if there is already a child download that downloads
// the result
for (Iterator i = OpenNapDownloadContainer.this.iterator();
i.hasNext();) {
OpenNapDownload d = (OpenNapDownload)i.next();
if (result.equals(d.getResult())) {
if (d.isRestartable()) {
if (d.getResult().getOpenNapUser().isDownloadDenied()) {
d.setStateDescription(XNap.tr("Downloads from this peer are disabled"));
}
else {
d.start();
}
return true;
}
}
}
if (matchFilter) {
if (filter == null || !filter.matches(result)) {
return false;
}
}
OpenNapDownload d = new OpenNapDownload(this, result);
add(d);
if (d.getResult().getOpenNapUser().isDownloadDenied()) {
d.setStateDescription(XNap.tr("Downloads from this peer are disabled"));
}
else if (sm.getState() == State.RUNNING) {
d.start();
}
return true;
}
}
/**
* Notifies the {@link OpenNapTransferManager} that the download
* was removed. Invoked by {@link DownloadManager} when the
* download is done and clear finished is executed by user. */
public void cleared()
{
OpenNapPlugin.getTransferManager().remove(this);
}
public long getEnqueueTime()
{
return enqueueTime;
}
/**
*
*/
public String getFilename()
{
return data.filename;
}
/**
*
*/
public long getFilesize()
{
return data.filesize;
}
public Plugin getPlugin()
{
return OpenNapPlugin.getInstance();
}
/**
* @see xnap.transfer.Transfer#getActions()
*/
public Action[] getActions()
{
return new Action[] {
startAction,
stopAction,
new FindMoreSourcesAction(),
new EditAction(),
deleteAction,
null,
new OptionSubmenuAction(new Action[] { autoSearchAction }),
};
}
/**
*
*/
public long getBytesTransferred()
{
return bytesTransferred;
}
/**
* @see xnap.transfer.Transfer#getFile()
*/
public File getFile()
{
OpenNapSegment segment = segmentManager.getRoot();
return (segment != null) ? segment.getFile() : null;
}
public Icon getIcon()
{
return OpenNapPlugin.ICON_16;
}
/**
* Returns 1.
*/
public int getPriority()
{
return 1;
}
/**
* Returns the position in the {@link DownloadManager} queue.
*/
public int getQueuePosition()
{
return queuePosition;
}
/**
* @see xnap.transfer.Transfer#getPeer()
*/
public Peer getPeer()
{
return null;
}
/**
* @return a copy of the filter used for searching; null, if no
* search filter has been set, yet (i.e. download was started from
* browse) */
public SearchFilter getSearchFilter()
{
return (filter != null) ? (SearchFilter)filter.clone() : null;
}
public Segment[] getSegments()
{
return segmentManager.getSegments();
}
/**
* @see xnap.transfer.Transfer#getStatus()
*/
public String getStatus()
{
return sm.getDescription();
}
/**
* @see xnap.transfer.Transfer#getTotalBytesTransferred()
*/
public long getTotalBytesTransferred()
{
return totalBytesTransferred;
}
public boolean isAutoSearchingEnabled()
{
return data.autoSearchingEnabled;
}
public boolean isDone()
{
State s = sm.getState();
return s == State.SUCCEEDED;
}
/**
* Returns true, if the root segment is complete.
*/
private boolean isDownloadComplete()
{
OpenNapSegment segment = segmentManager.getRoot();
return segment != null && segment.isFinished()
&& segment.getEnd() == getFilesize();
}
public boolean isRunning()
{
return sm.getState() == State.RUNNING;
}
public void resultReceived(SearchResult result)
{
add((OpenNapSearchResult)result, true);
}
public void setAutoSearchingEnabled(boolean autoSearchingEnabled)
{
data.autoSearchingEnabled = autoSearchingEnabled;
}
public void setFilename(String filename)
{
data.filename = filename;
}
/**
* @param filter the search filter
*/
public void setSearchFilter(SearchFilter filter)
{
data.searchText = filter.getText();
data.realm = OpenNapPlugin.getSearchManager().getRealm
(filter.getMediaType());
this.filter = createFilterFromData();
}
void setSegments(OpenNapSegment[] segments)
{
data.segments = new OpenNapSegmentData[segments.length];
for (int i = 0; i < segments.length; i++) {
data.segments[i] = segments[i].getData();
}
}
private DefaultSearchFilter createFilterFromData()
{
DefaultSearchFilter filter = new DefaultSearchFilter();
filter.put(SearchFilter.TEXT, data.searchText);
if (data.realm != null) {
filter.put(SearchFilter.MEDIA_TYPE,
OpenNapPlugin.getSearchManager().getMediaType(data.realm));
}
filter.put(SearchFilter.MAX_FILESIZE, new Long(data.filesize));
filter.put(SearchFilter.MIN_FILESIZE, new Long(data.filesize));
return filter;
}
/**
* Invoked when the state of <code>search</code> changes.
*/
public void stateChanged(Search search)
{
if (search.isDone()) {
setStateDescription(XNap.tr("Finished search for more sources"));
}
}
/**
*
*/
public void setQueuePosition(int position)
{
queuePosition = position;
}
synchronized void commit(int transferred)
{
bytesTransferred += transferred;
totalBytesTransferred += transferred;
}
/**
* Invoked by {@link OpenNapDownloadRunner} objects.
*/
synchronized void done(OpenNapDownload d)
{
synchronized (sm) {
if (sm.getState() == State.SUCCEEDED) {
// another thread has already done the moving
return;
}
else if (sm.getState() == State.NOT_STARTED) {
logger.error("Illegal download state detected");
}
}
if (isDownloadComplete()) {
setStateDescription
(XNap.tr("Moving file to destination directory"));
try {
OpenNapSegment segment = getSegmentManager().getRoot();
String dir = FileHelper.getDownloadDir(getFilename());
File newFile = FileHelper.moveUnique
(segment.getFile(), dir, getFilename());
segment.setFile(newFile);
setState(State.SUCCEEDED);
}
catch (IOException e) {
logger.debug("could not rename finished file", e);
setState
(State.SUCCEEDED,
XNap.tr("Could not create file (check download dir)"));
}
}
else if (!d.isRestartable()) {
add(d.getResult(), false);
}
}
OpenNapSegmentManager getSegmentManager()
{
return segmentManager;
}
/**
* Invoked by {@link OpenNapDownload} children when child is queued. */
synchronized void remotelyQueued(int position)
{
if ((minQueuePos == -1 || position < minQueuePos) && position != 0) {
minQueuePos = -1;
for (Iterator i = OpenNapDownloadContainer.this.iterator();
i.hasNext();) {
OpenNapDownload d = (OpenNapDownload)i.next();
if (d.isQueued()) {
int pos = d.getQueuePosition();
if (pos < minQueuePos || minQueuePos == -1) {
minQueuePos = pos;
}
}
}
}
updateDescription();
}
private void searchForSources()
{
if (filter != null && filter.getText().length() > 0) {
Search s = OpenNapPlugin.getSearchManager().search(filter);
setStateDescription(XNap.tr("Searching for more sources") + "...");
s.start(this);
}
else {
setStateDescription(XNap.tr("Invalid search settings"));
}
}
private void setState(State newState, String description)
{
sm.setState(newState, description);
stateChanged();
}
private void setState(State newState)
{
sm.setState(newState);
stateChanged();
}
void setStateDescription(String description)
{
sm.setDescription(description);
stateChanged();
}
/**
* Invoked when the user manually starts the download or if it
* reaches to the top of the queue. */
public boolean startTransfer()
{
try {
setState(State.RUNNING);
synchronized (sm) {
for (Iterator i = OpenNapDownloadContainer.this.iterator();
i.hasNext();) {
((OpenNapDownload)i.next()).start();
}
}
}
catch (IllegalOperationException e) {
logger.error("unexpected exception", e);
}
return true;
}
/**
* Invoked by {@link OpenNapDownload} children to notify the
* container that a download has started. For each call to start()
* a call to {@link #stopped(OpenNapDownload)} needs to be made.
*
* @return true, if the start was accepted */
boolean started(OpenNapDownload d)
{
boolean notify = false;
synchronized (sm) {
if (sm.getState() == State.STOPPING
|| sm.getState() == State.SUCCEEDED) {
return false;
}
if (sm.getState() == State.NOT_STARTED) {
sm.setState(State.RUNNING);
notify = true;
}
runningCount++;
}
if (notify) {
stateChanged();
}
return true;
}
public void stop()
{
try {
setState(State.STOPPING);
minQueuePos = -1;
setQueuePosition(-1);
}
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 stopAllChildren()
{
synchronized (sm) {
for (Iterator i = OpenNapDownloadContainer.this.iterator();
i.hasNext();) {
((OpenNapDownload)i.next()).stop(XNap.tr("Stopped"));
}
}
}
/**
* Invoked by {@link OpenNapDownload} children.
*
* @see #started(OpenNapDownload)
*/
void stopped(OpenNapDownload d)
{
boolean notify = false;
synchronized (sm) {
runningCount--;
if (runningCount == 0 && sm.getState() == State.STOPPING) {
sm.setState(State.NOT_STARTED);
notify = true;
minQueuePos = -1;
updateDescription();
}
}
if (notify) {
stateChanged();
}
}
/**
* Invoked by {@link OpenNapDownload} children when DOWNLOADING
* state is entered. */
protected synchronized void transferStarted()
{
downloadingCount++;
if (downloadingCount == 1) {
bytesTransferred = 0;
super.transferStarted();
updateDescription();
}
}
/**
* Invoked by {@link OpenNapDownload} children when DOWNLOADING
* state is left. */
protected synchronized void transferStopped()
{
downloadingCount--;
if (downloadingCount == 0) {
super.transferStopped();
updateDescription();
}
}
private synchronized void updateDescription()
{
synchronized(sm) {
if (sm.getState() == State.RUNNING) {
if (downloadingCount > 0) {
sm.setDescription(XNap.tr("Downloading"));
setQueuePosition(0);
}
else if (minQueuePos > 0) {
sm.setDescription
(XNap.tr("Remotely queued ({0})",
new Integer(minQueuePos)));
setQueuePosition(minQueuePos);
}
else {
sm.setDescription(XNap.tr("Running"));
}
}
}
stateChanged();
}
//--- Inner Class(es) ---
private class StateMachine extends FiniteStateMachine
{
private AutoSearchTask searchTask;
//--- Constructor(s) ---
public StateMachine()
{
super(State.NOT_STARTED, TRANSITION_TABLE);
}
//--- Method(s) ---
protected synchronized void stateChanged(State oldState,
State newState)
{
if (newState == State.RUNNING) {
startAction.setEnabledLater(false);
stopAction.setEnabledLater(true);
deleteAction.setEnabledLater(false);
searchTask = new AutoSearchTask();
Scheduler.run
((getChildCount() > 0) ? INITIAL_SEARCH_INTERVAL : 0,
INITIAL_SEARCH_INTERVAL,
searchTask);
}
else if (newState == State.STOPPING) {
if (runningCount > 0) {
stopAllChildren();
stopAction.setEnabledLater(false);
}
else {
this.setState(State.NOT_STARTED);
}
}
else if (newState == State.SUCCEEDED
|| newState == State.NOT_STARTED) {
DownloadManager.getInstance().getQueue().remove
(OpenNapDownloadContainer.this);
stopAction.setEnabledLater(false);
deleteAction.setEnabledLater(true);
}
else if (newState == State.DELETED) {
OpenNapPlugin.getTransferManager().remove
(OpenNapDownloadContainer.this);
DownloadManager.getInstance().remove
(OpenNapDownloadContainer.this);
if (getFile() != null) {
getFile().delete();
}
}
if (newState == State.SUCCEEDED
|| newState == State.DELETED) {
OpenNapPlugin.getTransferManager().getResumeRepository().remove
(OpenNapDownloadContainer.this.data);
stopAllChildren();
}
else if (newState == State.NOT_STARTED) {
startAction.setEnabledLater(true);
}
if (oldState == State.RUNNING) {
searchTask.cancel();
searchTask = null;
}
}
}
/**
* Finds more sources regular intervals. */
private class AutoSearchTask extends XNapTask {
private long nextSearch = 0;
private int searchCount = 0;
private long searchInterval = INITIAL_SEARCH_INTERVAL;
public AutoSearchTask()
{
}
public void run()
{
if (!isAutoSearchingEnabled()) {
return;
}
if (nextSearch < System.currentTimeMillis()) {
searchForSources();
}
searchInterval *= 2;
if (searchInterval > MAX_SEARCH_INTERVAL) {
searchInterval = MAX_SEARCH_INTERVAL;
}
nextSearch = System.currentTimeMillis() + searchInterval;
if (++searchCount == MAX_SEARCH_COUNT) {
// notify user?
this.cancel();
}
}
}
private class AutoSearchAction extends AbstractToggleAction {
public AutoSearchAction()
{
putValue(Action.NAME, XNap.tr("Automatically search for more sources"));
}
public void toggled(boolean selected)
{
setAutoSearchingEnabled(selected);
}
}
private class DeleteAction extends AbstractDeleteAction {
public void actionPerformed(ActionEvent event)
{
// FIX: show confirmation dialog
try {
setState(State.DELETED);
}
catch (IllegalOperationException e) {
logger.warn("unexpected state");
}
}
}
private class EditAction extends AbstractEditAction {
public void actionPerformed(ActionEvent e)
{
OpenNapDownloadContainerEditorDialog.showDialog
(XNapFrame.getInstance(), OpenNapDownloadContainer.this);
}
}
private class FindMoreSourcesAction extends AbstractFindMoreSourcesAction {
public void actionPerformed(ActionEvent e)
{
searchForSources();
}
}
private class StartAction extends AbstractStartAction {
public void actionPerformed(ActionEvent e)
{
startTransfer();
}
}
private class StopAction extends AbstractStopAction {
public void actionPerformed(ActionEvent event)
{
stop();
}
}
private class StartRunner implements Runnable {
private OpenNapDownload d;
public StartRunner(OpenNapDownload d)
{
this.d = d;
}
public void run()
{
synchronized (sm) {
if (sm.getState() == State.RUNNING) {
d.start();
}
}
}
}
}
The table below shows all metrics for OpenNapDownloadContainer.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 131.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 137.00 | Comment lines | |
| COMMENT_DENSITY | 0.32 | Comment density | |
| COMPARISONS | 65.00 | Number of comparison operators | |
| CYCLOMATIC | 127.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 40.00 | Comments in declarations | |
| DOC_COMMENT | 103.00 | Number of javadoc comment lines | |
| ELOC | 427.00 | Effective lines of code | |
| EXEC_COMMENTS | 6.00 | Comments in executable code | |
| EXITS | 101.00 | Procedure exits | |
| FUNCTIONS | 61.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.46 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 95.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains 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 | 1.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 2.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 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 | 7.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 12.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 | 2.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 2.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 | 9.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 | 4.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 | 4.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 7.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1492.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 2.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.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 | 6.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 | 6.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 | 4.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.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 | 902.00 | Number of lines in the source file | |
| LINE_COMMENT | 16.00 | Number of line comments | |
| LOC | 630.00 | Lines of code | |
| LOGICAL_LINES | 248.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1066.00 | Number of operands | |
| OPERATORS | 2285.00 | Number of operators | |
| PARAMS | 29.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3351.00 | Halstead program length | |
| PROGRAM_VOCAB | 403.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 66.00 | Number of return points from functions | |
| SIZE | 20739.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 350.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 53.00 | Number of unique operators | |
| WHITESPACE | 135.00 | Number of whitespace lines | |