QueryRoutingTable.java
| Index Score | ||
|---|---|---|
 |
 |
phex.common |
 |
 |
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 | |
|---|---|---|
| LINE_COMMENT | Number of line comments |  |
| EXEC_COMMENTS | Comments in executable code | |
| LOOPS | Number of loops | |
| SIZE | Size of the file in bytes | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| LOC | Lines of code | |
| COMPARISONS | Number of comparison operators | |
| DECL_COMMENTS | Comments in declarations | |
| LINES | Number of lines in the source file | |
| BLOCKS | Number of blocks | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOGICAL_LINES | Number of statements | |
| OPERATORS | Number of operators | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| PROGRAM_LENGTH | Halstead program length | |
| ELOC | Effective lines of code | |
| EXITS | Procedure exits | |
| OPERANDS | Number of operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| COMMENTS | Comment lines | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0084 | JAVA0084 Should use compound assignment operator | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0029 | JAVA0029 Private method not used | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| 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: QueryRoutingTable.java 4107 2008-01-06 17:10:47Z gregork $
*/
package phex.common;
import java.util.*;
import java.util.zip.*;
import phex.common.log.NLogger;
import phex.host.*;
import phex.msg.*;
import phex.query.DynamicQueryConstants;
import phex.servent.Servent;
import phex.share.*;
import phex.utils.*;
/**
* Query routing table implementation for the QRP.
*/
public class QueryRoutingTable
{
/**
* The default table TTL representing INFINITY.
* Its set to 7 since everybody is using it that way...
* I would prefer 2 we only use QRP when we are a shielded leaf but Limewire
* is not accepting this value...
*/
public static final byte DEFAULT_INFINITY_TTL = 0x07;
/**
* The default table size of the QR table (64KB).
*/
public static final int DEFAULT_TABLE_SIZE = 64 * 1024;
/**
* The minimum table size of the QR table (16KB).
*/
private static final int MIN_TABLE_SIZE = 16 * 1024;
/**
* The default table size of the QR table (1024KB).
*/
private static final int MAX_TABLE_SIZE = 1024 * 1024;
/**
* Maximum fill ratio of the QRT (5%).
*/
private static final int MAX_FILL_RATIO = 5;
/**
* The query routing table. A BitSet is used since the GDF decided that
* QRP is only used between Leaf and Ultrapeers. The aggregated QRT
* exchanged between UPs represents the last hop Leaf and UP as a single unit.
*/
private BitSet qrTable;
/**
* The resized QRT is during aggregation when cases the original QRT table
* size does not match the size of the QRT to aggregate to.
* We cache this resized QRT since we might need to use it again for
* aggregation. The original QRT is not replaced by the resized version since
* we need the original version for accurate query routing.
*/
private BitSet resizedQRTable;
/**
* The size of the table;
*/
private int tableSize;
/**
* This is the number of bits the hashing result is allowed to have.
* It is the base 2 log of tableSize.
*/
private byte tableBits;
/**
* The infinity value to use.
*/
private byte infinity;
/**
* The number of marked slots in the qrTable.
*/
private int entryCount;
/**
* The total sequence size of the update messages.
*/
private byte sequenceSize;
/**
* The current sequence number of the update messages.
*/
private byte sequenceNumber;
/**
* The position on which to apply the next patch.
*/
private int patchPosition;
/**
* The inflater to use to uncompress.
*/
private Inflater inflater;
public QueryRoutingTable()
{
init( DEFAULT_TABLE_SIZE, DEFAULT_INFINITY_TTL );
}
public QueryRoutingTable( int tableSize )
{
init( tableSize, DEFAULT_INFINITY_TTL );
}
private void init( int newTableSize, byte infinity )
{
if ( qrTable == null || tableSize != newTableSize )
{
qrTable = new BitSet( tableSize );
}
else
{
qrTable.clear();
}
this.tableSize = newTableSize;
this.infinity = infinity;
this.tableBits = IOUtil.calculateLog2( tableSize );
resizedQRTable = null;
entryCount = 0;
sequenceSize = 0;
sequenceNumber = 0;
patchPosition = 0;
inflater = null;
}
public double getFillRatio()
{
return ( (double)qrTable.cardinality() / (double)tableSize ) * 100.0;
}
public int getTableSize()
{
return tableSize;
}
public void aggregateToRouteTable( QueryRoutingTable queryRoutingTable )
{
BitSet bitSetToAggregate;
if ( tableSize != queryRoutingTable.tableSize )
{
bitSetToAggregate = queryRoutingTable.resizeRouteTable( tableSize );
}
else
{
bitSetToAggregate = queryRoutingTable.qrTable;
}
qrTable.or( bitSetToAggregate );
}
/**
* Adds a character sequence to the qrt. This sequence is split into words
* each word is added separately into the qrt.
* @param absoluteFilePath the character sequence to add.
*/
private void add( String absoluteFilePath )
{
String[] words = splitFilePath( absoluteFilePath );
for ( int i = 0; i < words.length; i++ )
{
int hashVal = qrpHash( words[i], 0, words[i].length(), tableBits );
if ( !qrTable.get( hashVal ) )
{
entryCount++;
// instead of TTL just mark slot
qrTable.set( hashVal );
resizedQRTable = null;
}
}
}
/**
* Adds a single word into the qrt the word is hashed without modification.
* @param singleWord the word to add to the qrt without modification.
*/
private void addWord( String singleWord )
{
int hashVal = qrpHash( singleWord, 0, singleWord.length(), tableBits );
if ( !qrTable.get( hashVal ) )
{
entryCount++;
// instead of TTL just mark slot
qrTable.set( hashVal );
resizedQRTable = null;
}
}
/**
* Checks if the QRT has the hash value of the given search string flagged.
* @param searchString the search string to check.
* @return true if the hash of the search string is flagged.
*/
public boolean containsQuery( QueryMsg query )
{
String searchString = query.getSearchString();
boolean isInvalidSearchString = ( searchString == null ||
searchString.length() < DynamicQueryConstants.MIN_SEARCH_TERM_LENGTH );
if ( query.hasQueryURNs() && isInvalidSearchString )
{
URN[] urns = query.getQueryURNs();
for( int i = 0; i < urns.length; i++ )
{
String urnString = urns[i].getAsString();
int hashVal = qrpHash( urnString, 0, urnString.length(), tableBits );
if( qrTable.get( hashVal ) )
{// if we have a single match we have a match here.
return true;
}
}
// no urn matches...
return false;
}
if ( isInvalidSearchString )
{
return false;
}
String[] words = splitQueryString( searchString );
for ( int i = 0; i < words.length; i++ )
{
int hashVal = qrpHash( words[i], 0, words[i].length(), tableBits );
if ( !qrTable.get( hashVal ) )
{
return false;
}
}
return true;
}
public void updateRouteTable( RouteTableUpdateMsg message )
throws InvalidMessageException
{
if ( message.getVariant() == RouteTableUpdateMsg.RESET_TABLE_VARIANT )
{
int tableSize = ((QRResetTableMsg)message).getTableSize();
NLogger.debug( QueryRoutingTable.class,
"Reseting QRT from: " + message.getHeader().getFromHost() + " Size: " + tableSize );
// ignoring INFINITY :-( since all seem to be using 7
init( tableSize, infinity );
}
else if ( message.getVariant() == RouteTableUpdateMsg.PATCH_TABLE_VARIANT )
{
QRPatchTableMsg patchMessage = (QRPatchTableMsg)message;
// Validate message info...
byte msgSequenceSize = patchMessage.getSequenceSize();
byte msgSequenceNumber = patchMessage.getSequenceNumber();
NLogger.debug( QueryRoutingTable.class,
"Patching QRT from: " + message.getHeader().getFromHost() + " " +
msgSequenceNumber + "/" + msgSequenceSize );
if ( sequenceSize == 0 && sequenceNumber == 0 )
{// initializing case...
sequenceSize = msgSequenceSize;
sequenceNumber = 1;
}
if ( sequenceSize != msgSequenceSize || msgSequenceNumber != sequenceNumber
|| msgSequenceSize == 0 )
{
throw new InvalidMessageException(
"QRTPatchMsg sequence size or number not valid.\n" +
"Size: (" + msgSequenceSize + "/" + sequenceSize + ").\n" +
"Number: (" + msgSequenceNumber + "/" + sequenceNumber + ").");
}
sequenceNumber = msgSequenceNumber;
byte[] patchData = patchMessage.getPatchData();
byte compressor = patchMessage.getCompressor();
if ( compressor == QRPatchTableMsg.COMPRESSOR_ZLIB )
{
if ( sequenceNumber == 1 )
{
inflater = new Inflater();
}
try
{
patchData = IOUtil.inflate( inflater, patchData );
}
catch ( DataFormatException exp )
{
patchData = null;
// in case the inflate data format does not work.
if ( NLogger.isWarnEnabled(QueryRoutingTable.class) )
{
NLogger.warn(QueryRoutingTable.class,
"Invalid QRT data format to inflate.", exp );
}
}
if ( patchData == null )
{
throw new InvalidMessageException(
"Can't inflate patch data" );
}
}
else if ( compressor != QRPatchTableMsg.COMPRESSOR_NONE )
{// validation fails..
throw new InvalidMessageException(
"QRTPatchMsg Unknown compression: " + compressor );
}
// expand patch data.. this consumes extra memory... can't we do
// it on the fly?
byte entryBits = patchMessage.getEntryBits();
if ( entryBits == 4 )
{
byte[] buf = new byte[ patchData.length * 2 ];
byte tmpVal;
for ( int i = 0; i < patchData.length; i++ )
{
buf[ i * 2 ] = (byte)(patchData[i]>>4);
tmpVal = (byte)(patchData[i] & 0x0F);
if ( (tmpVal & 0x08) != 0 )
{
tmpVal = (byte)(0xF0 | tmpVal);
}
buf[ i * 2 + 1 ] = tmpVal;
}
patchData = buf;
}
else if ( entryBits != 8 )
{// validation fails..
throw new InvalidMessageException(
"QRTPatchMsg Unknown ENTRY_BITS value: " + entryBits );
}
try
{
// used to determine if a new entry was set
boolean prevBitSet, currBitSet;
int loggedInvalidPatchFieldValue = 0;
for ( int i = 0; i < patchData.length; i++ )
{
prevBitSet = qrTable.get( patchPosition );
//if ( patchData[i] == 1 - infinity )
if ( patchData[i] < 0 )// use this to also accept invalid clients
{
qrTable.set( patchPosition );
resizedQRTable = null;
}
//else if ( patchData[i] == infinity - 1 )
else if ( patchData[i] > 0 )// use this to also accept invalid clients
{
qrTable.clear( patchPosition );
resizedQRTable = null;
}
else if ( patchData[i] != 0 )
{// we received a QRT with a patch data value that is not
// really in range...
// we like to log each value only once therefore we
// flag the logged value
if ( loggedInvalidPatchFieldValue == 0 ||
loggedInvalidPatchFieldValue != patchData[i] )
{
NLogger.warn(QueryRoutingTable.class,
"Received invalid PatchData field value: "
+ patchData[i] + " - " + message.getHeader().getFromHost() );
loggedInvalidPatchFieldValue = patchData[i];
}
}
currBitSet = qrTable.get( patchPosition );
if ( prevBitSet && !currBitSet )
{
entryCount --;
}
else if ( !prevBitSet && currBitSet )
{
entryCount ++;
}
patchPosition ++;
}
}
catch ( IndexOutOfBoundsException exp )
{
throw new InvalidMessageException(
"QRTPatchMsg Wrong patch message data size." );
}
if ( sequenceNumber == sequenceSize )
{
sequenceSize = 0;
sequenceNumber = 0;
patchPosition = 0;
inflater = null;
NLogger.debug( QueryRoutingTable.class,
"Updated QRT: " + entryCount + " / " + tableSize );
}
else
{
sequenceNumber ++;
}
}
}
/**
* Returns a resized version of this QueryRoutingTable that matches the new
* given size. The returned QRT is either newly generated or the a catched
* version is used.
* @param newSize the new size of the QRT
* @return
*/
private BitSet resizeRouteTable( int newSize )
{
if ( tableSize == newSize )
{
// no need to resize...
return qrTable;
}
if ( resizedQRTable != null && resizedQRTable.size() == newSize )
{
return resizedQRTable;
}
resizedQRTable = new BitSet( newSize );
// create the resized version by using a simple algorithm.
double factor = ( (double)newSize ) / ( (double)tableSize );
for ( int i = 0; i < tableSize; i++ )
{
if ( !qrTable.get( i ) )
{// bit not set... don't need to handle...
continue;
}
int from = (int)Math.floor( i * factor );
int to = (int)Math.ceil( (i+1) * factor );
for (int j = from; j < to; j++)
{
resizedQRTable.set( j );
}
}
return resizedQRTable;
}
/**
* Splits a file path into pieces and takes creates a array of the pieces
* and there prefixes.
*/
private static String[] splitQueryString( String queryString )
{
StringTokenizer tokenizer = new StringTokenizer( queryString,
StringUtils.FILE_DELIMITERS );
ArrayList<String> list = new ArrayList<String>( 10 );
while( tokenizer.hasMoreTokens() )
{
String word = tokenizer.nextToken();
list.add( word );
}
String[] strArr = new String[ list.size() ];
list.toArray( strArr );
return strArr;
}
/**
* Splits a file path into pieces and takes creates a array of the pieces
* and there prefixes.
*/
private static String[] splitFilePath( String filePath )
{
StringTokenizer tokenizer = new StringTokenizer( filePath,
StringUtils.FILE_DELIMITERS );
ArrayList<String> list = new ArrayList<String>( 20 );
while( tokenizer.hasMoreTokens() )
{
String word = tokenizer.nextToken();
list.add( word );
// generate prefix strings
int length = word.length();
for ( int i = 1; i < 5 && (length - i) > 5; i++ )
{
list.add( word.substring( 0, length - i ) );
}
}
String[] strArr = new String[ list.size() ];
list.toArray( strArr );
return strArr;
}
/**
* Creates the current local QueryRoutingTable that is used to update
* remote clients.
*/
public static QueryRoutingTable createLocalQueryRoutingTable( SharedFilesService sharedFilesService )
{
long start = System.currentTimeMillis();
List<ShareFile> sharedFiles = sharedFilesService.getSharedFiles();
HashSet<String> wordSet = new HashSet<String>();
for ( ShareFile file : sharedFiles )
{
// add urn:sha1:xxx
//URN urn = sharedFiles[i].getURN();
//if ( urn != null )
//{
// wordSet.add( urn.getAsString() );
//}
// add splitted words.
String[] words = splitFilePath( file.getSystemFile().getAbsolutePath() );
for ( int j = 0; j < words.length; j++ )
{
wordSet.add( words[ j ] );
}
}
QueryRoutingTable qrTable = new QueryRoutingTable( MIN_TABLE_SIZE );
while( true )
{
fillLocalQRTWithShare( qrTable, wordSet );
if ( qrTable.tableSize < MAX_TABLE_SIZE && qrTable.getFillRatio() > MAX_FILL_RATIO )
{
qrTable.init( qrTable.tableSize * 2, DEFAULT_INFINITY_TTL );
continue;
}
break;
}
long end = System.currentTimeMillis();
NLogger.debug( QueryRoutingTable.class,
"Created QRT: " + qrTable.entryCount + " / " + qrTable.tableSize
+ " time: " + ( end - start) );
return qrTable;
}
private static void fillLocalQRTWithShare( QueryRoutingTable qrTable, HashSet<String> wordSet )
{
int counter = 0;
for ( String word : wordSet )
{
qrTable.addWord( word );
counter ++;
// check if the table is already full
if ( counter%1000 == 0 && qrTable.tableSize < MAX_TABLE_SIZE && qrTable.getFillRatio() > MAX_FILL_RATIO )
{
return;
}
}
}
/**
* Fills the given QueryRoutingTable with the last received
* QueryRoutingTables of connected leafs, when the servent is an ultrapeer.
* @param qrTable the QueryRoutingTable to fill.
* @param servent the Servent to act for.
*/
public static void fillQRTWithLeaves( QueryRoutingTable qrTable, Servent servent )
{
if ( !servent.isUltrapeer() )
{
return;
}
// add QRT of leafs...
Host[] leaves = servent.getHostService().getNetworkHostsContainer().getLeafConnections();
QueryRoutingTable hostQRT;
for ( int i = 0; i < leaves.length; i++ )
{
// http://groups.yahoo.com/group/the_gdf/message/23092
if ( leaves[i].getHopsFlowLimit() < 3 )
{// don't aggregate QRT of a leaf which doesn't want any queries...
continue;
}
hostQRT = leaves[i].getLastReceivedRoutingTable();
if ( hostQRT != null )
{
qrTable.aggregateToRouteTable( hostQRT );
}
}
}
public static Iterator<RouteTableUpdateMsg> buildRouteTableUpdateMsgIterator( QueryRoutingTable currentTable,
QueryRoutingTable oldTable )
{
ArrayList<RouteTableUpdateMsg> msgList = new ArrayList<RouteTableUpdateMsg>();
if ( oldTable == null )
{
// never sent a table before... send reset msg first
msgList.add( new QRResetTableMsg( currentTable.tableSize,
currentTable.infinity ) );
}
boolean isPatchNeeded = false;
// we always send 4 signed bits tables, therefore we only need to patch half
// table size.
byte[] patchData = new byte[ currentTable.tableSize / 2 ];
for ( int i = 0; i < patchData.length; i++ )
{
byte b1;
byte b2;
if ( oldTable == null )
{
if ( currentTable.qrTable.get( i * 2 ) )
{
b1 = (byte)(1 - currentTable.infinity);
}
else
{
b1 = (byte)0;
}
if ( currentTable.qrTable.get( i * 2 + 1) )
{
b2 = (byte)(1 - currentTable.infinity);
}
else
{
b2 = (byte)0;
}
}
else
{
boolean currentVal = currentTable.qrTable.get( i * 2 );
if ( currentVal == oldTable.qrTable.get( i * 2 ) )
{
b1 = (byte)0;
}
else if ( currentVal )
{
b1 = (byte)(1 - currentTable.infinity);
}
else
{
b1 = (byte)(currentTable.infinity - 1);
}
currentVal = currentTable.qrTable.get( i * 2 + 1);
if ( currentVal == oldTable.qrTable.get( i * 2 + 1) )
{
b2 = (byte)0;
}
else if ( currentVal )
{
b2 = (byte)(1 - currentTable.infinity);
}
else
{
b2 = (byte)(currentTable.infinity - 1);
}
}
patchData[i] = (byte)( ( b1 << 4 ) | ( b2 & 0x0F ) );
// check if we need a patch
if ( patchData[i] != 0 )
{
isPatchNeeded = true;
}
}
if ( !isPatchNeeded )
{// no patch message needed
return msgList.iterator();
}
// try to compress data
byte compressor = QRPatchTableMsg.COMPRESSOR_NONE;
byte[] compressedPatchData = IOUtil.deflate( patchData );
// verify if compressing made sense...
if ( compressedPatchData.length < patchData.length )
{
patchData = compressedPatchData;
compressor = QRPatchTableMsg.COMPRESSOR_ZLIB;
}
// build patch messages
// 1KB max message size was proposed...
byte sequenceSize = (byte)Math.ceil( (double)patchData.length /
(double)QRPatchTableMsg.MAX_MESSAGE_DATA_SIZE );
byte sequenceNo = 1;
int offset = 0;
do
{
int length = Math.min( QRPatchTableMsg.MAX_MESSAGE_DATA_SIZE,
patchData.length - offset );
QRPatchTableMsg msg = new QRPatchTableMsg( sequenceNo, sequenceSize,
// we patch into 0x04 entry bits since all bits are between -1 and 1
compressor, (byte)4, patchData, offset, length );
msgList.add( msg );
offset += length;
sequenceNo ++;
}
while ( offset < patchData.length );
return msgList.iterator();
}
////////////////////////////////////////////////////////////////////////////
// Optimized Code from Limewire for QRP String hashing //
////////////////////////////////////////////////////////////////////////////
/*
* The official platform-independent hashing function for query-routing. The
* key property is that it allows interpolation of hash tables of different
* sizes. More formally k*hash(x,n)<=hash(x, kn)<=k*hash(x,n)+1.<p>
*
* This experimental version does not necessarily work cross-platform,
* however, nor is it secure in any sense. See Chapter 12.3.2. of
* for details of multiplication-based algorithms.
*/
/**
*/
private static final int A_INT = 0x4F1BBCDC;
/**
* Returns the same value as hash(x.substring(start, end), bits),
* but tries to avoid allocations. Note that x is lower-cased
* when hashing.
*
* @param x the string to hash
* @param bits the number of bits to use in the resulting answer
* @param start the start offset of the substring to hash
* @param end just PAST the end of the substring to hash
* @return the hash value
*/
private static int qrpHash( String x, int start, int end, byte bits )
{
//1. First turn x[start...end-1] into a number by treating all 4-byte
//chunks as a little-endian quadword, and XOR'ing the result together.
//We pad x with zeroes as needed.
// To avoid having do deal with special cases, we do this by XOR'ing
//a rolling value one byte at a time, taking advantage of the fact that
//x XOR 0==x.
int xor=0; //the running total
int j=0; //the byte position in xor. INVARIANT: j==(i-start)%4
for (int i=start; i<end; i++)
{
//TODO: internationalization be damned?
int b = Character.toLowerCase(x.charAt(i)) & 0xFF;
b = b<<(j*8);
xor = xor^b;
j = (j+1)%4;
}
//2. Now map number to range 0 - (2^bits-1).
//Multiplication-based hash function. See Chapter 12.3.2. of CLR.
long prod= (long)xor * (long)A_INT;
long ret= prod << 32;
ret = ret >>> (32 + (32 - bits));
return (int)ret;
}
}
The table below shows all metrics for QueryRoutingTable.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 94.00 | Number of blocks | |
| BLOCK_COMMENT | 30.00 | Number of block comment lines | |
| COMMENTS | 188.00 | Comment lines | |
| COMMENT_DENSITY | 0.56 | Comment density | |
| COMPARISONS | 71.00 | Number of comparison operators | |
| CYCLOMATIC | 95.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 29.00 | Comments in declarations | |
| DOC_COMMENT | 110.00 | Number of javadoc comment lines | |
| ELOC | 338.00 | Effective lines of code | |
| EXEC_COMMENTS | 29.00 | Comments in executable code | |
| EXITS | 62.00 | Procedure exits | |
| FUNCTIONS | 18.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 105.60 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 54.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 | 1.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 | 1.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 | 1.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 7.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 | 3.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 | 4.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 3.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 | 7.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 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 15.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 7.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 1.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 | 1.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 | 6.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 | 779.00 | Number of lines in the source file | |
| LINE_COMMENT | 48.00 | Number of line comments | |
| LOC | 519.00 | Lines of code | |
| LOGICAL_LINES | 231.00 | Number of statements | |
| LOOPS | 16.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 947.00 | Number of operands | |
| OPERATORS | 1920.00 | Number of operators | |
| PARAMS | 22.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2867.00 | Halstead program length | |
| PROGRAM_VOCAB | 340.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 32.00 | Number of return points from functions | |
| SIZE | 26576.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 278.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 62.00 | Number of unique operators | |
| WHITESPACE | 72.00 | Number of whitespace lines | |