SWDownloadWorker.java
| Index Score | ||
|---|---|---|
 |
 |
phex.download.swarming |
 |
 |
Phex |
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 | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| LINE_COMMENT | Number of line comments | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| SIZE | Size of the file in bytes | |
| EXITS | Procedure exits | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| LOC | Lines of code | |
| NEST_DEPTH | Maximum nesting depth | |
| BLOCKS | Number of blocks | |
| PROGRAM_VOLUME | Halstead program volume | |
| LINES | Number of lines in the source file | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERATORS | Number of unique operators | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2008 Phex Development Group
*
* 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; either version 2 of the License, or
* (at your option) any later version.
*
* 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
*
* --- SVN Information ---
* $Id: SWDownloadWorker.java 4242 2008-08-03 17:03:04Z gregork $
*/
package phex.download.swarming;
import java.io.IOException;
import java.net.SocketTimeoutException;
import java.net.UnknownHostException;
import phex.common.Environment;
import phex.common.address.IpAddress;
import phex.common.log.NLogger;
import phex.connection.ConnectionFailedException;
import phex.download.DownloadConnection;
import phex.download.DownloadEngine;
import phex.download.PushHandler;
import phex.download.swarming.SWDownloadCandidate.CandidateStatus;
import phex.net.repres.SocketFacade;
import phex.prefs.core.NetworkPrefs;
import phex.servent.Servent;
public class SWDownloadWorker implements Runnable
{
/**
* A temporary worker indicates a worker that is used to wait for a valid
* download set. Only one temporary worker should be in the system. Once
* a valid download set is found the worker will lose its temporary status.
* This flag will help to limit the worker count and only hold as many
* workers as required and necessary.
*/
private volatile boolean isTemporaryWorker;
private volatile boolean isRunning;
private volatile DownloadEngine downloadEngine;
/**
* Indicates if the download worker is inside the critical download section.
* The critical section is the section in which modifications to the download
* segment occur. Before a Phex shutdown a worker thread needs to finish
* cleanly to ensure that not corruption to segment data occurs. (Invalid
* segment sizes).
*/
private volatile boolean insideCriticalSection;
/**
* Indicates if the download was stopped from externally.
* Usually per user request.
*/
private volatile boolean isDownloadStopped;
/**
* The thread in which the worker is running.
*/
private volatile Thread workerThread;
private Object workerThreadLock = new Object();
private final SwarmingManager downloadService;
public SWDownloadWorker( SwarmingManager downloadService )
{
this.downloadService = downloadService;
}
/**
* Sets the temporary worker status.
* @param state
* @see isTemporaryWorker
*/
public void setTemporaryWorker(boolean state)
{
isTemporaryWorker = state;
}
/**
* Returns the temporary worker status.
* @return the temporary worker status.
*/
public boolean isTemporaryWorker()
{
return isTemporaryWorker;
}
public boolean isInsideCriticalSection()
{
return insideCriticalSection;
}
public void run()
{
synchronized( workerThreadLock )
{
workerThread = Thread.currentThread();
}
try
{
innerRun();
}
finally
{
synchronized( workerThreadLock )
{
workerThread = null;
workerThreadLock.notify();
}
}
}
private void innerRun()
{
try
{
SWDownloadSet downloadSet;
while ( isRunning )
{
boolean isStopped = downloadService.checkToStopWorker(this);
if ( isStopped )
{
break;
}
isDownloadStopped = false;
NLogger.debug( SWDownloadWorker.class,
" - Allocating DownloadSet - " + this );
downloadSet = downloadService.allocateDownloadSet(this);
if ( downloadSet == null )
{
if ( isTemporaryWorker )
{
try
{
downloadService.waitForNotify();
}
catch (InterruptedException e)
{
Thread.currentThread().interrupt();
break;
}
continue;
}
else
{
// no download set acquired after handling last download...
// break away from further trying...
break;
}
}
NLogger.debug( SWDownloadWorker.class,
"Allocated DownloadSet: "
+ downloadSet.toString() + " - " + this);
try
{
handleDownload(downloadSet);
}
finally
{
NLogger.debug( SWDownloadWorker.class,
"Releasing DownloadSet: "
+ downloadSet.toString() + " - " + this);
downloadSet.releaseDownloadSet();
}
}
}
finally
{
// if the worker should run... give notice about crash
downloadService.notifyWorkerShoutdown(this, !isRunning);
NLogger.debug( SWDownloadWorker.class,
"Download worker finished: " + this);
}
}
public void startWorker()
{
isRunning = true;
Environment.getInstance().executeOnThreadPool( this,
"SWDownloadWorker-" + Integer.toHexString(hashCode()) );
NLogger.debug( SWDownloadWorker.class,
"Started SWDownloadWorker " + this);
}
public void stopWorker()
{
NLogger.debug( SWDownloadWorker.class,
"Download worker has been instructed to stop running: " + this);
isRunning = false;
isDownloadStopped = true;
if ( downloadEngine != null )
{
downloadEngine.abortDownload();
downloadEngine = null;
}
synchronized( workerThreadLock )
{
if ( workerThread != null )
{
workerThread.interrupt();
}
}
}
/**
* Waits/blocks until this download worker finishes its duty, without
* interrupting it.
*/
public void waitTillFinished()
{
synchronized( workerThreadLock )
{
try
{
while ( workerThread != null )
{
workerThreadLock.wait( 5000 );
}
}
catch (InterruptedException e)
{
NLogger.error( SWDownloadWorker.class, e, e );
Thread.currentThread().interrupt();
}
}
}
public boolean isRunning()
{
return isRunning;
}
/**
* Handles a specific SWDownloadSet to start the download for.
* @param downloadSet the download set containing the download configuration.
*/
private void handleDownload(SWDownloadSet downloadSet)
{
NLogger.debug( SWDownloadWorker.class,
"handleDownload() with: " + downloadSet + " - " + this);
SWDownloadFile downloadFile = downloadSet.getDownloadFile();
SWDownloadCandidate downloadCandidate = downloadSet
.getCandidate();
if ( !isRunning || isDownloadStopped )
{
return;
}
if ( downloadCandidate.isPushNeeded() )
{
connectDownloadEngineViaPush( downloadSet, false );
}
else
{
connectDownloadEngine(downloadSet);
}
if ( downloadEngine == null ) { return; }
if ( !isRunning || isDownloadStopped ) { return; }
try
{
insideCriticalSection = true;
startDownload(downloadSet);
}
finally
{
// unset possible queued candidate...
downloadFile.removeQueuedCandidate( downloadCandidate );
downloadEngine = null;
NLogger.debug( SWDownloadWorker.class,
"Releasing DownloadSegment: " + downloadSet.toString() + " - " + this);
downloadSet.releaseDownloadSegment();
// segment download completed
downloadFile.verifyStatus();
insideCriticalSection = false;
}
}
/**
* Connects the download engine to the host with a direct connection.
*/
private void connectDownloadEngine(SWDownloadSet downloadSet)
{
if ( !isRunning || isDownloadStopped ) { return; }
NLogger.debug( SWDownloadWorker.class,
"connectDownloadEngine with: " + downloadSet + " - " + this);
SWDownloadCandidate downloadCandidate = downloadSet.getCandidate();
// invalidate the download engine
downloadEngine = null;
try
{
DownloadConnection connection = new DownloadConnection(
downloadCandidate );
// this call sets the CONNECTING status when it is
// performing the connect operation.
connection.connect( NetworkPrefs.TcpConnectTimeout.get().intValue() );
if ( !isRunning || isDownloadStopped ) { return; }
downloadEngine = new DownloadEngine( downloadSet );
downloadEngine.setConnection( connection );
}
catch (ConnectionFailedException exp)
{
// indicates a general communication error while connecting
downloadCandidate.addToCandidateLog( exp.toString() );
NLogger.debug( SWDownloadWorker.class, exp.toString() );
// trying push - setting failed status is directed to connectDownloadEngineViaPush()
connectDownloadEngineViaPush( downloadSet, true );
return;
}
catch ( SocketTimeoutException exp)
{
// indicates a general communication error while connecting
downloadCandidate.addToCandidateLog( exp.toString() );
NLogger.debug( SWDownloadWorker.class, exp.toString() );
// trying push - setting failed status is directed to connectDownloadEngineViaPush()
connectDownloadEngineViaPush( downloadSet, true );
return;
}
catch ( UnknownHostException exp)
{
// indicates that we failed to determine the IP address of a host.
downloadCandidate.addToCandidateLog( exp.toString() );
NLogger.debug( SWDownloadWorker.class, exp.toString() );
// trying push - setting failed status is directed to connectDownloadEngineViaPush()
connectDownloadEngineViaPush( downloadSet, true );
return;
}
catch ( IOException exp )
{
downloadCandidate.addToCandidateLog( exp.toString() );
// TODO3 log this as error to handle different cases on some try
// again on others remove
NLogger.error( SWDownloadWorker.class, "HardError at Host: "
+ downloadCandidate.getHostAddress()
+ " Vendor: " + downloadCandidate.getVendor(),
exp );
assert downloadEngine == null :
"Download Engine is initialized. If this can possible happen we need to stop it.";
// unknown error trying a push - setting failed status is directed
// to connectDownloadEngineViaPush()
connectDownloadEngineViaPush( downloadSet, true );
return;
}
}
/**
* Connects the download engine via a push request.
* @param downloadSet the download set to use.
* @param failedBefore if true a previous standard connection try failed just
* before this try, false otherwise. This is used to determine the right
* status combinations to set and prevent double count of a single failed
* connection try.
*/
private void connectDownloadEngineViaPush( SWDownloadSet downloadSet, boolean failedBefore )
{
if ( !isRunning || isDownloadStopped ) { return; }
NLogger.debug( SWDownloadWorker.class,
"connectDownloadEngineViaPush with: " + downloadSet + " - " + this);
SWDownloadCandidate downloadCandidate = downloadSet.getCandidate();
SWDownloadFile downloadFile = downloadSet.getDownloadFile();
// invalidate the download engine
downloadEngine = null;
IpAddress ipAddress = downloadCandidate.getHostAddress().getIpAddress();
// indicate if the candidate might be reachable through LAN
boolean isLANReachable = NetworkPrefs.ConnectedToLAN.get().booleanValue()
&& ipAddress != null && ipAddress.isSiteLocalIP();
// force a status switch to ensure a possible failed status setting is
// detected correct.. prevents possible endless loops in race situations.
if ( downloadCandidate.getStatus() == CandidateStatus.CONNECTION_FAILED )
{
downloadCandidate.setStatus( CandidateStatus.CONNECTING, -1, "Forced status switch." );
}
// if we are behind a firewall there is no chance to successfully push
// if the candidate is not reachable through LAN.
if ( downloadSet.getServent().isFirewalled() && !isLANReachable )
{
NLogger.debug( SWDownloadWorker.class,
this.toString() + downloadCandidate.toString()
+ " Cant PUSH -> I'm firewalled and candidate not reachable by LAN" );
downloadCandidate.addToCandidateLog(
"Cant PUSH -> I'm firewalled and candidate not reachable by LAN" );
downloadCandidate.setStatus(
CandidateStatus.CONNECTION_FAILED);
// candidate must have push. can't directly connect
if ( downloadCandidate.isPushNeeded() )
{
downloadFile.markCandidateBad( downloadCandidate );
//downloadFile.markCandidateIgnored( downloadCandidate,
// "CandidateStatusReason_PushRequired");
// no bad alt loc in this case... others might connect correct...
}
return;
}
if ( downloadCandidate.getGUID() == null )
{
NLogger.debug( SWDownloadWorker.class,
this.toString() + downloadCandidate.toString()
+ " Cant PUSH -> No candidate GUID." );
downloadCandidate.addToCandidateLog(
"Cant PUSH -> No candidate GUID." );
downloadCandidate.setStatus(
CandidateStatus.CONNECTION_FAILED);
return;
}
if ( !isRunning || isDownloadStopped )
{
if ( failedBefore )
{
downloadCandidate.setStatus(CandidateStatus.CONNECTION_FAILED);
}
return;
}
downloadCandidate.setStatus(
CandidateStatus.PUSH_REQUEST);
SocketFacade socket = PushHandler.requestSocketViaPush(
downloadSet.getServent(), downloadCandidate );
if ( socket == null )
{
downloadCandidate.setStatus(
CandidateStatus.CONNECTION_FAILED);
// candidate must have push. can't directly connect
if ( downloadCandidate.isPushNeeded() )
{
downloadFile.markCandidateIgnored( downloadCandidate,
"CandidateStatusReason_PushRouteFailed" );
// no bad alt loc in this case... others might connect correct...
}
NLogger.debug( SWDownloadWorker.class,
"Push request fails for candidate: " + downloadCandidate );
downloadCandidate.addToCandidateLog(
"Push request fails for candidate: " + downloadCandidate );
return;
}
if ( !isRunning || isDownloadStopped ) { return; }
DownloadConnection connection = new DownloadConnection(
downloadCandidate, socket );
downloadEngine = new DownloadEngine( downloadSet );
downloadEngine.setConnection( connection );
}
/**
* Execute the actual download routine.
*/
private void startDownload(SWDownloadSet downloadSet)
{
NLogger.debug( SWDownloadWorker.class,
"startDownload with: " + downloadSet + " - " + this);
SWDownloadFile downloadFile = downloadSet.getDownloadFile();
SWDownloadCandidate downloadCandidate = downloadSet
.getCandidate();
downloadCandidate.addToCandidateLog( "Start download." );
// we came that far proves that we can successful connect to this candidate
// we can use it as good alt loc
// in cases where the http handshake revises this determination the
// alt loc will be adjusted accordingly.
downloadFile.addGoodAltLoc(downloadCandidate);
downloadFile.markCandidateGood(downloadCandidate);
downloadEngine.runEngine();
}
@Override
public String toString()
{
return "[SWDownloadWorker@" + Integer.toHexString(hashCode()) + ":running:" + isRunning + ",tempWorker:"
+ isTemporaryWorker + ",engine:" + downloadEngine + "]";
}
}
The table below shows all metrics for SWDownloadWorker.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 61.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 107.00 | Comment lines | |
| COMMENT_DENSITY | 0.45 | Comment density | |
| COMPARISONS | 27.00 | Number of comparison operators | |
| CYCLOMATIC | 54.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 12.00 | Comments in declarations | |
| DOC_COMMENT | 52.00 | Number of javadoc comment lines | |
| ELOC | 237.00 | Effective lines of code | |
| EXEC_COMMENTS | 23.00 | Comments in executable code | |
| EXITS | 54.00 | Procedure exits | |
| FUNCTIONS | 15.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 61.55 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 37.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 | 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 | 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 | 1.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 | 1.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 2.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.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 | 5.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 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 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 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 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 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 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 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 508.00 | Number of lines in the source file | |
| LINE_COMMENT | 34.00 | Number of line comments | |
| LOC | 348.00 | Lines of code | |
| LOGICAL_LINES | 141.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 501.00 | Number of operands | |
| OPERATORS | 1107.00 | Number of operators | |
| PARAMS | 7.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1608.00 | Halstead program length | |
| PROGRAM_VOCAB | 218.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 30.00 | Number of return points from functions | |
| SIZE | 18299.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 175.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 43.00 | Number of unique operators | |
| WHITESPACE | 53.00 | Number of whitespace lines | |