CaughtHostsContainer.java
| Index Score | ||
|---|---|---|
 |
 |
phex.host |
 |
 |
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 | |
|---|---|---|
| EXITS | Procedure exits |  |
| SIZE | Size of the file in bytes | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| LINES | Number of lines in the source file | |
| LINE_COMMENT | Number of line comments | |
| JAVA0143 | JAVA0143 Synchronized method | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LOGICAL_LINES | Number of statements | |
| ELOC | Effective lines of code | |
| DECL_COMMENTS | Comments in declarations | |
| EXEC_COMMENTS | Comments in executable code | |
| OPERATORS | Number of operators | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| COMPARISONS | Number of comparison operators | |
| PROGRAM_LENGTH | Halstead program length | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| COMMENTS | Comment lines | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| LOOPS | Number of loops | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| 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: CaughtHostsContainer.java 4227 2008-07-13 10:24:03Z gregork $
*/
package phex.host;
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.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TimerTask;
import org.apache.commons.collections.set.ListOrderedSet;
import org.bushe.swing.event.annotation.EventTopicSubscriber;
import phex.common.Environment;
import phex.common.address.AddressUtils;
import phex.common.address.DefaultDestAddress;
import phex.common.address.DestAddress;
import phex.common.log.NLogger;
import phex.connection.ConnectionStatusEvent;
import phex.connection.ConnectionStatusEvent.Status;
import phex.event.ChangeEvent;
import phex.event.PhexEventTopics;
import phex.host.HostFetchingStrategy.FetchingReason;
import phex.msg.PongMsg;
import phex.prefs.core.NetworkPrefs;
import phex.security.AccessType;
import phex.security.PhexSecurityManager;
import phex.servent.Servent;
import phex.utils.IPUtils;
/**
* Responsible for holding all caught hosts.
*/
public class CaughtHostsContainer
{
public static final short HIGH_PRIORITY = 2;
public static final short NORMAL_PRIORITY = 1;
public static final short LOW_PRIORITY = 0;
private final static int FREE_SLOT_SET_SIZE = 8;
private phex.common.collections.PriorityQueue caughtHosts;
private HashSet<CaughtHost> uniqueCaughtHosts;
/**
* The CatchedHostCache provides a container with a limited size.
* The container stores CaughtHosts ordered by successful connection
* probability. When the container is full, the element with the
* lowest priority is dropped.
* Access needs to be synchronized on this object.
*/
private CatchedHostCache catchedHostCache;
/**
* All Hosts with free Leaf slots
* these are added by parsing the UP ggep extension in MsgPongs
*/
private Set<CaughtHost> freeLeafSlotSet;
/**
* All Hosts with free Ultrpeer slots
* these are added by parsing the UP ggep extension in MsgPongs
*/
private Set<CaughtHost> freeUltrapeerSlotSet;
private boolean hasChangedSinceLastSave;
private HostFetchingStrategy hostFetchingStrategy;
private final Servent servent;
public CaughtHostsContainer( Servent servent )
{
this.servent = servent;
int[] capacities = new int[3];
capacities[ HIGH_PRIORITY ] = (int)Math.round( NetworkPrefs.MaxHostInHostCache.get().doubleValue()
* 2.0 / 3.0 );
capacities[ NORMAL_PRIORITY ] = (int)Math.round( (NetworkPrefs.MaxHostInHostCache.get().doubleValue()
- capacities[HIGH_PRIORITY]) * 2.0 / 3.0 );
capacities[ LOW_PRIORITY ] = NetworkPrefs.MaxHostInHostCache.get().intValue()
- capacities[HIGH_PRIORITY] - capacities[NORMAL_PRIORITY];
caughtHosts = new phex.common.collections.PriorityQueue( capacities );
uniqueCaughtHosts = new HashSet<CaughtHost>();
catchedHostCache = new CatchedHostCache();
Environment.getInstance().scheduleTimerTask(
new SaveHostsContainerTimer(), SaveHostsContainerTimer.TIMER_PERIOD,
SaveHostsContainerTimer.TIMER_PERIOD );
freeUltrapeerSlotSet = new ListOrderedSet/*<CaughtHost>*/();
freeLeafSlotSet = new ListOrderedSet/*<CaughtHost>*/();
// initialize container
initializeCaughtHostsContainer();
servent.getEventService().processAnnotations( this );
}
/**
* @param hostFetchingStrategy the hostFetchingStrategy to set
*/
public void setHostFetchingStrategy(HostFetchingStrategy hostFetchingStrategy)
{
this.hostFetchingStrategy = hostFetchingStrategy;
}
/**
* Clears and reloads caught hosts
*/
private void initializeCaughtHostsContainer()
{
caughtHosts.clear();
catchedHostCache.clear();
hasChangedSinceLastSave = false;
loadHostsFromFile();
}
/**
* Adds a caught host based on the information from a pong message.
* @param pongMsg the pong message to add the caught host from.
*/
public boolean catchHosts( PongMsg pongMsg )
{
DestAddress pongAddress = pongMsg.getPongAddress();
boolean valid = isValidCaughtHostAddress( pongAddress );
if ( !valid )
{
return false;
}
CaughtHost caughtHost = new CaughtHost( pongAddress );
int dailyUptime = pongMsg.getDailyUptime();
if ( dailyUptime > 0 )
{
caughtHost.setDailyUptime( dailyUptime );
}
String vendor = pongMsg.getVendor();
if ( vendor != null )
{
caughtHost.setVendor( vendor, pongMsg.getVendorVersionMajor(),
pongMsg.getVendorVersionMinor() );
}
caughtHost.setUltrapeer( pongMsg.isUltrapeerMarked() );
short priority;
if ( pongMsg.isUltrapeerMarked() )
{
priority = CaughtHostsContainer.HIGH_PRIORITY;
if ( pongMsg.hasFreeLeafSlots() )
{
addToFreeLeafSlotSet( caughtHost );
}
if ( pongMsg.hasFreeUPSlots() )
{
addToFreeUltrapeerSlotSet( caughtHost );
}
}
else
{
priority = CaughtHostsContainer.LOW_PRIORITY;
}
// also add packed ip port pairs
Set<DestAddress> ipPortPairs = pongMsg.getIPPDestAddresses();
if ( ipPortPairs != null )
{
for ( DestAddress ipPortAdd : ipPortPairs )
{
if ( isValidCaughtHostAddress( ipPortAdd ) )
{
// we expect these hosts are UPs
addToCaughtHostFetcher( caughtHost,
CaughtHostsContainer.HIGH_PRIORITY );
}
}
}
addPersistentCaughtHost( caughtHost );
boolean isNew = addToCaughtHostFetcher( caughtHost, priority );
return isNew;
}
/**
* Adds a host address with given priority to the caught hosts.
*/
public void addCaughtHost( DestAddress address, short priority )
{
boolean valid = isValidCaughtHostAddress( address );
if ( !valid )
{
return;
}
CaughtHost caughtHost = new CaughtHost( address );
addPersistentCaughtHost( caughtHost );
addToCaughtHostFetcher( caughtHost, priority );
}
/**
* Adds the caught host to the host catcher that is used for
* upcoming network connections.
* The host is added to the top of its priority slot in the host catcher.
* @param caughtHost the CaughtHost to add.
* @param priority the priority slot to add the host to.
*/
private synchronized boolean addToCaughtHostFetcher( CaughtHost caughtHost,
short priority )
{
boolean isNew = false;
// if host is not already in the list
if ( !uniqueCaughtHosts.contains( caughtHost ) )
{
isNew = uniqueCaughtHosts.add( caughtHost );
Object removed = caughtHosts.addToHead( caughtHost, priority );
if ( removed != null )
{// cause aging of dropped elements.
uniqueCaughtHosts.remove( removed );
}
}
return isNew;
}
/**
* Adds the caught host to the caught host cache that is stored in the
* phex.hosts file. The position where the host is added depends on its
* prioity in the cache.
* If the host is already part of the cache the daily uptime is updated.
* @param caughtHost the caught host to add or update with.
*/
private void addPersistentCaughtHost( CaughtHost caughtHost )
{
synchronized ( catchedHostCache )
{
DestAddress address = caughtHost.getHostAddress();
CaughtHost existingHost = catchedHostCache.getCaughHost( address );
if ( existingHost == null )
{
catchedHostCache.add( caughtHost );
}
else
{
// update daily uptime..
// to maintain correct order first remove...
catchedHostCache.remove( existingHost );
// then modify...
if ( caughtHost.getDailyUptime() > 0 )
{
existingHost.setDailyUptime( caughtHost.getDailyUptime() );
}
// then add...
catchedHostCache.add( existingHost );
}
hasChangedSinceLastSave = true;
}
}
/**
* The number of caught hosts that are ready to be used for upcomming
* network connections.
* @return the number of caught hosts.
*/
public synchronized int getCaughtHostsCount()
{
return caughtHosts.getSize();
}
/**
* Removes and returns the next caught host for network connection.
* A call to this method also tryes to ensure that there are always
* enought hosts availble for networks connections.
* @return the netxt top most host ready for network connection.
*/
public synchronized DestAddress getNextCaughtHost()
{
CaughtHost host;
ensureMinCaughHosts();
if ( !caughtHosts.isEmpty() )
{
host = (CaughtHost)caughtHosts.removeMaxPriority();
uniqueCaughtHosts.remove( host );
return host.getHostAddress();
}
// host list is empty
// In this case we need to wait until a GWebCache reports IP's hopefully.
return null;
}
/**
* Handles the ConnectionStatusEvent of a just tried network connection to a
* HostAddress, this is used to update the CatchedHostCache.
* @param event the event containing the DestAddress to report the connection status
* and its connection status.
*/
@EventTopicSubscriber(topic=PhexEventTopics.Net_ConnectionStatus)
public void onConnectionStatusEvent( String topic, ConnectionStatusEvent event )
{
DestAddress hostAddress = event.getHostAddres();
boolean valid = isValidCaughtHostAddress( hostAddress );
if ( !valid )
{
return;
}
synchronized ( catchedHostCache )
{
CaughtHost existingHost = catchedHostCache.getCaughHost( hostAddress );
if ( existingHost == null )
{
existingHost = new CaughtHost( hostAddress );
}
else
{
// to maintain correct order first remove...
catchedHostCache.remove( existingHost );
}
// then modify...
if ( event.getStatus() == Status.SUCCESSFUL ||
event.getStatus() == Status.HANDSHAKE_REJECTED )
{
existingHost.setLastSuccessfulConnection( System.currentTimeMillis() );
}
else
{
existingHost.setLastFailedConnection( System.currentTimeMillis() );
}
// then add...
catchedHostCache.add( existingHost );
hasChangedSinceLastSave = true;
}
}
/**
* Reacts on gnutella network changes to initialize or save caught hosts.
*/
@EventTopicSubscriber(topic=PhexEventTopics.Servent_GnutellaNetwork)
public void onGnutellaNetworkEvent( String topic, ChangeEvent event )
{
saveHostsContainer();
initializeCaughtHostsContainer();
}
/**
* Makes sure that at least one percent of the max number of hosts
* are in the host catcher otherwise a GWebCache is queried.
*/
private void ensureMinCaughHosts()
{
int minCount = (int)Math.ceil(
NetworkPrefs.MaxHostInHostCache.get().doubleValue()/100.0 );
if ( caughtHosts.getSize() < minCount && hostFetchingStrategy != null )
{
hostFetchingStrategy.fetchNewHosts( FetchingReason.EnsureMinHosts );
}
}
/**
* Validates a host address if it is acceptable for the host catcher.
* A valid address has a valid port and ip, has no localhost ip or
* private ip, and has a port that is not user banned.
* @param address the address to validate
* @return true if the address is valid, false otherwise.
*/
private boolean isValidCaughtHostAddress( DestAddress address )
{
if ( address.isLocalHost()
|| !address.isValidAddress()
|| address.isSiteLocalAddress() )
{
return false;
}
if ( IPUtils.isPortInUserInvalidList( address ) )
{
return false;
}
return true;
}
/**
* adds to the container listing the hosts that have free
* ultrapeer slots.This is done in a synchronized fashion.
* the maximum no of hosts that are allowed in this container
* is FREE_SLOT_SIZE.
* if the container is full then new host is added into the container
* and the host with the least uptime is removed from the container
* @param aHost
*/
private void addToFreeUltrapeerSlotSet( CaughtHost host )
{
synchronized ( freeUltrapeerSlotSet )
{
freeUltrapeerSlotSet.add( host );
if( freeUltrapeerSlotSet.size() > FREE_SLOT_SET_SIZE )
{
((ListOrderedSet)freeUltrapeerSlotSet).remove(0);
}
assert freeUltrapeerSlotSet.size() <= FREE_SLOT_SET_SIZE :
"freeUltrapeerSlotSet grows over max size.";
}
}
/**
* adds to the container listing the hosts that have free
* leaf slots.This is done in a synchronized fashion.
* the maximum no of hosts that are allowed in this container
* is FREE_SLOT_SIZE.
* if the container is full then new host is added into the container
* and the host with the least uptime is removed from the container
* @param aHost
*/
private void addToFreeLeafSlotSet( CaughtHost host )
{
synchronized ( freeLeafSlotSet )
{
freeLeafSlotSet.add( host );
if( freeLeafSlotSet.size() > FREE_SLOT_SET_SIZE )
{
((ListOrderedSet)freeLeafSlotSet).remove(0);
}
assert freeLeafSlotSet.size() <= FREE_SLOT_SET_SIZE :
"freeLeafSlotSet grows over max size.";
}
}
public List<CaughtHost> getFreeUltrapeerSlotHosts( )
{
synchronized ( freeUltrapeerSlotSet )
{
ArrayList<CaughtHost> freeHosts = new ArrayList<CaughtHost>( freeUltrapeerSlotSet );
freeHosts.trimToSize();
return freeHosts;
}
}
public List<CaughtHost> getFreeLeafSlotHosts( )
{
synchronized ( freeLeafSlotSet )
{
ArrayList<CaughtHost> freeHosts = new ArrayList<CaughtHost>( freeLeafSlotSet );
freeHosts.trimToSize();
return freeHosts;
}
}
/**
* Loads the hosts file phex.hosts.
*/
private void loadHostsFromFile()
{
NLogger.debug(CaughtHostsContainer.class,
"Loading hosts file." );
try
{
File file = servent.getGnutellaNetwork().getHostsFile();
BufferedReader br;
if ( file.exists() )
{
br = new BufferedReader( new FileReader(file) );
}
else
{
NLogger.debug(CaughtHostsContainer.class,
"Load default hosts file." );
InputStream inStream = ClassLoader.getSystemResourceAsStream(
"phex/resources/phex.hosts" );
if ( inStream != null )
{
br = new BufferedReader( new InputStreamReader( inStream ) );
}
else
{
NLogger.debug(CaughtHostsContainer.class,
"Default Phex Hosts file not found." );
return;
}
}
PhexSecurityManager securityMgr = servent.getSecurityService();
String line;
short usedPriority = LOW_PRIORITY;
while ( (line = br.readLine()) != null )
{
if ( line.startsWith("#") )
{
continue;
}
CaughtHost caughtHost = parseCaughtHostFromLine( line );
if ( caughtHost == null )
{
continue;
}
AccessType access = securityMgr.controlHostAddressAccess(
caughtHost.getHostAddress() );
switch ( access )
{
case ACCESS_DENIED:
case ACCESS_STRONGLY_DENIED:
// skip host address...
continue;
}
if ( IPUtils.isPortInUserInvalidList( caughtHost.getHostAddress() ) )
{
continue;
}
addPersistentCaughtHost( caughtHost );
if ( usedPriority != HIGH_PRIORITY && caughtHosts.isFull( usedPriority ) )
{
// goes from lowest priority (0) to highest (2)
usedPriority ++;
}
addToCaughtHostFetcher( caughtHost, usedPriority );
}
br.close();
}
catch ( IOException exp )
{
NLogger.warn(CaughtHostsContainer.class, exp, exp);
}
}
/**
* Returns the CaughtHost that can be parsed from the line, or
* null if parsing failed for some reason.
* @param line
* @return the parsed CaughtHost
*/
private CaughtHost parseCaughtHostFromLine( String line )
{
// tokenize line
// line format can be:
// IP:port or:
// IP:port,lastFailedConnection,lastSuccessfulConnection,dailyUptime
// IP:port,lastFailedConnection,lastSuccessfulConnection,dailyUptime,vendor,vendorVersionMajor,vendorVersionMinor,isUltrapeer
StringTokenizer tokenizer = new StringTokenizer( line, "," );
int tokenCount = tokenizer.countTokens();
String hostAddressStr;
int dailyUptime;
long lastFailedconnection;
long lastSuccessfulConnection;
String vendor = null;
int vendorVersionMajor = -1;
int vendorVersionMinor = -1;
boolean isUltrapeer = false;
if ( tokenCount == 1 )
{
hostAddressStr = line;
dailyUptime = -1;
lastFailedconnection = -1;
lastSuccessfulConnection = -1;
}
else if ( tokenCount == 4 || tokenCount == 8 )
{
hostAddressStr = tokenizer.nextToken();
try
{
lastFailedconnection = Long.parseLong( tokenizer.nextToken() );
}
catch ( NumberFormatException exp )
{
lastFailedconnection = -1;
}
try
{
lastSuccessfulConnection = Long.parseLong( tokenizer.nextToken() );
}
catch ( NumberFormatException exp )
{
lastSuccessfulConnection = -1;
}
try
{
dailyUptime = Integer.parseInt( tokenizer.nextToken() );
}
catch ( NumberFormatException exp )
{
dailyUptime = -1;
}
if ( tokenCount == 8 )
{
vendor = tokenizer.nextToken();
try
{
vendorVersionMajor = Integer.parseInt( tokenizer.nextToken() );
}
catch ( NumberFormatException exp )
{
vendorVersionMajor = -1;
}
try
{
vendorVersionMinor = Integer.parseInt( tokenizer.nextToken() );
}
catch ( NumberFormatException exp )
{
vendorVersionMinor = -1;
}
isUltrapeer = Boolean.parseBoolean( tokenizer.nextToken() );
}
}
else
{// Unknown format
NLogger.warn( CaughtHostsContainer.class,
"Unknown HostCache line format: " + line);
return null;
}
byte[] ip = AddressUtils.parseIP( hostAddressStr );
if ( ip == null )
{
return null;
}
int port = AddressUtils.parsePort( hostAddressStr );
if ( port == -1 )
{
return null;
}
DestAddress hostAddress = new DefaultDestAddress( ip, port );
CaughtHost caughtHost = new CaughtHost( hostAddress );
caughtHost.setUltrapeer( isUltrapeer );
if ( dailyUptime > 0 )
{
caughtHost.setDailyUptime( dailyUptime );
}
if ( lastFailedconnection > 0 )
{
caughtHost.setLastFailedConnection( lastFailedconnection );
}
if ( lastSuccessfulConnection > 0 )
{
caughtHost.setLastSuccessfulConnection( lastSuccessfulConnection );
}
if ( vendor != null && !vendor.equals( "-" ) )
{
caughtHost.setVendor( vendor, vendorVersionMajor, vendorVersionMinor );
}
return caughtHost;
}
/**
* Blocking operation which saves the caught hosts and auto connect hosts
* if they changed since the last save operation.
*/
void saveHostsContainer( )
{
if ( !hasChangedSinceLastSave )
{
return;
}
saveCaughtHosts();
hasChangedSinceLastSave = false;
}
/**
* The caught hosts are saved from the persistent host cache container in
* reverse order. Since when loaded back the last element will be on top of
* the caught host priority queue.
*/
private void saveCaughtHosts()
{
NLogger.debug(CaughtHostsContainer.class, "Start saving caught hosts." );
try
{
File file = servent.getGnutellaNetwork().getHostsFile();
BufferedWriter bw = new BufferedWriter(new FileWriter(file));
synchronized( catchedHostCache )
{
Iterator<CaughtHost> iterator = catchedHostCache.iterator();
while( iterator.hasNext() )
{
CaughtHost host = iterator.next();
DestAddress hostAddress = host.getHostAddress();
String vendor = host.getVendor();
// line format is:
// IP:port,lastFailedConnection,lastSuccessfulConnection,dailyUptime,
// vendor,vendorVersionMajor,vendorVersionMinor,isUltrapeer
bw.write( hostAddress.getFullHostName() +
"," + host.getLastFailedConnection() +
"," + host.getLastSuccessfulConnection() +
"," + host.getDailyUptime() +
"," + (vendor == null ? "-" : vendor) +
"," + host.getVendorVersionMajor() +
"," + host.getVendorVersionMinor() +
"," + host.isUltrapeer() );
bw.newLine();
}
}
bw.close();
}
catch ( IOException exp )
{
NLogger.error( CaughtHostsContainer.class, exp, exp );
}
NLogger.debug(CaughtHostsContainer.class, "Finish saving caught hosts." );
}
////////////////////// START inner classes //////////////////////////
private class SaveHostsContainerRunner implements Runnable
{
public void run()
{
saveHostsContainer();
}
}
private class SaveHostsContainerTimer extends TimerTask
{
// once per minute
public static final long TIMER_PERIOD = 1000 * 60;
public void run()
{
try
{
// trigger the save inside a background job to not
// slow down the timer too much
Environment.getInstance().executeOnThreadPool( new SaveHostsContainerRunner(),
"SaveHostsContainer" );
}
catch ( Throwable th )
{
NLogger.error( CaughtHostsContainer.class, th, th );
}
}
}
}
The table below shows all metrics for CaughtHostsContainer.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 94.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 160.00 | Comment lines | |
| COMMENT_DENSITY | 0.46 | Comment density | |
| COMPARISONS | 57.00 | Number of comparison operators | |
| CYCLOMATIC | 80.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 25.00 | Comments in declarations | |
| DOC_COMMENT | 112.00 | Number of javadoc comment lines | |
| ELOC | 351.00 | Effective lines of code | |
| EXEC_COMMENTS | 16.00 | Comments in executable code | |
| EXITS | 96.00 | Procedure exits | |
| FUNCTIONS | 23.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 81.89 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 51.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 | 1.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 | 1.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 2.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 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 | 7.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 2.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 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 | 4.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 3.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 | 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 | 3.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 1.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 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 1.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 | 8.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 | 1.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 | 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 | 1.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 | 765.00 | Number of lines in the source file | |
| LINE_COMMENT | 27.00 | Number of line comments | |
| LOC | 545.00 | Lines of code | |
| LOGICAL_LINES | 219.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 881.00 | Number of operands | |
| OPERATORS | 1758.00 | Number of operators | |
| PARAMS | 16.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2639.00 | Halstead program length | |
| PROGRAM_VOCAB | 370.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 35.00 | Number of return points from functions | |
| SIZE | 26276.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 312.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 58.00 | Number of unique operators | |
| WHITESPACE | 60.00 | Number of whitespace lines | |