QueryMsg.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 | |
|---|---|---|
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' |  |
| DECL_COMMENTS | Comments in declarations | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0029 | JAVA0029 Private method not used | |
| SIZE | Size of the file in bytes | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0111 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| LINES | Number of lines in the source file | |
| LINE_COMMENT | Number of line comments | |
| EXITS | Procedure exits | |
| FUNCTIONS | Number of function declarations | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOC | Lines of code | |
| PROGRAM_VOLUME | Halstead program volume | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| COMPARISONS | Number of comparison operators | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2007 Phex Development Group
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* --- SVN Information ---
* $Id: QueryMsg.java 4242 2008-08-03 17:03:04Z gregork $
*/
package phex.msg;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import phex.common.URN;
import phex.common.address.IpAddress;
import phex.common.address.DestAddress;
import phex.common.address.DefaultDestAddress;
import phex.common.log.NLogger;
import phex.io.buffer.ByteBuffer;
import phex.utils.IOUtil;
import phex.utils.StringUtils;
import phex.prefs.core.MessagePrefs;
import phex.servent.Servent;
/**
* <p>Encapsulation of a Gnutella query message.</p>
*
* <p>Queries are encouraged to be smaller than 256 bytes. Larger messages may
* be dropped. You can expect messages larger than 4k to be dropped.</P>
*
* <p>Currently, there is no support in this class for extentions such as HUGE,
* XML or GGEP.
*
*
* <p>As of Feb, 2003, this class supports and encapsulates the new Minimum Speed
* definition, as described at
* http://groups.yahoo.com/group/the_gdf/files/Proposals/MinSpeed.html
* This definition change is encapsulated within this class.</p>
*
*/
public class QueryMsg extends Message
{
/**
* For outgoing queries, specifies whether we want to receive
* Limewire-style XML metadata results. For more info, see MsgQuery.java
*/
public static final boolean IS_PHEX_CAPABLE_OF_XML_RESULTS = false;
/**
* MINSPEED_*_BIT - these are the bit numbers for the new
* meanings of MinSpeed bits.
*/
private static final int MINSPEED_BITBASED_BIT = 15;
private static final int MINSPEED_FIREWALL_BIT = 14;
private static final int MINSPEED_XML_BIT = 13;
public static final int NO_FEATURE_QUERY_SELECTOR = 0;
public static final int WHAT_IS_NEW_FEATURE_QUERY_SELECTOR = 1;
private static final String WHAT_IS_NEW_QUERY_STRING = "WhatIsNewXOXO";
/**
* This indicates if the min speed field is using the new bit based
* representation.
*/
private boolean minSpeedIsBitBased;
/**
* Indicates if the query requester is firewalled.
* Variables represent a bit carried inside the MinSpeed field.
*/
private boolean requesterIsFirewalled;
/**
* Indicates if the query requester is capable of receiving XML results.
* Variables represent a bit carried inside the MinSpeed field.
*/
private boolean requesterIsXmlResultsCapable;
/**
* <p>The search string for this query.</p>
*
* <p>Servents should treat this search string as a list of keywords. They
* should respond with files that match all keywords. They may chose to only
* respond with files with all keywords in the query order. Case will be
* ignored. Wildcards and regular expressions are not supported.</p>
*
* <p>If the query is four spaces " " and TTL=1 and hops=0, it should be
* interpreted as a request for a complete directory listing.</p>
*/
private String searchString;
private int featureQuerySelector;
/**
* <p>The un-parsed body of the query.</p>
*
* <p>For queries that are being forwarded, this body will include all extra
* data. For queries built using this API, there is no way currently to add
* extra information to this body.</p>
*/
private byte[] body;
/**
* Defines if the body of the message is already parsed.
*/
private boolean isParsed;
/**
* Contains all urns to search for. This attribute is null if urns are not
* in the query.
*/
private Set<URN> queryURNSet;
/**
* Defines the origin IpAddress of the query request.
*/
private byte[] originIpAddress;
/**
* Defines the origin port number of the query request.
*/
private int originPort;
/**
* Creates a new whats new query with the given ttl
* @return
*/
public static QueryMsg createWhatsNewQuery( byte ttl, boolean hasConnectedIncoming )
{
return new QueryMsg( ttl, WHAT_IS_NEW_QUERY_STRING, null,
QueryMsg.IS_PHEX_CAPABLE_OF_XML_RESULTS,
!hasConnectedIncoming,
WHAT_IS_NEW_FEATURE_QUERY_SELECTOR );
}
/**
* Create a query with a new header, a given ttl and search string.
* <p>The header will be modified so that its function property becomes
* MsgHeader.sQuery. The header argument is owned by this object.</p>
*/
public QueryMsg( byte ttl, String aSearchString, URN queryURN,
boolean isRequesterCapableOfXmlResults, boolean isRequesterBehindFirewall )
{
this(ttl, aSearchString, queryURN, isRequesterCapableOfXmlResults,
isRequesterBehindFirewall, NO_FEATURE_QUERY_SELECTOR);
}
/**
* Create a query with a new header, a given ttl and search string.
* <p>The header will be modified so that its function property becomes
* MsgHeader.sQuery. The header argument is owned by this object.</p>
*/
public QueryMsg( byte ttl, String aSearchString, URN queryURN,
boolean isRequesterCapableOfXmlResults, boolean isRequesterBehindFirewall,
int featureQuerySelector )
{// TODO3 extend query to dispatch a couple of URNs, this can be used
// for researching multiple candidates for multiple files. But verify
// that this works with common clients.
super( new MsgHeader( MsgHeader.QUERY_PAYLOAD, ttl, 0 ) );
searchString = aSearchString;
this.featureQuerySelector = featureQuerySelector;
if ( StringUtils.isEmpty( searchString ) )
{
searchString = "\\";
}
if ( queryURN != null )
{
queryURNSet = new HashSet<URN>( 1 );
queryURNSet.add( queryURN );
}
else
{
queryURNSet = Collections.emptySet();
}
minSpeedIsBitBased = true;
requesterIsFirewalled = isRequesterBehindFirewall;
requesterIsXmlResultsCapable = isRequesterCapableOfXmlResults;
try
{
buildBody();
}
catch (IOException e)
{// should never happen
NLogger.error( QueryMsg.class, e, e );
}
getHeader().setDataLength( body.length );
}
/**
* <p>Create a new MsgQuery with its header and body.</p>
*
* <p>The header will be modified so that its function property becomes
* MsgHeader.sQuery. The header argument is owned by this object.</p>
*
* <p>The body is not parsed directly
* cause some queries are just forwarded without the need of being completely
* parsed. This allows the extention data (such as GGEP blocks) to be
* forwarded despite there being no API to modify these.</p>
*
* @param header the MsgHeader to associate with the new message
* @param aBody the message body
*/
public QueryMsg( MsgHeader header, byte[] aBody )
{
super( header );
getHeader().setPayloadType(MsgHeader.QUERY_PAYLOAD);
body = aBody;
// parse the body
parseBody();
}
public QueryMsg( QueryMsg query, byte ttl )
{
super( new MsgHeader( MsgHeader.QUERY_PAYLOAD, 0 ) );
getHeader().copy( query.getHeader() );
getHeader().setTTL( ttl );
this.body = query.body;
this.searchString = query.searchString;
this.featureQuerySelector = query.featureQuerySelector;
this.minSpeedIsBitBased = query.minSpeedIsBitBased;
this.requesterIsFirewalled = query.requesterIsFirewalled;
this.requesterIsXmlResultsCapable = query.requesterIsXmlResultsCapable;
this.isParsed = query.isParsed;
this.queryURNSet = new HashSet<URN>( query.queryURNSet );
}
/**
* Determine whether the query uses the MinSpeed
* field as a 'reclaimed' field, where the bits have individual meanings.
* @return boolean
*/
private boolean isMinSpeedBitBased()
{
return minSpeedIsBitBased;
}
/**
* Determine whether the query source is a firewalled servent.
* This can only be true when the query is using the new MinSpeed meaning.
* @return boolean
*/
public boolean isRequesterFirewalled()
{
return minSpeedIsBitBased && requesterIsFirewalled;
}
/**
* Determine whether the query source is capable of handling XML results.
* This can only be true when the query is using the new MinSpeed meaning.
* @return boolean
*/
public boolean isRequesterXmlResultsCapable()
{
return minSpeedIsBitBased && requesterIsXmlResultsCapable;
}
/**
* Set whether the query uses the MinSpeed
* field as a bit-based field, where the bits have individual meanings.
* @return boolean
*/
private void setMinSpeedIsBitBased(boolean newValue)
{
minSpeedIsBitBased = newValue;
}
/**
* Set whether the query source is a firewalled servent.
* This field will only be used when MinSpeed is bit-based.
* @return boolean
*/
private void setRequesterIsFirewalled(boolean newValue)
{
requesterIsFirewalled = newValue;
}
/**
* Set whether the query source is capable of handling XML results.
* This field will only be used when MinSpeed is bit-based.
* @return boolean
*/
private void setRequesterIsXmlResultsCapable(boolean newValue)
{
requesterIsXmlResultsCapable = newValue;
}
/**
* Utility method -- Determine whether a particular bit in a short is set.
*
* @param shortIn The value whose bit will be checked
* @param bitNumber The bit number to check (0 is least significant, 15 is most significant)
* @return boolean
*/
private static boolean isBitSet(short shortIn, int bitPos)
{
int bitValue = 1 << bitPos;
return (shortIn & bitValue) != 0;
}
/**
* Utility method -- Set a bit in a short.
*
* @param shortIn The value whose bit may be changed.
* @param bitNumber The bit number to set/clear (0 is least significant, 15 is most significant)
* @return boolean
*/
private static short setBit(short shortIn, int bitPos)
{
short mask = (short) (1 << bitPos);
return (short) (shortIn | mask);
}
/**
* Version of setBit() which accepts Objects (for testing)
* @param shortIn
* @param bitPos
* @return short
*/
private static short setBit(Short shortIn, Integer bitPos)
{
return setBit(shortIn.shortValue(), bitPos.intValue());
}
/**
* Version of isBitSet() which accepts Objects (for testing)
* @param shortIn
* @param bitPos
* @return boolean
*/
private static boolean isBitSet(Short shortIn, Integer bitPos)
{
return isBitSet(shortIn.shortValue(), bitPos.intValue());
}
/**
* Returns the feature query selector of the query. Possible values are
* NO_FEATURE_QUERY_SELECTOR, WHAT_IS_NEW_FEATURE_QUERY_SELECTOR
* @return
*/
public int getFeatureQuerySelector()
{
return featureQuerySelector;
}
public boolean isWhatsNewQuery()
{
return featureQuerySelector == WHAT_IS_NEW_FEATURE_QUERY_SELECTOR;
}
/**
* Returns a Iterator of queried URNs to look for.
*/
public URN[] getQueryURNs()
{
URN[] urns = new URN[ queryURNSet.size() ];
return queryURNSet.toArray( urns );
}
/**
* Indicates if the query carrys query urns.
* @return true if the query carrys query urns.
*/
public boolean hasQueryURNs()
{
return !queryURNSet.isEmpty();
}
/**
* <p>Get the search string for this query.</p>
*
* <p>Servents should treat this search string as a list of keywords. They
* should respond with files that match all keywords. They may chose to only
* respond with files with all keywords in the query order. Case will be
* ignored. Wildcards and regular expressions are not supported.</p>
*
* <p>If the query is four spaces " " and TTL=1 and hops=0, it should be
* interpreted as a request for a complete directory listing.</p>
*
* @return the String representation of the query
*/
public String getSearchString()
{
return searchString;
}
/**
* {@inheritDoc}
*/
@Override
public ByteBuffer createMessageBuffer()
{
return ByteBuffer.wrap( body );
}
@Override
public String toString()
{
StringBuffer buf = new StringBuffer(100);
buf.append("[")
.append(getHeader())
.append(", MinSpeedIsBitBased=")
.append(minSpeedIsBitBased);
if (minSpeedIsBitBased)
{
buf.append(", RequesterIsFirewalled=")
.append(requesterIsFirewalled)
.append(", RequesterIsXmlResultsCapable=")
.append(requesterIsXmlResultsCapable);
}
buf.append(", SearchString=")
.append(searchString)
.append("]");
return buf.toString();
}
private void addPhexExtendedOriginGGEP( GGEPBlock ggepBlock )
{
DestAddress[] addresses = new DestAddress[1];
addresses[0] = new DefaultDestAddress( Servent.getInstance().getLocalAddress().getIpAddress(),
Servent.getInstance().getLocalAddress().getPort() );
ggepBlock.addExtension( GGEPBlock.PHEX_EXTENDED_ORIGIN, addresses, 1 );
}
public int getOriginPort()
{
return this.originPort;
}
public byte[] getOriginIpAddress()
{
return this.originIpAddress;
}
private void buildBody()
throws IOException
{
ByteArrayOutputStream bodyStream = new ByteArrayOutputStream( );
short complexMinSpeed = buildComplexMinSpeed();
// we send min speed in big endian byte order since we only care for
// bit based min speed and go according to bit based min speed specs.
IOUtil.serializeShort( complexMinSpeed, bodyStream );
bodyStream.write( searchString.toLowerCase().getBytes("UTF-8") );
bodyStream.write( 0 );
boolean writeGemExtension = false;
if ( queryURNSet.size() == 0 )
{
// request sha1 URLs only
bodyStream.write( (URN.URN_PREFIX + URN.SHA1).getBytes() );
writeGemExtension = true;
}
else
{// we query for urns... add list content to body...
for ( URN urn : queryURNSet )
{
bodyStream.write( urn.getAsString().getBytes() );
}
writeGemExtension = true;
}
// add a possible GGEP extension...
GGEPBlock ggepBlock = new GGEPBlock( true );
// add the feature query header
if ( featureQuerySelector > 0 )
{
ggepBlock.addExtension(GGEPBlock.FEATURE_QUERY_HEADER_ID, featureQuerySelector);
}
if (MessagePrefs.UseExtendedOriginIpAddress.get().booleanValue())
{
addPhexExtendedOriginGGEP(ggepBlock);
}
byte[] ggepData = ggepBlock.getBytes();
if ( ggepData.length > 0 )
{
// only write ggep when we have a extension.
if ( writeGemExtension )
{
bodyStream.write( 0x1c );
}
bodyStream.write(ggepData);
writeGemExtension = true;
}
bodyStream.write( 0 );
body = bodyStream.toByteArray();
}
private void parseBody()
{
try
{
ByteArrayInputStream inStream = new ByteArrayInputStream(body);
// Get & parse the MinSpeed field
// we read min speed in big endian byte order since we only care for
// bit based min speed and go according to bit based min speed specs.
short minSpeedField = IOUtil.deserializeShort(inStream);
parseMinSpeed(minSpeedField);
byte[] queryBytes = IOUtil.readBytesToNull(inStream);
searchString = new String(queryBytes, "UTF-8");
// read extension area... each extension is seperated by a 0x1c FS
// "file separator" character
byte[] extensionBytes = IOUtil.readBytesToNull(inStream);
HUGEBlock hugeBlock = new HUGEBlock( extensionBytes );
queryURNSet = hugeBlock.getURNS();
// no URLs in query.. use empty list.
if (queryURNSet == null)
{
queryURNSet = Collections.emptySet();
}
GGEPBlock[] ggepBlocks = hugeBlock.getGGEPBlocks();
if ( ggepBlocks != null )
{
if ( GGEPBlock.isExtensionHeaderInBlocks(ggepBlocks,
GGEPBlock.FEATURE_QUERY_HEADER_ID ) )
{
featureQuerySelector = GGEPExtension.parseIntExtensionData(
ggepBlocks, GGEPBlock.FEATURE_QUERY_HEADER_ID, 0 );
}
if ( MessagePrefs.UseExtendedOriginIpAddress.get().booleanValue() )
{
try {
byte[] value = GGEPBlock.getExtensionDataInBlocks(ggepBlocks, GGEPBlock.PHEX_EXTENDED_ORIGIN);
originIpAddress = new IpAddress(value).getHostIP();
originPort = IOUtil.deserializeShortLE(value, 4);
}
catch (Exception ex) {
NLogger.error( QueryMsg.class, ex, ex );
}
}
}
}
catch (IOException e)
{
NLogger.error( QueryMsg.class, e, e );
}
}
private void parseMinSpeed(short minSpeedIn)
{
minSpeedIsBitBased = isBitSet(minSpeedIn, MINSPEED_BITBASED_BIT);
// REWORK drop queries without this bit.
if (isMinSpeedBitBased())
// Incoming MinSpeed IS bit-based
{
requesterIsFirewalled = isBitSet(minSpeedIn, MINSPEED_FIREWALL_BIT);
requesterIsXmlResultsCapable = isBitSet(minSpeedIn, MINSPEED_XML_BIT);
}
/*
if (Logger.isLevelLogged(Logger.FINEST))
{
String bin = Integer.toBinaryString(minSpeedIn);
if (bin.length() > 16) bin = bin.substring(16);
StringBuffer buf = new StringBuffer(100);
buf.append("MsgQuery.parseMinSpeed: MinSpeed=")
.append(minSpeedIn)
.append(" (")
.append(bin)
.append(") -- ")
.append(" bit-based: ")
.append(minSpeedIsBitBased)
.append(" firewalled: ")
.append(requesterIsFirewalled)
.append(" xml: ")
.append(requesterIsXmlResultsCapable);
Logger.logMessage(Logger.FINEST, Logger.NETWORK, buf.toString());
}
*/
}
/**
* This method takes all of the discreet local variables and compiles them into
* a short, in the bit-based format for MinSpeed. It is called when the query is
* being serialized for output to another servent.
* @return short containing all of the appropriate bits set
*/
private short buildComplexMinSpeed()
{
// Start with a real minimum speed numeric value
short complexMinSpeed = (short) 0;
// Set any appropriate bits
if (minSpeedIsBitBased)
{
// First, indicate that the field is bit-ased
complexMinSpeed = setBit(complexMinSpeed, MINSPEED_BITBASED_BIT);
// Firewall bit
if (requesterIsFirewalled)
{
complexMinSpeed = setBit(complexMinSpeed, MINSPEED_FIREWALL_BIT);
}
// XML bit
if (requesterIsXmlResultsCapable)
{
complexMinSpeed = setBit(complexMinSpeed, MINSPEED_XML_BIT);
}
}
return complexMinSpeed;
}
}
The table below shows all metrics for QueryMsg.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 54.00 | Number of blocks | |
| BLOCK_COMMENT | 42.00 | Number of block comment lines | |
| COMMENTS | 249.00 | Comment lines | |
| COMMENT_DENSITY | 1.16 | Comment density | |
| COMPARISONS | 13.00 | Number of comparison operators | |
| CYCLOMATIC | 50.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 33.00 | Comments in declarations | |
| DOC_COMMENT | 185.00 | Number of javadoc comment lines | |
| ELOC | 215.00 | Effective lines of code | |
| EXEC_COMMENTS | 18.00 | Comments in executable code | |
| EXITS | 54.00 | Procedure exits | |
| FUNCTIONS | 29.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 62.94 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 65.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 | 1.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 | 5.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 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 | 18.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 2.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 3.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 | 2.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 4.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.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 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 1.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.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 | 1.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 | 1.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 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 | 643.00 | Number of lines in the source file | |
| LINE_COMMENT | 22.00 | Number of line comments | |
| LOC | 320.00 | Lines of code | |
| LOGICAL_LINES | 136.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 556.00 | Number of operands | |
| OPERATORS | 1127.00 | Number of operators | |
| PARAMS | 30.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1683.00 | Halstead program length | |
| PROGRAM_VOCAB | 260.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 35.00 | Number of return points from functions | |
| SIZE | 21216.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 212.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 74.00 | Number of whitespace lines | |