GWebCacheContainer.java
| Index Score | ||
|---|---|---|
 |
 |
phex.gwebcache |
 |
 |
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 | |
| EXITS | Procedure exits | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| SIZE | Size of the file in bytes | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| LINES | Number of lines in the source file | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| LOGICAL_LINES | Number of statements | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| ELOC | Effective lines of code | |
| CYCLOMATIC | Cyclomatic complexity | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| COMPARISONS | Number of comparison operators | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| COMMENTS | Comment lines | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| OPERANDS | Number of operands | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| DECL_COMMENTS | Comments in declarations | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| RETURNS | Number of return points from functions | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LOOPS | Number of loops | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2007 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: GWebCacheContainer.java 4231 2008-07-15 16:01:10Z gregork $
*/
package phex.gwebcache;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Random;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeSet;
import org.bushe.swing.event.annotation.EventTopicSubscriber;
import phex.common.Environment;
import phex.common.GeneralGnutellaNetwork;
import phex.common.address.AddressUtils;
import phex.common.address.DestAddress;
import phex.common.log.NLogger;
import phex.connection.ProtocolNotSupportedException;
import phex.event.ChangeEvent;
import phex.event.PhexEventTopics;
import phex.host.CaughtHostsContainer;
import phex.servent.Servent;
import phex.utils.NormalizableURL;
import phex.utils.StringUtils;
public class GWebCacheContainer
{
private static int MIN_G_WEB_CACHES_SIZE = 5;
private static int MAX_G_WEB_CACHES_SIZE = 1000;
private static List<String> BLOCKED_WEB_CACHES;
private static List<String> PHEX_WEB_CACHES;
static
{
// This is a list of Phex only GWebCaches. Requests from other hosts are
// ignored and return with ERROR.
String[] arr =
{
"http://gc-phex02.rakjar.de/gcache.php", "http://gc-fust01.rakjar.de/gcache.php", "http://phexgwc.kouk.de/gcache.php"
};
PHEX_WEB_CACHES = Collections.unmodifiableList( Arrays.asList( arr ) );
String[] blockedArr =
{
"gavinroy.com"
};
BLOCKED_WEB_CACHES = Collections.unmodifiableList( Arrays.asList(blockedArr) );
}
/**
* Contains GWebCache objects.
*/
private final List<GWebCache> allGWebCaches;
/**
* Contains GWebCache objects.
*/
private final List<GWebCache> functionalGWebCaches;
/**
* Contains Phex GWebCaches only. Locking is done through allGWebCaches.
*/
private final List<GWebCache> phexGWebCaches;
/**
* Stores the URL.toExternalForm().toLowerCase(). The URL object itself is not stored
* since the hash function of the URL is way slow, it could lead to doing a
* IP lookup.
* The lower case conversion is done to keep us from adding multiple equal URLs
* of the same file, like they are often seen.
*/
private final Set<String> uniqueGWebCacheURLs;
/**
* GWebCaches sorted by access order the last accessed GWebCaches first.
*/
private final TreeSet<GWebCache> sortedGWebCaches;
private final Random random;
private final Servent servent;
public GWebCacheContainer( Servent servent )
{
if ( servent == null )
{
throw new NullPointerException( "Servent missing." );
}
NLogger.debug( GWebCacheContainer.class, "Initializing GWebCacheContainer" );
this.servent = servent;
allGWebCaches = new ArrayList<GWebCache>();
phexGWebCaches = new ArrayList<GWebCache>();
functionalGWebCaches = new ArrayList<GWebCache>();
uniqueGWebCacheURLs = new HashSet<String>( );
sortedGWebCaches = new TreeSet<GWebCache>( GWebCacheComparator.INSTANCE );
random = new Random();
initializeGWebCacheContainer();
servent.getEventService().processAnnotations( this );
}
/**
* Clears and reloads GWebCaches.
*/
private void initializeGWebCacheContainer()
{
allGWebCaches.clear();
phexGWebCaches.clear();
functionalGWebCaches.clear();
uniqueGWebCacheURLs.clear();
sortedGWebCaches.clear();
insertPhexGWebCaches();
final File gWebCacheFile = servent.getGnutellaNetwork().getGWebCacheFile();
// to speed up returning from method... do loading in background
Runnable runner = new Runnable()
{
public void run()
{
loadGWebCacheFromFile( gWebCacheFile );
}
};
Environment.getInstance().executeOnThreadPool(runner, "LoadGWebCacheRunner" );
}
/**
* Reacts on gnutella network changes to initialize GWebCache.
*/
@EventTopicSubscriber(topic=PhexEventTopics.Servent_GnutellaNetwork)
public void onGnutellaNetworkEvent( String topic, ChangeEvent event )
{
initializeGWebCacheContainer();
}
/**
* Connects to a random GWebCache to fetch more hosts. This should be triggered
* on startup and when there are not enough hosts in the catcher. The queried
* hosts are directly put into the CaughtHostsContainer with high priority.
*/
public boolean queryMoreHosts( boolean preferPhex )
{
int retrys = 0;
boolean succ = false;
do
{
retrys ++;
GWebCacheConnection connection = getRandomGWebCacheConnection( preferPhex );
// continue if no connection...
if ( connection == null )
{
continue;
}
DestAddress[] hosts = connection.sendHostFileRequest( servent.getSecurityService() );
// continue if cache is bad or data is null...
if ( !verifyGWebCache( connection ) || hosts == null )
{
continue;
}
// everything looks good add data..
CaughtHostsContainer container = servent.getHostService().
getCaughtHostsContainer();
for ( int i = 0; i < hosts.length; i++ )
{
// gwebcache should only return Ultrapeers therefore we have
// high priority.
container.addCaughtHost( hosts[i], CaughtHostsContainer.HIGH_PRIORITY );
}
succ = true;
}
// do this max 5 times or until we where successful
while ( !succ && retrys < 5 );
return succ;
}
/**
* Updates the remote GWebCache. By the specification clients should only
* send updates if they accept incoming connections - i.e. clients behind
* firewalls should not send updates. Also, if supported by clients, only
* Ultrapeers/Supernodes should send updates. After a client has been up for
* an hour, it should begin sending an Update request periodically - every
* 60 minutes. It sends its own IP address and port in the "ip" parameter
* and a the URL of a random cache in the "url" parameter.
* Clients should only submit the URLs of caches that they know are functional!
*/
public boolean updateRemoteGWebCache( DestAddress myHostAddress, boolean preferPhex )
{
String fullHostName = null;
if ( myHostAddress != null )
{
fullHostName = myHostAddress.getFullHostName();
}
int retrys = 0;
boolean succ = false;
do
{
retrys ++;
GWebCacheConnection connection = getRandomGWebCacheConnection( preferPhex );
// continue if no connection...
if ( connection == null )
{
continue;
}
String urlString = null;
GWebCache gWebCache = getGWebCacheForUpdate( connection.getGWebCache() );
// there might be no gwebcache for update available.
if ( gWebCache != null )
{
assert !gWebCache.isPhexCache() && !gWebCache.equals( connection.getGWebCache() )
: "isPhexCache: " + gWebCache.isPhexCache() + ",equals " + gWebCache.getUrl()
+ " - " + connection.getGWebCache().getUrl();
urlString = gWebCache.getUrl().toExternalForm();
}
if ( fullHostName == null && urlString == null )
{
// no data to update... try again to determine random GWebCache in loop
continue;
}
succ = connection.updateRequest( fullHostName, urlString );
// continue if cache is bad or not successful...
if ( !verifyGWebCache( connection ) || !succ )
{
continue;
}
}
// do this max 5 times or until we where successful
while ( !succ && retrys < 5 );
return succ;
}
/**
* Connects to a random GWebCache to fetch more GWebCaches.
*/
public boolean queryMoreGWebCaches( boolean preferPhex )
{
int retrys = 0;
boolean succ = false;
do
{
retrys ++;
GWebCacheConnection connection = getRandomGWebCacheConnection( preferPhex );
// continue if no connection...
if ( connection == null )
{
continue;
}
URL[] urls = connection.sendURLFileRequest();
// continue if cache is bad or data is null...
if ( !verifyGWebCache( connection ) || urls == null )
{
continue;
}
// everything looks good add data..
for ( int i = 0; i < urls.length; i++ )
{
try
{
boolean isPhexCache = isPhexGWebCache( urls[i].toExternalForm() );
GWebCache gWebCache = new GWebCache( urls[i], isPhexCache );
if( isCacheAccessAllowed(gWebCache) )
{
insertGWebCache( gWebCache );
}
}
catch ( IOException exp )
{// invalid GWebCache... ignore
NLogger.debug( GWebCacheContainer.class, exp );
}
}
succ = true;
}
// do this max 5 times or until we where successful
while ( !succ && retrys < 5 );
return succ;
}
public int getGWebCacheCount()
{
return allGWebCaches.size();
}
// we dont send update urls to other gwebcaches... too much trash...
private GWebCache getGWebCacheForUpdate( GWebCache ignore )
{
// we dont send update urls to other gwebcaches... too much trash...
/*
GWebCache gWebCache = null;
int count = functionalGWebCaches.size();
if ( count == 0 )
{
return null;
}
else if ( count == 1 )
{
gWebCache = (GWebCache)functionalGWebCaches.get( 0 );
if ( gWebCache.equals( ignore ) )
{
return null;
}
else
{
assert( !gWebCache.isPhexCache() );
return gWebCache;
}
}
int tries = 0;
do
{
int randomIndex = random.nextInt( count - 1 );
gWebCache = (GWebCache)functionalGWebCaches.get( randomIndex );
if ( !gWebCache.equals( ignore ) )
{
assert ( !gWebCache.isPhexCache() );
return gWebCache;
}
tries ++;
}
while ( tries < 10 );
// no valid cache found...
*/
return null;
}
private GWebCache getRandomGWebCache( boolean preferPhex )
{
ensureMinGWebCaches();
synchronized ( allGWebCaches )
{
GWebCache cache = null;
boolean usePhexCache = preferPhex && random.nextInt( 8 ) == 0;
if ( usePhexCache && phexGWebCaches.size() > 0 )
{
Collections.sort( phexGWebCaches, GWebCacheComparator.INSTANCE );
cache = phexGWebCaches.get( 0 );
}
else
{
int count = allGWebCaches.size();
if ( count == 0 )
{
return null;
}
cache = sortedGWebCaches.first();
}
long now = System.currentTimeMillis();
if ( now > cache.getEarliestReConnectTime() )
{
return cache;
}
else
{
return null;
}
}
}
/**
* Single trys to get a random and pinged GWebCacheConnection or null if
* connection could not be obtained.
*/
private GWebCacheConnection getRandomGWebCacheConnection( boolean preferPhex )
{
GWebCacheConnection connection = null;
GWebCache gWebCache = null;
try
{
gWebCache = getRandomGWebCache( preferPhex );
// ususally this url is always != null but in case there is no standard
// GWebCache file or a different default gnutella network is choosed the
// url might be null
if ( gWebCache == null )
{
return null;
}
connection = new GWebCacheConnection( gWebCache );
// we stop pinging GWebCache... this is not necessary since we
// find out anyway if cache is working on first contact.
//if ( !connection.sendPingRequest() )
//{
// removeGWebCache( url, false );
// return null;
//}
}
catch ( ProtocolNotSupportedException exp )
{// not valid url.. throw away...
removeGWebCache( gWebCache, true );
return null;
}
return connection;
}
private boolean verifyGWebCache( GWebCacheConnection connection )
{
GWebCache gWebCache = connection.getGWebCache();
// resort cache.
sortedGWebCaches.remove(gWebCache);
gWebCache.countConnectionAttempt( connection.isCacheBad() );
sortedGWebCaches.add(gWebCache);
// cache is working add it to functional list if not phex cache.
if ( !connection.isCacheBad() && !gWebCache.isPhexCache() &&
!functionalGWebCaches.contains( gWebCache ) )
{
functionalGWebCaches.add( gWebCache );
}
saveGWebCacheToFile();
return true;
}
/**
* Returns the GWebCache that can be parsed from the line, or
* null if parsing failed for some reason.
* @param line
* @return the parsed GWebCache instance or null.
* @throws MalformedURLException
*/
private GWebCache parseGWebCacheFromLine( String line )
throws IOException
{
// tokenize line
// line format can be:
// URL or:
// URL lastRequestTime failedInRowCount
StringTokenizer tokenizer = new StringTokenizer( line, " " );
int tokenCount = tokenizer.countTokens();
String urlStr;
long lastRequestTime;
int failedInRowCount;
if ( tokenCount == 1 )
{
urlStr = line;
lastRequestTime = -1;
failedInRowCount = -1;
}
else if ( tokenCount == 3 )
{
urlStr = tokenizer.nextToken();
try
{
lastRequestTime = Long.parseLong( tokenizer.nextToken() );
}
catch ( NumberFormatException exp )
{
lastRequestTime = -1;
}
try
{
failedInRowCount = Integer.parseInt( tokenizer.nextToken() );
}
catch ( NumberFormatException exp )
{
failedInRowCount = -1;
}
}
else
{// Unknown format
NLogger.warn( GWebCacheContainer.class, "Unknown HostCache line format: " + line );
return null;
}
NormalizableURL helpUrl = new NormalizableURL( urlStr );
helpUrl.normalize();
URL url = new URL( helpUrl.toExternalForm() );
boolean isPhexCache = isPhexGWebCache( url.toExternalForm() );
GWebCache cache = new GWebCache( url, isPhexCache );
if ( lastRequestTime > 0 )
{
cache.setLastRequestTime( lastRequestTime );
}
if ( failedInRowCount > 0 )
{
cache.setFailedInRowCount( failedInRowCount );
}
return cache;
}
/**
* Inserts a GWebCache...
*/
private void insertGWebCache( GWebCache gWebCache )
{
synchronized( allGWebCaches )
{
if ( allGWebCaches.size() >= MAX_G_WEB_CACHES_SIZE )
{
NLogger.error( GWebCacheContainer.class, "Limit of 1000 GWebCaches reached." );
removeGWebCache( sortedGWebCaches.last(), true );
return;
}
// The URL object itself is not stored
// since the hash function of the URL is way slow, it could lead to
// doing a IP lookup.
String uniqueString = gWebCache.getHostDomain();
if ( !uniqueGWebCacheURLs.contains( uniqueString ) )
{
allGWebCaches.add( gWebCache );
sortedGWebCaches.add( gWebCache );
uniqueGWebCacheURLs.add( uniqueString );
if ( gWebCache.isPhexCache() )
{
phexGWebCaches.add( gWebCache );
}
}
}
}
/**
* Removes a GWebCache..
*/
private void removeGWebCache( GWebCache gWebCache, boolean force )
{
synchronized( allGWebCaches )
{
// maintain a min number of GWebCaches even if bad.
if ( allGWebCaches.size() > MIN_G_WEB_CACHES_SIZE || force )
{
allGWebCaches.remove( gWebCache );
functionalGWebCaches.remove( gWebCache );
sortedGWebCaches.remove( gWebCache );
String uniqueString = gWebCache.getHostDomain();
uniqueGWebCacheURLs.remove( uniqueString );
if ( gWebCache.isPhexCache() )
{
phexGWebCaches.remove( gWebCache );
}
// save file...
saveGWebCacheToFile();
}
}
}
/**
* Inserts a GWebCache...
*/
private void insertGWebCacheFromLine( String gWebCacheLine )
{
// verify URL
try
{
GWebCache gWebCache = parseGWebCacheFromLine( gWebCacheLine );
if( gWebCache != null && isCacheAccessAllowed( gWebCache ) )
{
insertGWebCache( gWebCache );
}
}
catch ( IOException exp )
{
NLogger.debug( GWebCacheContainer.class, exp);
}
}
/**
* Tries to ensure that there is a minimum number of GWebCaches available.
* This is done by loading GWebCaches from a districuted GWebCache default
* file and 1 hard coded emergency GWebCache.
* If we are not on the General Gnutella Network there is no way to ensure
* a minimum set of GWebCaches and this call returns without actions.
*
*/
private void ensureMinGWebCaches()
{
if ( allGWebCaches.size() >= 10 )
{
return;
}
if ( !( servent.getGnutellaNetwork() instanceof GeneralGnutellaNetwork ) )
{// not on general gnutella network... cant use default list
return;
}
NLogger.debug( GWebCacheContainer.class, "Load default GWebCache file." );
InputStream inStream = ClassLoader.getSystemResourceAsStream(
"phex/resources/gwebcache.cfg" );
if ( inStream != null )
{
InputStreamReader reader = new InputStreamReader( inStream );
try
{
loadGWebCacheFromReader( reader );
saveGWebCacheToFile();
}
catch ( IOException exp )
{
NLogger.warn( GWebCacheContainer.class, exp, exp );
}
}
else
{
NLogger.warn( GWebCacheContainer.class, "Default GWebCache file not found." );
}
if ( allGWebCaches.size() < 1 )
{// emergency case which should never happen since the gwebcache.cfg
// should contain enough caches.
//insertGWebCache( "http://gwebcache.bearshare.net/gcache.php" );
insertPhexGWebCaches();
saveGWebCacheToFile();
}
}
private void insertPhexGWebCaches()
{
if ( !( servent.getGnutellaNetwork() instanceof GeneralGnutellaNetwork ) )
{// not on general gnutella network... can't use default list
return;
}
URL url;
for ( String phexCachesURL : PHEX_WEB_CACHES )
{
try
{
url = new URL( phexCachesURL );
GWebCache cache = new GWebCache( url, true );
insertGWebCache( cache );
}
catch (IOException e)
{
NLogger.error( GWebCacheContainer.class, e, e);
}
}
}
private boolean isCacheAccessAllowed( GWebCache gWebCache )
{
// check access by IP
// Looking up host ip turns out to be a very slow solution...
// byte[] hostIP = gWebCache.getHostIp();
// byte access = PhexSecurityManager.getInstance().controlHostIPAccess(hostIP);
// if ( access != PhexSecurityManager.ACCESS_GRANTED )
// {
// // ignore GWebCache
// NLogger.debug( NLoggerNames.GWEBCACHE, "GWebCache IP blocked." );
// return false;
// }
// check if this is a IP only gWebCache.. IP only GWebCache are mostly
// spam distributed by gavinroy.com
URL cacheURL = gWebCache.getUrl();
String hostName = cacheURL.getHost();
if ( AddressUtils.isIPHostName( hostName )
&& StringUtils.isEmpty( cacheURL.getPath() ) )
{
return false;
}
// check access by host name
for ( String blocked : BLOCKED_WEB_CACHES )
{
if ( hostName.indexOf(blocked) != -1 )
{
// ignore GWebCache
NLogger.debug( GWebCacheContainer.class, "GWebCache host blocked." );
return false;
}
}
return true;
}
public boolean isPhexGWebCache( String url )
{
return PHEX_WEB_CACHES.indexOf(url) != -1;
}
private void loadGWebCacheFromFile( File gWebCacheFile )
{
try
{
if ( !gWebCacheFile.exists() )
{
return;
}
loadGWebCacheFromReader( new FileReader( gWebCacheFile ) );
}
catch ( IOException exp )
{
NLogger.error( GWebCacheContainer.class, exp, exp );
}
finally
{
ensureMinGWebCaches();
}
}
/**
* Reads the contents of the reader and closes the reader when done.
* @param reader the reader to read from.
* @throws IOException thrown when there are io errors.
*/
private void loadGWebCacheFromReader( Reader reader )
throws IOException
{
BufferedReader br = new BufferedReader( reader );
String line;
synchronized( allGWebCaches )
{
while ( (line = br.readLine()) != null)
{
if ( line.startsWith("#") )
{
continue;
}
insertGWebCacheFromLine( line );
}
}
br.close();
}
private void saveGWebCacheToFile()
{
NLogger.debug( GWebCacheContainer.class, "Saving GWebCaches.");
try
{
File file = servent.getGnutellaNetwork().getGWebCacheFile();
BufferedWriter writer = new BufferedWriter( new FileWriter( file ) );
synchronized( allGWebCaches )
{
for ( GWebCache gWebCache : allGWebCaches )
{
if ( gWebCache.isPhexCache() )
{
continue;
}
// line format can be:
// URL or:
// URL lastRequestTime failedInRowCount
writer.write( gWebCache.getUrl().toExternalForm() +
" " + gWebCache.getLastRequestTime() +
" " + gWebCache.getFailedInRowCount() );
writer.newLine();
}
}
writer.close();
}
catch ( IOException exp )
{
NLogger.error( GWebCacheContainer.class, exp, exp );
}
}
}
The table below shows all metrics for GWebCacheContainer.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 97.00 | Number of blocks | |
| BLOCK_COMMENT | 58.00 | Number of block comment lines | |
| COMMENTS | 195.00 | Comment lines | |
| COMMENT_DENSITY | 0.57 | Comment density | |
| COMPARISONS | 57.00 | Number of comparison operators | |
| CYCLOMATIC | 85.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 19.00 | Comments in declarations | |
| DOC_COMMENT | 76.00 | Number of javadoc comment lines | |
| ELOC | 343.00 | Effective lines of code | |
| EXEC_COMMENTS | 42.00 | Comments in executable code | |
| EXITS | 88.00 | Procedure exits | |
| FUNCTIONS | 23.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 76.73 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 59.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 | 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 | 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 | 11.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 4.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 1.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 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 3.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 | 2.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 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 | 3.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 5.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 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 | 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 | 788.00 | Number of lines in the source file | |
| LINE_COMMENT | 61.00 | Number of line comments | |
| LOC | 536.00 | Lines of code | |
| LOGICAL_LINES | 227.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 827.00 | Number of operands | |
| OPERATORS | 1708.00 | Number of operators | |
| PARAMS | 20.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2535.00 | Halstead program length | |
| PROGRAM_VOCAB | 345.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 39.00 | Number of return points from functions | |
| SIZE | 26057.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 291.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 54.00 | Number of unique operators | |
| WHITESPACE | 57.00 | Number of whitespace lines | |