DynamicQueryEngine.java
| Index Score | ||
|---|---|---|
 |
 |
phex.query |
 |
 |
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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINE_COMMENT | Number of line comments | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| SIZE | Size of the file in bytes | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| LINES | Number of lines in the source file | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOC | Lines of code | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| LOGICAL_LINES | Number of statements | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2006 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
*
* --- CVS Information ---
* $Id: DynamicQueryEngine.java 4154 2008-03-21 14:26:32Z gregork $
*/
package phex.query;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import phex.common.QueryRoutingTable;
import phex.host.Host;
import phex.host.NetworkHostsContainer;
import phex.msg.QueryMsg;
import phex.msghandling.MessageService;
/**
* The DynamicQueryEngine is responsible for submitting the query
* over time to different hosts with different ttls depending on the
* number of results received.
* Queries are first checked against connected leaves, then probe
* queries with ttl of 1 are sent to ultrapeers to determine the file
* popularity, the last step is to sent regular queries with adjusted
* ttl to single ultrapeers.
* Only Ultrapeers use this engine to submit there queries. Leaves are
* sending there queries in the old style by broadcasting them to all
* there connections. The Ultrapeer of the leaf should then start the
* dynamic query process for its leaf.
*/
public class DynamicQueryEngine implements DynamicQueryConstants
{
private final NetworkHostsContainer hostsContainer;
private final MessageService messageService;
/**
* Indicates if the dynamic query process has started.
*/
private boolean isDynamicQueryStarted;
/**
* Indicates if the dynamic query process was forced to
* stop. Like after user interaction.
*/
private boolean isDynamicQueryStopped;
/**
* Indicates if leaves are queried.
*/
private boolean areLeavesQueried;
/**
* Indicates if the probe query is sent.
*/
private boolean isProbeQuerySent;
/**
* The number of millis a query is running before it times out.
*/
private long queryTimeout;
/**
* The time when the query was started.
*/
private long queryStartTime;
/**
* The time when the next query process step is
* taken.
*/
private long nextProcessTime;
/**
* The time to wait per hop between dynamic query iterations.
*/
private int timeToWaitPerHop;
/**
* The number of results desired to gain.
*/
private int desiredResults;
/**
* The number of results already received.
*/
private int receivedResults;
/**
* The estimated number of host in the horizon that have been reached
* by this query.
*/
private int estimatedQueriedHorizon;
/**
* A list of hosts that we send a standard query too.
*/
private List<Host> queriedHosts;
/**
* The base query of this DynamicQueryEngine. Form it
* new queries are build.
*/
private QueryMsg query;
/**
* Constructs a new DynamicQueryEngine.
* @param query the query to base the process on.
*/
public DynamicQueryEngine( QueryMsg query, int desiredResults,
NetworkHostsContainer hostsContainer, MessageService messageService )
{
this.hostsContainer = hostsContainer;
this.messageService = messageService;
this.query = query;
this.desiredResults = desiredResults;
isDynamicQueryStarted = false;
isDynamicQueryStopped = false;
areLeavesQueried = false;
isProbeQuerySent = false;
queryTimeout = DEFAULT_QUERY_TIMEOUT;
timeToWaitPerHop = DEFAULT_TIME_TO_WAIT_PER_HOP;
estimatedQueriedHorizon = 1;
receivedResults = 0;
queriedHosts = new ArrayList<Host>();
if ( query.hasQueryURNs() )
{// adjust desired results
desiredResults = DESIRED_HASH_RESULTS;
}
}
/**
* Increments the received result count.
* @param inc the value to increment the received result count.
*/
public void incrementResultCount( int inc )
{
receivedResults += inc;
}
/**
* @return the number of received results
*/
public int getResultCount()
{
return receivedResults;
}
/**
* Forces to stop the dynamic query. Like after user interaction.
*/
public void stopQuery()
{
isDynamicQueryStopped = true;
}
/**
* Returns if there are already enough results routed to meet the
* desired results.
* @return true if there are already enough results routed to meet the
* desired results, false otherwise.
*/
public boolean areEnoughResultsRouted()
{
// check if we received enough results...
return receivedResults >= desiredResults;
}
/**
* Returns the host this query is originaly comming from.
* @return the host this query is originaly comming from.
*/
public Host getFromHost()
{
return query.getHeader().getFromHost();
}
/**
* Returns whether this query engine has finished its query process. This
* can be the case when we received enough results, reached the maximal
* estimated horizon, or the query is already running for a too long time.
*
* @return true if the query engine has finished its query process, false
* otherwise.
*/
public boolean isQueryFinished()
{
// check if query has started.
if ( !isDynamicQueryStarted )
{
return false;
}
if ( isDynamicQueryStopped )
{
return true;
}
// check if we received enough results...
if( receivedResults >= desiredResults )
{
return true;
}
if ( estimatedQueriedHorizon > MAX_ESTIMATED_QUERY_HORIZON )
{
return true;
}
// check if the query has timed out
long currentTime = System.currentTimeMillis();
if ( currentTime > queryStartTime + queryTimeout )
{
return true;
}
return false;
}
/**
* Tries a very basic calculation about the search progress.
* @return the search progess from 0 - 100.
*/
public int getProgress()
{
// check if query has started.
if ( !isDynamicQueryStarted )
{
return 0;
}
if ( isDynamicQueryStopped )
{
return 100;
}
int resultProgress = (int)((double)receivedResults / (double)desiredResults
* 100d );
int horizonProgress = (int)((double)estimatedQueriedHorizon
/ (double)MAX_ESTIMATED_QUERY_HORIZON * 100d );
// time progress...
long currentTime = System.currentTimeMillis();
int timeProgress = (int)(100 - (double)( queryStartTime + queryTimeout - currentTime )
/ (double)queryTimeout * 100d );
// return the max of all these
return Math.min( Math.max( resultProgress,
Math.max( horizonProgress, timeProgress ) ), 100);
}
/**
* Runs the dynamic query process. This method is called
* regulary from the DynamicQueryWorker to continue the
* query process.
*/
public void processQuery()
{
long currentTime = System.currentTimeMillis();
if ( currentTime < nextProcessTime )
{// not our turn to query now...
return;
}
if ( !isDynamicQueryStarted )
{
isDynamicQueryStarted = true;
queryStartTime = currentTime;
// first sent to leaves... if ultrapeer.
// we always are a ultrapeer since only ultrapeer use dynamic query...
//if ( hostMgr.isUltrapeer() )
{
boolean sentToLeaves = processQueryToLeaves();
if ( sentToLeaves )
{
nextProcessTime = System.currentTimeMillis() + timeToWaitPerHop;
return;
}
}
}
// after leaves are querierd... send a probe query...
if ( !isProbeQuerySent )
{
processProbeQuery();
}
else
{
processStandardQuery();
}
}
/**
* Processes the standard query. This is the last step of the
* dynamic query process after leaves are queried and probe
* queries are sent.
*/
private void processStandardQuery()
{
Host[] ultrapeers = hostsContainer.getUltrapeerConnections();
// the number of connections that have not yet received the query
// used to calculate TTL
int notQueriedHosts = 0;
Host hostToQuery = null;
for ( int i = 0; i < ultrapeers.length; i++ )
{
// sort out all not stable and all
// connections we already queried.
if ( !ultrapeers[i].isConnectionStable() ||
queriedHosts.contains( ultrapeers[i] ) )
{
continue;
}
notQueriedHosts ++;
// found a host to query next...
hostToQuery = ultrapeers[i];
}
if ( notQueriedHosts == 0 || hostToQuery == null )
{// no hosts to query found... try again later...
nextProcessTime = System.currentTimeMillis() + 5000;
return;
}
byte maxTTL = hostToQuery.getMaxTTL();
int degree = hostToQuery.getUltrapeerDegree();
byte ttl = calculateTTL( maxTTL, degree, notQueriedHosts );
if ( ttl == 1 && hostToQuery.isUPQueryRoutingSupported() )
{// if we have a UP query routing connection we can
// pre check if a query with ttl of 1 makes sense.
// if there would be no hit we set the ttl to 2.
QueryRoutingTable qrt = hostToQuery.getLastReceivedRoutingTable();
if ( qrt == null || !qrt.containsQuery( query ) )
{
ttl = 2;
}
}
QueryMsg newQuery = new QueryMsg( query, ttl );
hostToQuery.queueMessageToSend( newQuery );
queriedHosts.add( hostToQuery );
// calculate the estimated reached horizon
estimatedQueriedHorizon = calculateEstimatedHorizon( degree, ttl );
nextProcessTime = System.currentTimeMillis() + (ttl * timeToWaitPerHop);
adjustTimeToWaitPerHop();
}
/**
* Sends the probe query to ultrapeers to check the
* file popularity.
*/
private void processProbeQuery()
{
Host[] ultrapeers = hostsContainer.getUltrapeerConnections();
List<Host> directHitList = new ArrayList<Host>( ultrapeers.length );
List<Host> failedList = new ArrayList<Host>( ultrapeers.length );
for ( int i = 0; i < ultrapeers.length; i++ )
{
QueryRoutingTable qrt = ultrapeers[i].getLastReceivedRoutingTable();
if ( ultrapeers[i].isUPQueryRoutingSupported() && qrt != null )
{
if ( qrt.containsQuery( query ) )
{
directHitList.add( ultrapeers[i] );
}
else
{// add to the end of failed list (low priority)
failedList.add( ultrapeers[i] );
}
}
else
{// add to the top of failed list (high priority)
failedList.add( 0, ultrapeers[i] );
}
}
int directProbeSize = directHitList.size();
int failedProbeSize = 0;
// send probe query to direct hits (max. 10)... with ttl = 1
int toIdx = Math.min( 10, directProbeSize );
sendProbeQueryToHosts( directHitList.subList( 0, toIdx ), (byte)1 );
directProbeSize = toIdx;
// we have not enough direct hits...
// probe with some of the failed hosts... with ttl = 2
if ( directProbeSize < 4 )
{
toIdx = Math.min( 3, failedList.size() );
sendProbeQueryToHosts( failedList.subList( 0, toIdx ), (byte)2 );
failedProbeSize = toIdx;
}
// special rule for probe... wait per connection
nextProcessTime = System.currentTimeMillis() +
timeToWaitPerHop * ( directProbeSize + failedProbeSize );
isProbeQuerySent = true;
}
/**
* Sends querys to my leaves.
* @return true if the query was forwarded to any leave, false otherwise.
*/
private boolean processQueryToLeaves()
{
QueryRoutingTable qrt = messageService.getLastSentQueryRoutingTable();
if ( qrt != null && qrt.containsQuery( query ) )
{
QueryMsg newQuery = new QueryMsg( query, (byte)1 );
estimatedQueriedHorizon += hostsContainer.getLeafConnectionCount();
messageService.forwardQueryToLeaves( newQuery,
newQuery.getHeader().getFromHost() );
return true;
}
return false;
}
/**
* Sends the probe query to the given host list.
* @param hostList the host list to send the query to.
* @param ttl the ttl to use with the query.
*/
public void sendProbeQueryToHosts( List<Host> hostList, byte ttl )
{
Iterator<Host> iterator = hostList.iterator();
QueryMsg newQuery = new QueryMsg( query, (byte)1 );
while( iterator.hasNext() )
{
Host host = iterator.next();
host.queueMessageToSend( newQuery );
// remember that we queried the host
queriedHosts.add( host );
// calculate the estimated reached horizon
int degree = host.getUltrapeerDegree();
estimatedQueriedHorizon = calculateEstimatedHorizon( degree, ttl );
}
}
/**
* Calculates the estimated reached horizon with a query with the
* given ttl and a given intra ultrapeer connection degree.
* hosts(degree,ttl) = Sum[(degree-1)^i, 0 <= i <= ttl-1]
* @return the estimated number of hosts queried.
*/
private int calculateEstimatedHorizon( int degree, byte ttl )
{
int hostCount = 0;
while ( ttl > 0 )
{
hostCount += Math.pow( degree - 1, ttl - 1 );
ttl --;
}
return hostCount;
}
/**
* Calculates the used ttl for the next query. The calculation
* is based on the availabe connection count, the received results,
* desired results, estimated queriered horizon, max ttl and intra
* ultrapeer connection degree.
* @param maxTTL the max ttl allowed on the host to query.
* @param degree the intra ultrapeer connection degree of the host to query.
* @param connectionCount the number of available connections to query.
* @return the ttl to use.
*/
private byte calculateTTL( byte maxTTL, int degree, int connectionCount )
{
double resultsPerHost = (double)receivedResults / (double)estimatedQueriedHorizon;
int missingResults = desiredResults - receivedResults;
int hostsNeededToQuery;
if ( resultsPerHost == 0 )
{
hostsNeededToQuery = 50000;
}
else
{
hostsNeededToQuery = (int)(missingResults / resultsPerHost);
}
int hostsPerConnection = hostsNeededToQuery / connectionCount;
for( byte i = 1; i < 6; i++ )
{
if( i > maxTTL )
{
return maxTTL;
}
int hosts = (int)(16.0 * calculateEstimatedHorizon(degree, i) );
if( hosts >= hostsPerConnection )
{
return i;
}
}
return maxTTL;
}
/**
* Adjusts the time to wait per hop. This is done if
* there have not been enough results received after
* a while and we want to go faster through the available
* hosts.
*/
private void adjustTimeToWaitPerHop()
{
if ( timeToWaitPerHop > 100 &&
( System.currentTimeMillis() - queryStartTime ) > TIMETOWAIT_ADJUSTMENT_DELAY )
{
double ratio;
if ( receivedResults == 0 )
{
ratio = 20;
}
else
{
ratio = Math.max( 20, (desiredResults/2)/receivedResults );
}
timeToWaitPerHop -= (int)(TIMETOWAIT_ADJUSTMENT * ratio);
if ( timeToWaitPerHop < 100 )
{
timeToWaitPerHop = 100;
}
}
}
}
The table below shows all metrics for DynamicQueryEngine.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 53.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 183.00 | Comment lines | |
| COMMENT_DENSITY | 0.91 | Comment density | |
| COMPARISONS | 38.00 | Number of comparison operators | |
| CYCLOMATIC | 54.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 31.00 | Comments in declarations | |
| DOC_COMMENT | 137.00 | Number of javadoc comment lines | |
| ELOC | 202.00 | Effective lines of code | |
| EXEC_COMMENTS | 19.00 | Comments in executable code | |
| EXITS | 33.00 | Procedure exits | |
| FUNCTIONS | 16.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 78.67 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 41.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 | 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 | 11.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 1.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 | 5.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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 11.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 | 1.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 | 2.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 1.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 2.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 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 | 2.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 552.00 | Number of lines in the source file | |
| LINE_COMMENT | 25.00 | Number of line comments | |
| LOC | 304.00 | Lines of code | |
| LOGICAL_LINES | 140.00 | Number of statements | |
| LOOPS | 5.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 472.00 | Number of operands | |
| OPERATORS | 1026.00 | Number of operators | |
| PARAMS | 12.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1498.00 | Halstead program length | |
| PROGRAM_VOCAB | 200.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 29.00 | Number of return points from functions | |
| SIZE | 17510.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 150.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 65.00 | Number of whitespace lines | |