GGEPBlock.java
| Index Score | ||
|---|---|---|
 |
 |
phex.msg |
 |
 |
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 | |
| JAVA0076 | JAVA0076 Use of magic number | |
| SIZE | Size of the file in bytes | |
| LOOPS | Number of loops | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| LINES | Number of lines in the source file | |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| COMPARISONS | Number of comparison operators | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| ELOC | Effective lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| PROGRAM_LENGTH | Halstead program length | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| EXITS | Procedure exits | |
| OPERANDS | Number of operands | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0084 | JAVA0084 Should use compound assignment operator | |
| FUNCTIONS | Number of function declarations | |
| JAVA0266 | JAVA0266 Use of System.out | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| DECL_COMMENTS | Comments in declarations | |
| COMMENTS | Comment lines | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| 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: GGEPBlock.java 4228 2008-07-13 17:48:43Z gregork $
*/
package phex.msg;
import java.io.*;
import java.util.*;
import java.util.zip.DataFormatException;
import phex.common.address.DestAddress;
import phex.common.address.IpAddress;
import phex.common.log.NLogger;
import phex.utils.*;
/**
* Implementation for GGEP
* Document Revision Version 0.51
* Protocol Version 0.5
*/
public class GGEPBlock
{
/**
* This is a magic number is used to help distinguish GGEP extensions from
* legacy data which may exist. It must be set to the value 0xC3.
*/
public static final byte MAGIC_NUMBER = (byte) 0xC3;
/**
* Browse host GGEP extension header ID.
*/
public static final String BROWSE_HOST_HEADER_ID = "BH";
public static final String ALTERNATE_LOCATIONS_HEADER_ID = "ALT";
public static final String AVARAGE_DAILY_UPTIME = "DU";
public static final String ULTRAPEER_ID = "UP";
public static final String VENDOR_CODE_ID = "VC";
public static final String PATH_INFO_HEADER_ID = "PATH";
public static final String PUSH_PROXY_HEADER_ID = "PUSH";
public static final String UDP_HOST_CACHE_UDPHC = "UDPHC";
public static final String UDP_HOST_CACHE_IPP = "IPP";
public static final String UDP_HOST_CACHE_SCP = "SCP";
public static final String UDP_HOST_CACHE_PHC = "PHC";
public static final String PHEX_EXTENDED_DESTINATION = "PHEX.EXDST";
public static final String PHEX_EXTENDED_ORIGIN = "PHEX.EXORG";
public static final String FEATURE_QUERY_HEADER_ID = "WH";
public static final String CREATION_TIME_HEADER_ID = "CT";
private HashMap<String, byte[]> headerToDataMap;
private boolean needsCobsFor0x00Byte;
public GGEPBlock( boolean needsCobsFor0x00 )
{
this.needsCobsFor0x00Byte = needsCobsFor0x00;
headerToDataMap = new HashMap<String, byte[]>( 3 );
}
public GGEPBlock( )
{
// unknown if we need cobs or not but to make sure useing it cant be bad.
this( true );
}
public void debugDump()
{
System.out.println( "--------------------------------------" );
for( String key : headerToDataMap.keySet() )
{
System.out.println( key + " = " + headerToDataMap.get( key ) );
}
System.out.println( "--------------------------------------" );
}
/**
* Adds a GGEP extension to a extension block without a data segment.
* @param header the header name of the extension
*/
private void addExtension( String header )
{
addExtension( header, "".getBytes() );
}
/**
* Adds a GGEP extension to a extension block with a data segment.
* @param header the header name of the extension
* @param data the data of the extension.
*/
public void addExtension( String header, byte[] data )
{
headerToDataMap.put( header, data );
}
/**
* Adds a GGEP extension to a extension block with an integer value.
* @param header the header name of the extension
* @param value the integer data, it should be an unsigned integer value
*/
public void addExtension( String header, int value )
{
addExtension( header, IOUtil.serializeInt2MinLE( value ) );
}
/**
* Adds a GGEP extension to a extension block with an long value.
* @param header the header name of the extension
* @param value the long data, it should be an unsigned long value
*/
public void addExtension( String header, long value )
{
addExtension( header, IOUtil.serializeLong2MinLE( value ) );
}
/**
* Adds multiple addresses as extension to this GGEP block in the common
* standard IP format. Maximal maxAmount addresses are added.
* @param header
* @param addresses
* @param maxAmount
*/
public void addExtension( String header, DestAddress[] addresses,
int maxAmount )
{
try
{
ByteArrayOutputStream outStream = new ByteArrayOutputStream();
int count = Math.min( addresses.length, maxAmount );
for ( int i = 0; i < count; i++ )
{
IpAddress ip = addresses[i].getIpAddress();
if ( ip != null )
{
outStream.write( ip.getHostIP() );
IOUtil.serializeShortLE(
(short)addresses[i].getPort(), outStream );
}
}
if ( outStream.size() > 0 )
{
addExtension( header, outStream.toByteArray() );
}
}
catch ( IOException exp )
{// this should never occur..
NLogger.error( GGEPBlock.class, exp, exp );
}
}
public void addAllExtensions( GGEPBlock block )
{
headerToDataMap.putAll( block.headerToDataMap );
}
public byte[] getExtensionData( String header )
{
return headerToDataMap.get( header );
}
/**
* Returns defaultValue in case no data is found or data is not valid.
* @param header
* @param defaultValue
* @return
*/
public long getLongExtensionData( String header, long defaultValue )
{
byte[] data = getExtensionData( header );
if (data == null || data.length < 1 || data.length > 8)
{
return defaultValue;
}
return IOUtil.deserializeLongLE( data, 0, data.length );
}
/**
* Returns defaultValue in case no data is found or data is not valid.
* @param header
* @param defaultValue
* @return
*/
public byte getByteExtensionData( String header, byte defaultValue )
{
byte[] data = getExtensionData( header );
if (data == null || data.length != 1 )
{
return defaultValue;
}
return data[0];
}
/**
* Checks if the data associated with a header is in compressed form.
* If it is compressed then the bit 5 ( starting from 0 )
* of the header Flags is set
* @author Madhu
*/
private int checkIfCompressed( String header, int headerFlags )
{
if( header.equals( UDP_HOST_CACHE_PHC ) )
{
headerFlags |= 0x20;
}
return headerFlags;
}
private boolean checkIfNeedsCobsEncoding( byte[] data )
{
if ( needsCobsFor0x00Byte && contains0x00Byte( data ))
{
return true;
}
return false;
}
private boolean contains0x00Byte(byte[] bytes)
{
if (bytes != null)
{
for (int i = 0; i < bytes.length; i++)
{
if (bytes[i] == 0x00)
{
return true;
}
}
}
return false;
}
/**
* Returns the byte representation of the GGEP block.
* @return the byte representation of the GGEP block.
*/
public byte[] getBytes()
{
ByteArrayOutputStream outStream = new ByteArrayOutputStream( 30 );
outStream.write( MAGIC_NUMBER );
Iterator<String> iterator = headerToDataMap.keySet().iterator();
while( iterator.hasNext() )
{
String headerKey = iterator.next();
byte[] dataBytes = headerToDataMap.get( headerKey );
int headerFlags = 0x00;
// needed if we add compressed data with a headerKey.
// For ex the PHC extension
headerFlags = checkIfCompressed( headerKey, headerFlags );
boolean needsCobsEncoding = checkIfNeedsCobsEncoding( dataBytes );
if ( needsCobsEncoding )
{
headerFlags |= 0x40;
dataBytes = IOUtil.cobsEncode( dataBytes );
}
if ( !iterator.hasNext() )
{
headerFlags |= 0x80;
}
byte[] headerBytes = headerKey.getBytes();
headerFlags = headerFlags | headerBytes.length;
outStream.write( headerFlags );
try
{
outStream.write( headerBytes );
}
catch ( IOException exp )
{
assert false : "Exception occured which should never happen.";
throw new RuntimeException( exp );
}
int dataLength = dataBytes.length;
int tmp = dataLength & 0x3f000;
// first byte...
if ( tmp != 0 )
{
// shift left to drop of non relevant bytes...
tmp = tmp >> 12;
tmp = 0x80 | tmp;
outStream.write( tmp );
}
tmp = dataLength & 0xFC0;
if ( tmp != 0 )
{
// shift left to drop of non relevant bytes...
tmp = tmp >> 6;
tmp = 0x80 | tmp;
outStream.write( tmp );
}
tmp = dataLength & 0x3F;
tmp = 0x40 | tmp;
outStream.write( tmp );
if ( dataLength > 0 )
{
try
{
outStream.write( dataBytes );
}
catch ( IOException exp )
{
assert false : "Exception occured which should never happen.";
throw new RuntimeException( exp );
}
}
}
return outStream.toByteArray();
}
/**
* Checks if the extension with the given headerID is available.
* @param header
* @return
*/
public boolean isExtensionAvailable( String headerID )
{
return headerToDataMap.containsKey( headerID );
}
//////////////////////// Static helpers ////////////////////////////////////
private static byte[] browseHostGGEPBlock;
public static byte[] getQueryReplyGGEPBlock(
boolean isBrowseHostSupported, DestAddress[] pushProxyAddresses )
{
if ( pushProxyAddresses != null && pushProxyAddresses.length > 0 )
{// we need to create the GGEP block in realtime.
GGEPBlock ggepBlock = new GGEPBlock( true );
if ( isBrowseHostSupported )
{
ggepBlock.addExtension( GGEPBlock.BROWSE_HOST_HEADER_ID );
}
ggepBlock.addExtension(PUSH_PROXY_HEADER_ID,
pushProxyAddresses, 4);
byte[] data = ggepBlock.getBytes();
return data;
}
else if ( isBrowseHostSupported )
{
if ( browseHostGGEPBlock == null )
{
GGEPBlock ggepBlock = new GGEPBlock( true );
ggepBlock.addExtension( GGEPBlock.BROWSE_HOST_HEADER_ID );
browseHostGGEPBlock = ggepBlock.getBytes();
}
return browseHostGGEPBlock;
}
else
{
return IOUtil.EMPTY_BYTE_ARRAY;
}
}
/**
*
* @param creationTime in millis
* @param alternateLocations
* @return
*/
public static byte[] getQueryReplyRecordGGEPBlock( long creationTime,
DestAddress[] alternateLocations )
{
if ( creationTime > 0 ||
( alternateLocations != null && alternateLocations.length > 0 ) )
{// we need to create the GGEP block in realtime.
GGEPBlock ggepBlock = new GGEPBlock( true );
if ( creationTime > 0 )
{
ggepBlock.addExtension( GGEPBlock.CREATION_TIME_HEADER_ID,
creationTime / 1000 );
}
if ( alternateLocations != null && alternateLocations.length > 0 )
{
ggepBlock.addExtension(ALTERNATE_LOCATIONS_HEADER_ID,
alternateLocations, 10);
}
byte[] data = ggepBlock.getBytes();
return data;
}
else
{
return IOUtil.EMPTY_BYTE_ARRAY;
}
}
/**
* Returns if the extension is available in any GGEP block.
* @param ggepBlocks
* @param header
* @return
*/
public static boolean isExtensionHeaderInBlocks( GGEPBlock[] ggepBlocks,
String headerID )
{
for (int i = 0; i < ggepBlocks.length; i++ )
{
if ( ggepBlocks[i].isExtensionAvailable( headerID ) )
{
return true;
}
}
return false;
}
/**
* Returns the extension if available in any GGEP block or null if not available.
* @param ggepBlocks
* @param header
* @return the extension if available in any GGEP block or null if not available.
*/
public static byte[] getExtensionDataInBlocks( GGEPBlock[] ggepBlocks,
String headerID )
{
for (int i = 0; i < ggepBlocks.length; i++ )
{
if ( ggepBlocks[i].isExtensionAvailable( headerID ) )
{
return ggepBlocks[i].getExtensionData( headerID );
}
}
return null;
}
public static GGEPBlock mergeGGEPBlocks( GGEPBlock[] ggepBlocks )
{
GGEPBlock mergedBlock = new GGEPBlock();
for ( int i = 0; i < ggepBlocks.length; i++ )
{
mergedBlock.addAllExtensions( ggepBlocks[i] );
}
return mergedBlock;
}
public static GGEPBlock[] parseGGEPBlocks( byte[] body, int offset )
{
GGEPParser parser = new GGEPParser();
return parser.parseGGEPBlocks( body, offset );
}
public static GGEPBlock[] parseGGEPBlocks( PushbackInputStream inStream )
throws InvalidGGEPBlockException, IOException
{
GGEPParser parser = new GGEPParser();
return parser.parseGGEPBlocks( inStream );
}
public static void debugDumpBlocks( GGEPBlock[] ggepBlocks )
{
for (int i = 0; i < ggepBlocks.length; i++ )
{
ggepBlocks[i].debugDump();
}
}
private static class GGEPParser
{
private int offset;
private List<GGEPBlock> ggepList;
public GGEPParser( )
{
ggepList = new ArrayList<GGEPBlock>( 3 );
}
public GGEPBlock[] parseGGEPBlocks( PushbackInputStream inStream )
throws InvalidGGEPBlockException, IOException
{
// the ggep specification requires us to support more then one GGEP
// extension:
// 'Extension blocks may contain an arbitrary number of GGEP blocks
// packed one against another.'
byte b;
while ( true )
{
b = (byte)inStream.read();
if ( b == -1 )
{
break;
}
else if ( b != MAGIC_NUMBER )
{
// not ggep anymore
// push back and break...
inStream.unread(b);
break;
}
ggepList.add( parseGGEPBlock( inStream ) );
}
GGEPBlock[] ggepArray = new GGEPBlock[ ggepList.size() ];
ggepList.toArray( ggepArray );
return ggepArray;
}
private GGEPBlock parseGGEPBlock( InputStream inStream )
throws InvalidGGEPBlockException, IOException
{
GGEPBlock ggepBlock = new GGEPBlock();
boolean isLastExtension = false;
int b;
while ( !isLastExtension)
{
// parse the extension header flags. They must be in form:
// - 7: Last Extension
// - 6: Encoding
// - 5: Compression
// - 4: Reserved ( must be 0 )
// - 3-0: ID Len ( 1-15 )
// validate extension byte
b = inStream.read();
if ( (b & 0x10) != 0)
{
throw new InvalidGGEPBlockException();
}
// last bit in header
isLastExtension = (b & 0x80) != 0;
boolean isEncoded = (b & 0x40) != 0;
boolean isCompressed = (b & 0x20) != 0;
// first 4 bit
short headerLength = (short) (b & 0x0F);
if ( headerLength == 0 )
{// 0 not allowed...
throw new InvalidGGEPBlockException();
}
byte[] headerData = new byte[ headerLength ];
inStream.read( headerData, 0, headerLength );
// parse the rest of the extension header.
String header = new String( headerData, 0, headerLength );
// parse the data length
int dataLength = parseDataLength( inStream );
byte[] dataArr = null;
try
{
if ( dataLength > 0 )
{
// get data as byte array...
dataArr = new byte[ dataLength ];
inStream.read( dataArr, 0, dataLength );
if ( isCompressed )
{
// use zlib inflator to decompress
dataArr = IOUtil.inflate( dataArr );
}
if ( isEncoded )
{
try
{
dataArr = IOUtil.cobsDecode( dataArr );
}
catch ( IOException exp )
{// set to null in case of parsing error
dataArr = null;
}
}
}
else
{
dataArr = new byte[0];
}
// check if there was a parsing failure
if ( dataArr != null )
{
ggepBlock.addExtension( header, dataArr );
}
}
catch ( DataFormatException exp )
{// in case the inflate data format does not work.
if ( NLogger.isWarnEnabled( GGEPBlock.class ) )
{
NLogger.warn(GGEPBlock.class,
"Invalid GGEP data format. Header: '" +
header + "' Data: '"
+ HexConverter.toHexString(dataArr) + "'.", exp );
}
}
}
return ggepBlock;
}
/**
* Code taken form GGEP specification document.
* @param body
* @return
* @throws IllegalGGEPBlockException
*/
private int parseDataLength( InputStream inStream )
throws InvalidGGEPBlockException, IOException
{
int length = 0;
int byteCount = 0;
byte currentByte;
do
{
byteCount ++;
if ( byteCount > 3 )
{
throw new InvalidGGEPBlockException();
}
currentByte = (byte)inStream.read();
length = (length << 6) | ( currentByte & 0x3F );
}
while ( 0x40 != (currentByte & 0x40) );
return length;
}
public GGEPBlock[] parseGGEPBlocks( byte[] body, int aOffset )
{
offset = aOffset;
try
{
// the ggep specification requires us to support more then one GGEP
// extension:
// 'Extension blocks may contain an arbitrary number of GGEP blocks
// packed one against another.'
// It could happen that the GUID appended to a query hit has
// the MAGIC_NUMBER as its first byte. This might result in a
// InvalidGGEPBlockException, but should not further disrupt parsing.
while ( body.length > offset && body[ offset ] == MAGIC_NUMBER )
{
// skip magic number
offset ++;
ggepList.add( parseGGEPBlock( body ) );
}
}
catch ( InvalidGGEPBlockException exp )
{// failed to further parse GGEP block.. skipping block
// and follow-up blocks. Sucessfully parsed blocks are
// used as valid results.
NLogger.debug( GGEPBlock.class, exp, exp );
}
GGEPBlock[] ggepArray = new GGEPBlock[ ggepList.size() ];
ggepList.toArray( ggepArray );
return ggepArray;
}
private GGEPBlock parseGGEPBlock( byte[] body )
throws InvalidGGEPBlockException
{
GGEPBlock ggepBlock = new GGEPBlock();
boolean isLastExtension = false;
while ( !isLastExtension)
{
// parse the extension header flags. They must be in form:
// - 7: Last Extension
// - 6: Encoding
// - 5: Compression
// - 4: Reserved ( must be 0 )
// - 3-0: ID Len ( 1-15 )
// validate extension byte
if ( body.length > offset && (body[offset] & 0x10) != 0)
{
throw new InvalidGGEPBlockException();
}
// last bit in header
isLastExtension = (body[offset] & 0x80) != 0;
boolean isEncoded = (body[offset] & 0x40) != 0;
boolean isCompressed = (body[offset] & 0x20) != 0;
boolean isReserved = (body[offset] & 0x10) != 0;
if( isReserved )
{
throw new InvalidGGEPBlockException( "Reserved bit set to 1" );
}
// first 4 bit
short headerLength = (short) (body[offset] & 0x0F);
if ( headerLength == 0 )
{// 0 not allowed...
throw new InvalidGGEPBlockException();
}
offset ++;
// parse the rest of the extension header.
String header = new String( body, offset, headerLength );
offset += headerLength;
// parse the data length
int dataLength = parseDataLength( body );
byte[] dataArr = null;
try
{
if ( dataLength > 0 )
{
// get data as byte array...
dataArr = new byte[ dataLength ];
try
{
System.arraycopy( body, offset, dataArr, 0, dataLength);
}
catch ( IndexOutOfBoundsException exp )
{
if ( NLogger.isDebugEnabled( GGEPBlock.class ) )
{
NLogger.warn( GGEPBlock.class, exp, exp );
NLogger.warn( GGEPBlock.class, "Offset: " + offset
+ "- Buffer: " + HexConverter.toHexString( body ) );
}
throw new InvalidGGEPBlockException( exp );
}
offset += dataLength;
if ( isCompressed )
{
// use zlib inflator to decompress
dataArr = IOUtil.inflate( dataArr );
}
if ( isEncoded )
{
try
{
dataArr = IOUtil.cobsDecode( dataArr );
}
catch ( IOException exp )
{// set to null in case of parsing error
dataArr = null;
}
}
}
else
{
dataArr = new byte[0];
}
// check if there was a parsing failure
if ( dataArr != null )
{
ggepBlock.addExtension( header, dataArr );
}
}
catch ( DataFormatException exp )
{// in case the inflate data format does not work.
if ( NLogger.isWarnEnabled( GGEPBlock.class ) )
{
NLogger.warn(GGEPBlock.class,
"Invalid GGEP data format. Header: '" +
header + "' Data: '"
+ HexConverter.toHexString(dataArr) + "'.", exp );
NLogger.warn( GGEPBlock.class, "Offset: " + offset
+ "- Buffer: " + HexConverter.toHexString( body ) );
}
}
}
return ggepBlock;
}
/**
* Code taken form GGEP specification document.
* @param body
* @return
* @throws IllegalGGEPBlockException
*/
private int parseDataLength( byte[] body )
throws InvalidGGEPBlockException
{
int length = 0;
int byteCount = 0;
byte currentByte;
do
{
byteCount ++;
if ( byteCount > 3 )
{
throw new InvalidGGEPBlockException();
}
currentByte = body[ offset ];
offset ++;
length = (length << 6) | ( currentByte & 0x3F );
}
while ( 0x40 != (currentByte & 0x40) );
return length;
}
}
}
The table below shows all metrics for GGEPBlock.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 110.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 167.00 | Comment lines | |
| COMMENT_DENSITY | 0.47 | Comment density | |
| COMPARISONS | 65.00 | Number of comparison operators | |
| CYCLOMATIC | 104.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 20.00 | Comments in declarations | |
| DOC_COMMENT | 95.00 | Number of javadoc comment lines | |
| ELOC | 358.00 | Effective lines of code | |
| EXEC_COMMENTS | 28.00 | Comments in executable code | |
| EXITS | 59.00 | Procedure exits | |
| FUNCTIONS | 32.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 95.40 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 106.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 | 5.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 | 29.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 | 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 | 6.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 4.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 2.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 | 3.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 14.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 13.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 | 1.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 3.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 | 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 | 4.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 | 3.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 | 3.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 5.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 | 808.00 | Number of lines in the source file | |
| LINE_COMMENT | 51.00 | Number of line comments | |
| LOC | 571.00 | Lines of code | |
| LOGICAL_LINES | 223.00 | Number of statements | |
| LOOPS | 13.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 912.00 | Number of operands | |
| OPERATORS | 1914.00 | Number of operators | |
| PARAMS | 42.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2826.00 | Halstead program length | |
| PROGRAM_VOCAB | 341.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 64.00 | Number of return points from functions | |
| SIZE | 27390.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 282.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 59.00 | Number of unique operators | |
| WHITESPACE | 70.00 | Number of whitespace lines | |