ForMeReplyHandler.java
| Index Score | ||
|---|---|---|
 |
 |
com.limegroup.gnutella |
 |
 |
FrostWire |
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 | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| LINE_COMMENT | Number of line comments | |
| EXEC_COMMENTS | Comments in executable code | |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0264 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| RETURNS | Number of return points from functions | |
| FUNCTIONS | Number of function declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0076 | JAVA0076 Use of magic number | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| ELOC | Effective lines of code | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| LOOPS | Number of loops | |
| PARAMS | Number of formal parameter declarations | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
package com.limegroup.gnutella;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.UnknownHostException;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.limewire.collection.FixedsizeForgetfulHashMap;
import org.limewire.collection.IntWrapper;
import org.limewire.io.NetworkUtils;
import org.limewire.security.SecureMessage;
import org.limewire.security.SecureMessageCallback;
import org.limewire.security.SecureMessageVerifier;
import org.limewire.service.ErrorService;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.google.inject.name.Named;
import com.limegroup.gnutella.connection.RoutedConnection;
import com.limegroup.gnutella.filters.IPFilter;
import com.limegroup.gnutella.messages.BadPacketException;
import com.limegroup.gnutella.messages.Message;
import com.limegroup.gnutella.messages.PingReply;
import com.limegroup.gnutella.messages.PushRequest;
import com.limegroup.gnutella.messages.QueryReply;
import com.limegroup.gnutella.messages.vendor.SimppVM;
import com.limegroup.gnutella.search.SearchResultHandler;
import com.limegroup.gnutella.settings.ApplicationSettings;
import com.limegroup.gnutella.settings.SharingSettings;
import com.limegroup.gnutella.settings.UploadSettings;
import com.limegroup.gnutella.xml.LimeXMLDocument;
import com.limegroup.gnutella.xml.LimeXMLDocumentHelper;
import com.limegroup.gnutella.xml.LimeXMLUtils;
/**
* This is the class that goes in the route table when a request is
* sent whose reply is for me.
*/
@Singleton
public final class ForMeReplyHandler implements ReplyHandler, SecureMessageCallback {
private static final Log LOG = LogFactory.getLog(ForMeReplyHandler.class);
/**
* Keeps track of what hosts have sent us PushRequests lately.
*/
private final Map<String, IntWrapper> PUSH_REQUESTS =
Collections.synchronizedMap(new FixedsizeForgetfulHashMap<String, IntWrapper>(200));
private final Map<GUID, GUID> GUID_REQUESTS =
Collections.synchronizedMap(new FixedsizeForgetfulHashMap<GUID, GUID>(200));
private final NetworkManager networkManager;
private final SecureMessageVerifier secureMessageVerifier;
private final Provider<ConnectionManager> connectionManager;
private final Provider<SearchResultHandler> searchResultHandler;
private final Provider<DownloadManager> downloadManager;
private final Provider<PushManager> pushManager;
private final ScheduledExecutorService backgroundExecutor;
private final ApplicationServices applicationServices;
private final ConnectionServices connectionServices;
private final LimeXMLDocumentHelper limeXMLDocumentHelper;
private final Provider<IPFilter> ipFilterProvider;
@Inject
ForMeReplyHandler(NetworkManager networkManager,
SecureMessageVerifier secureMessageVerifier,
Provider<ConnectionManager> connectionManager,
Provider<SearchResultHandler> searchResultHandler,
Provider<DownloadManager> downloadManager,
Provider<Acceptor> acceptor, Provider<PushManager> pushManager,
@Named("backgroundExecutor") ScheduledExecutorService backgroundExecutor,
ApplicationServices applicationServices,
ConnectionServices connectionServices,
LimeXMLDocumentHelper limeXMLDocumentHelper,
Provider<IPFilter> ipFilterProvider) {
this.networkManager = networkManager;
this.secureMessageVerifier = secureMessageVerifier;
this.connectionManager = connectionManager;
this.searchResultHandler = searchResultHandler;
this.downloadManager = downloadManager;
this.pushManager = pushManager;
this.backgroundExecutor = backgroundExecutor;
this.applicationServices = applicationServices;
this.connectionServices = connectionServices;
this.limeXMLDocumentHelper = limeXMLDocumentHelper;
this.ipFilterProvider = ipFilterProvider;
//Clear push requests every 30 seconds.
//TODO: move to initializer
this.backgroundExecutor.scheduleWithFixedDelay(new Runnable() {
public void run() {
PUSH_REQUESTS.clear();
}
}, 30 * 1000, 30 * 1000, TimeUnit.MILLISECONDS);
}
public void handlePingReply(PingReply pingReply, ReplyHandler handler) {
//Kill incoming connections that don't share. Note that we randomly
//allow some freeloaders. (Hopefully they'll get some stuff and then
//share!) Note that we only consider killing them on the first ping.
//(Message 1 is their ping, message 2 is their reply to our ping.)
if ((pingReply.getHops() <= 1)
&& (handler.getNumMessagesReceived() <= 2)
&& (!handler.isOutgoing())
&& (handler.isKillable())
&& (pingReply.getFiles() < SharingSettings.FREELOADER_FILES.getValue())
&& ((int)(Math.random()*100.f) >
SharingSettings.FREELOADER_ALLOWED.getValue())
&& (handler instanceof RoutedConnection)
&& (handler.isStable())) {
connectionManager.get().remove((RoutedConnection)handler);
}
}
public void handleQueryReply(QueryReply reply, ReplyHandler handler) {
// do not allow a faked multicast reply.
if(reply.isFakeMulticast())
return;
// Drop if it's a reply to mcast and conditions aren't met ...
if( reply.isReplyToMulticastQuery() ) {
if( reply.isTCP() )
return; // shouldn't be on TCP.
if( reply.getHops() != 1 || reply.getTTL() != 0 )
return; // should only have hopped once.
}
// XML must be added to the response first, so that
// whomever calls toRemoteFileDesc on the response
// will create the cachedRFD with the correct XML.
boolean validResponses = addXMLToResponses(reply, limeXMLDocumentHelper);
// responses invalid? exit.
if(!validResponses)
return;
// check for unwanted results after xml has been constructed
if(handler != null && handler.isPersonalSpam(reply)) return;
if(reply.hasSecureData() && ApplicationSettings.USE_SECURE_RESULTS.getValue()) {
secureMessageVerifier.verify(reply, this);
} else {
routeQueryReplyInternal(reply);
}
}
/** Notification that a message is secure. Currently only possible for a QueryReply. */
public void handleSecureMessage(SecureMessage sm, boolean passed) {
if (passed)
routeQueryReplyInternal((QueryReply) sm);
}
/** Passes the QueryReply off to where it should go. */
private void routeQueryReplyInternal(QueryReply reply) {
searchResultHandler.get().handleQueryReply(reply);
downloadManager.get().handleQueryReply(reply);
}
/**
* Adds XML to the responses in a QueryReply.
*/
public static boolean addXMLToResponses(QueryReply qr, LimeXMLDocumentHelper limeXMLDocumentHelper) {
// get xml collection string, then get dis-aggregated docs, then
// in loop
// you can match up metadata to responses
String xmlCollectionString = "";
try {
LOG.trace("Trying to do uncompress XML.....");
byte[] xmlCompressed = qr.getXMLBytes();
if (xmlCompressed.length > 1) {
byte[] xmlUncompressed = LimeXMLUtils.uncompress(xmlCompressed);
xmlCollectionString = new String(xmlUncompressed,"UTF-8");
}
} catch (UnsupportedEncodingException use) {
//b/c this should never happen, we will show and error
//if it ever does for some reason.
//we won't throw a BadPacketException here but we will show it.
//the uee will effect the xml part of the reply but we could
//still show the reply so there shouldn't be any ill effect if
//xmlCollectionString is ""
ErrorService.error(use);
} catch (IOException ignored) {
}
// valid response, no XML in EQHD.
if(xmlCollectionString.equals(""))
return true;
Response[] responses;
int responsesLength;
try {
responses = qr.getResultsArray();
responsesLength = responses.length;
} catch(BadPacketException bpe) {
LOG.trace("Unable to get responses", bpe);
return false;
}
if(LOG.isDebugEnabled())
LOG.debug("xmlCollectionString = " + xmlCollectionString);
List<LimeXMLDocument[]> allDocsArray =
limeXMLDocumentHelper.getDocuments(xmlCollectionString,
responsesLength);
for(int i = 0; i < responsesLength; i++) {
Response response = responses[i];
LimeXMLDocument[] metaDocs;
for(int schema = 0; schema < allDocsArray.size(); schema++) {
metaDocs = allDocsArray.get(schema);
// If there are no documents in this schema, try another.
if(metaDocs == null)
continue;
// If this schema had a document for this response, use it.
if(metaDocs[i] != null) {
response.setDocument(metaDocs[i]);
break; // we only need one, so break out.
}
}
}
return true;
}
/**
* If there are problems with the request, just ignore it.
* There's no point in sending them a GIV to have them send a GET
* just to return a 404 or Busy or Malformed Request, etc..
*/
public void handlePushRequest(PushRequest pushRequest, ReplyHandler handler){
//Ignore push request from banned hosts.
if (handler.isPersonalSpam(pushRequest))
return;
byte[] ip = pushRequest.getIP();
String h = NetworkUtils.ip2string(ip);
// check whether we serviced this push request already
GUID guid = new GUID(pushRequest.getGUID());
if (GUID_REQUESTS.put(guid, guid) != null)
return;
// make sure the guy isn't hammering us
IntWrapper i = PUSH_REQUESTS.get(h);
if(i == null) {
i = new IntWrapper(1);
PUSH_REQUESTS.put(h, i);
} else {
i.addInt(1);
// if we're over the max push requests for this host, exit.
if(i.getInt() > UploadSettings.MAX_PUSHES_PER_HOST.getValue())
return;
}
// if the IP is banned, don't accept it
if (!ipFilterProvider.get().allow(ip))
return;
int port = pushRequest.getPort();
// if invalid port, exit
if (!NetworkUtils.isValidPort(port) )
return;
String req_guid_hexstring =
(new GUID(pushRequest.getClientGUID())).toString();
pushManager.get().acceptPushUpload(h, port, req_guid_hexstring,
pushRequest.isMulticast(), // force accept
pushRequest.isFirewallTransferPush(),
pushRequest.isTLSCapable());
}
public boolean isOpen() {
//I'm always ready to handle replies.
return true;
}
public int getNumMessagesReceived() {
return 0;
}
public void countDroppedMessage() {}
// inherit doc comment
public boolean isSupernodeClientConnection() {
return false;
}
public boolean isPersonalSpam(Message m) {
return false;
}
public void updateHorizonStats(PingReply pingReply) {
// TODO:: we should probably actually update the stats with this pong
}
public boolean isOutgoing() {
return false;
}
// inherit doc comment
public boolean isKillable() {
return false;
}
/**
* Implements <tt>ReplyHandler</tt> interface. Returns whether this
* node is a leaf or an Ultrapeer.
*
* @return <tt>true</tt> if this node is a leaf node, otherwise
* <tt>false</tt>
*/
public boolean isLeafConnection() {
return !connectionServices.isSupernode();
}
/**
* Returns whether or not this connection is a high-degree connection,
* meaning that it maintains a high number of intra-Ultrapeer connections.
* Because this connection really represents just this node, it always
* returns <tt>false</tt>/
*
* @return <tt>false</tt>, since this reply handler signifies only this
* node -- its connections don't matter.
*/
public boolean isHighDegreeConnection() {
return false;
}
/**
* Returns <tt>false</tt>, since this connection is me, and it's not
* possible to pass query routing tables to oneself.
*
* @return <tt>false</tt>, since you cannot pass query routing tables
* to yourself
*/
public boolean isUltrapeerQueryRoutingConnection() {
return false;
}
/**
* Returns <tt>false</tt>, as this node is not a "connection"
* in the first place, and so could never have sent the requisite
* headers.
*
* @return <tt>false</tt>, as this node is not a real connection
*/
public boolean isGoodUltrapeer() {
return false;
}
/**
* Returns <tt>false</tt>, as this node is not a "connection"
* in the first place, and so could never have sent the requisite
* headers.
*
* @return <tt>false</tt>, as this node is not a real connection
*/
public boolean isGoodLeaf() {
return false;
}
/**
* Returns <tt>true</tt>, since we always support pong caching.
*
* @return <tt>true</tt> since this node always supports pong
* caching (since it's us)
*/
public boolean supportsPongCaching() {
return true;
}
/**
* Returns whether or not to allow new pings from this <tt>ReplyHandler</tt>.
* Since this ping is from us, we'll always allow it.
*
* @return <tt>true</tt> since this ping is from us
*/
public boolean allowNewPings() {
return true;
}
// inherit doc comment
public InetAddress getInetAddress() {
try {
return InetAddress.
getByName(NetworkUtils.ip2string(networkManager.getAddress()));
} catch(UnknownHostException e) {
// may want to do something else here if we ever use this!
return null;
}
}
public InetSocketAddress getInetSocketAddress() {
return new InetSocketAddress(getInetAddress(), getPort());
}
public int getPort() {
return networkManager.getPort();
}
public String getAddress() {
return NetworkUtils.ip2string(networkManager.getAddress());
}
public void handleSimppVM(SimppVM simppVM) {
throw new IllegalStateException("ForMeReplyHandler asked to send vendor message");
}
/**
* Returns <tt>true</tt> to indicate that this node is always stable.
* Simply the fact that this method is being called indicates that the
* code is alive and stable (I think, therefore I am...).
*
* @return <tt>true</tt> since, this node is always stable
*/
public boolean isStable() {
return true;
}
public String getLocalePref() {
return ApplicationSettings.LANGUAGE.getValue();
}
/**
* drops the message
*/
public void reply(Message m){}
public byte[] getClientGUID() {
return applicationServices.getMyGUID();
}
}
The table below shows all metrics for ForMeReplyHandler.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 49.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 113.00 | Comment lines | |
| COMMENT_DENSITY | 0.49 | Comment density | |
| COMPARISONS | 30.00 | Number of comparison operators | |
| CYCLOMATIC | 62.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 18.00 | Comments in declarations | |
| DOC_COMMENT | 76.00 | Number of javadoc comment lines | |
| ELOC | 230.00 | Effective lines of code | |
| EXEC_COMMENTS | 21.00 | Comments in executable code | |
| EXITS | 69.00 | Procedure exits | |
| FUNCTIONS | 32.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 54.97 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 73.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.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 | 1.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 | 14.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 | 4.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 3.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.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 | 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 | 1.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 | 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 | 109.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 | 2.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 | 3.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 2.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 | 447.00 | Number of lines in the source file | |
| LINE_COMMENT | 37.00 | Number of line comments | |
| LOC | 272.00 | Lines of code | |
| LOGICAL_LINES | 141.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 608.00 | Number of operands | |
| OPERATORS | 1194.00 | Number of operators | |
| PARAMS | 27.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1802.00 | Halstead program length | |
| PROGRAM_VOCAB | 320.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 46.00 | Number of return points from functions | |
| SIZE | 15898.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 271.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 49.00 | Number of unique operators | |
| WHITESPACE | 62.00 | Number of whitespace lines | |