diff options
| author | simonbrandhof <simon.brandhof@gmail.com> | 2010-12-03 11:50:44 +0000 |
|---|---|---|
| committer | simonbrandhof <simon.brandhof@gmail.com> | 2010-12-03 11:50:44 +0000 |
| commit | 4de9f9f8e864a3564e6f2fe316424ec80280e5a4 (patch) | |
| tree | 2c8c879a8fbabd4cb92c5b4f4f38dd28cc277136 /plugins/sonar-findbugs-plugin | |
| parent | ef39d74467a4bf83bbf9bac8765407aba4706502 (diff) | |
| download | sonarqube-4de9f9f8e864a3564e6f2fe316424ec80280e5a4.tar.gz sonarqube-4de9f9f8e864a3564e6f2fe316424ec80280e5a4.zip | |
SONAR-2007 remove iso categories from checkstyle, pmd and findbugs
Diffstat (limited to 'plugins/sonar-findbugs-plugin')
| -rw-r--r-- | plugins/sonar-findbugs-plugin/src/main/resources/org/sonar/plugins/findbugs/rules.xml | 754 |
1 files changed, 377 insertions, 377 deletions
diff --git a/plugins/sonar-findbugs-plugin/src/main/resources/org/sonar/plugins/findbugs/rules.xml b/plugins/sonar-findbugs-plugin/src/main/resources/org/sonar/plugins/findbugs/rules.xml index 909109f919c..577575cd2c5 100644 --- a/plugins/sonar-findbugs-plugin/src/main/resources/org/sonar/plugins/findbugs/rules.xml +++ b/plugins/sonar-findbugs-plugin/src/main/resources/org/sonar/plugins/findbugs/rules.xml @@ -3,14 +3,14 @@ <rule key="BC_IMPOSSIBLE_DOWNCAST" priority="BLOCKER"> <name><![CDATA[Correctness - Impossible downcast]]></name> <configKey><![CDATA[BC_IMPOSSIBLE_DOWNCAST]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[This cast will always throw a ClassCastException. The analysis believes it knows the precise type of the value being cast, and the attempt to downcast it to a subtype will always fail by throwing a ClassCastException.]]></description> </rule> <rule key="BC_IMPOSSIBLE_DOWNCAST_OF_TOARRAY" priority="BLOCKER"> <name><![CDATA[Correctness - Impossible downcast of toArray() result]]></name> <configKey><![CDATA[BC_IMPOSSIBLE_DOWNCAST_OF_TOARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code is casting the result of calling toArray() on a collection to a type more specific than Object[], as in:</p> <pre> String[] getAsArray(Collection<String> c) { @@ -24,21 +24,21 @@ <rule key="EC_INCOMPATIBLE_ARRAY_COMPARE" priority="BLOCKER"> <name><![CDATA[Correctness - equals(...) used to compare incompatible arrays]]></name> <configKey><![CDATA[EC_INCOMPATIBLE_ARRAY_COMPARE]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[This method invokes the .equals(Object o) to compare two arrays, but the arrays of of incompatible types (e.g., String[] and StringBuffer[], or String[] and int[]). They will never be equal. In addition, when equals(...) is used to compare arrays it only checks to see if they are the same array, and ignores the contents of the arrays.]]></description> </rule> <rule key="EC_INCOMPATIBLE_ARRAY_COMPARE" priority="BLOCKER"> <name><![CDATA[Correctness - equals(...) used to compare incompatible arrays]]></name> <configKey><![CDATA[EC_INCOMPATIBLE_ARRAY_COMPARE]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[This method invokes the .equals(Object o) to compare two arrays, but the arrays of of incompatible types (e.g., String[] and StringBuffer[], or String[] and int[]). They will never be equal. In addition, when equals(...) is used to compare arrays it only checks to see if they are the same array, and ignores the contents of the arrays.]]></description> </rule> <rule key="LG_LOST_LOGGER_DUE_TO_WEAK_REFERENCE" priority="MAJOR"> <name><![CDATA[Correctness - Potential lost logger changes due to weak reference in OpenJDK ]]></name> <configKey><![CDATA[LG_LOST_LOGGER_DUE_TO_WEAK_REFERENCE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>OpenJDK introduces a potential incompatibility. In particular, the java.util.logging.Logger behavior has changed. Instead of using strong references, it now uses weak references internally. That's a reasonable change, but unfortunately some code relies on the old behavior - when changing logger configuration, it simply drops the logger reference. That means that the garbage collector is free to reclaim that memory, which means that the logger configuration is lost. For example, consider:</p> </pre> public static void initLogging() throws Exception { @@ -61,7 +61,7 @@ <rule key="NP_CLOSING_NULL" priority="BLOCKER"> <name><![CDATA[Correctness - close() invoked on a value that is always null]]></name> <configKey><![CDATA[NP_CLOSING_NULL]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[close() is being invoked on a value that is always null. If this statement is executed, a null pointer exception will occur. But the big risk here you never close something that should be closed.]]></description> </rule> @@ -69,7 +69,7 @@ <rule key="RC_REF_COMPARISON_BAD_PRACTICE" priority="MAJOR"> <name><![CDATA[Correctness - Suspicious reference comparison to constant]]></name> <configKey><![CDATA[RC_REF_COMPARISON_BAD_PRACTICE]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[This method compares a reference value to a constant using the == or != operator, where the correct way to compare instances of this type is generally with the equals() method. It is possible to create distinct instances that are equal but do not compare as == since they are different objects. Examples of classes which should generally not be compared by reference are java.lang.Integer, java.lang.Float, etc.]]></description> </rule> @@ -77,7 +77,7 @@ <rule key="RC_REF_COMPARISON_BAD_PRACTICE_BOOLEAN" priority="MAJOR"> <name><![CDATA[Correctness - Suspicious reference comparison of Boolean values]]></name> <configKey><![CDATA[RC_REF_COMPARISON_BAD_PRACTICE_BOOLEAN]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[This method compares two Boolean values using the == or != operator. Normally, there are only two Boolean values (Boolean.TRUE and Boolean.FALSE), but it is possible to create other Boolean objects using the new Boolean(b) constructor. It is best to avoid such objects, but if they do exist, then checking Boolean objects for equality using == or != will give results than are different than you would get using .equals(...)]]></description> </rule> @@ -85,7 +85,7 @@ <rule key="RV_RETURN_VALUE_OF_PUTIFABSENT_IGNORED" priority="MAJOR"> <name><![CDATA[Correctness - Return value of putIfAbsent ignored, value passed to putIfAbsent reused ]]></name> <configKey><![CDATA[RV_RETURN_VALUE_OF_PUTIFABSENT_IGNORED]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[The putIfAbsent method is typically used to ensure that a single value is associated with a given key (the first value for which put if absent succeeds). If you ignore the return value and retain a reference to the value passed in, you run the risk of retaining a value that is not the one that is associated with the key in the map. If it matters which one you use and you use the one that isn't stored in the map, your program will behave incorrectly.]]></description> </rule> @@ -93,7 +93,7 @@ <rule key="SIC_THREADLOCAL_DEADLY_EMBRACE" priority="MAJOR"> <name><![CDATA[Correctness - Deadly embrace of non-static inner class and thread local]]></name> <configKey><![CDATA[SIC_THREADLOCAL_DEADLY_EMBRACE]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[This class is an inner class, but should probably be a static inner class. As it is, there is a serious danger of a deadly embrace between the inner class and the thread local in the outer class. Because the inner class isn't static, it retains a reference to the outer class. If the thread local contains a reference to an instance of the inner class, the inner and outer instance will both be reachable and not eligible for garbage collection.]]></description> </rule> @@ -101,7 +101,7 @@ <rule key="UR_UNINIT_READ_CALLED_FROM_SUPER_CONSTRUCTOR" priority="MAJOR"> <name><![CDATA[Correctness - Uninitialized read of field method called from constructor of superclass]]></name> <configKey><![CDATA[UR_UNINIT_READ_CALLED_FROM_SUPER_CONSTRUCTOR]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This method is invoked in the constructor of of the superclass. At this point, the fields of the class have not yet initialized. To make this more concrete, consider the following classes:</p> <pre> abstract class A { @@ -127,7 +127,7 @@ <rule key="VA_FORMAT_STRING_EXPECTED_MESSAGE_FORMAT_SUPPLIED" priority="MAJOR"> <name><![CDATA[Correctness - MessageFormat supplied where printf style format expected ]]></name> <configKey><![CDATA[VA_FORMAT_STRING_EXPECTED_MESSAGE_FORMAT_SUPPLIED]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[A method is called that expects a Java printf format string and a list of arguments. However, the format string doesn't contain any format specifiers (e.g., %s) but does contain message format elements (e.g., {0}). It is likely that the code is supplying a MessageFormat string when a printf-style format string is required. At runtime, all of the arguments will be ignored and the format string will be returned exactly as provided without any formatting.]]></description> </rule> @@ -137,32 +137,32 @@ <rule key="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR" priority="MINOR"> <name><![CDATA[Correctness - Field not initialized in constructor]]></name> <configKey><![CDATA[UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This field is never initialized within any constructor, and is therefore could be null after the object is constructed. This could be a either an error or a questionable design, since it means a null pointer exception will be generated if that field is dereferenced before being initialized.</p>]]></description> </rule> <rule key="NP_UNWRITTEN_FIELD" priority="MAJOR"> <name><![CDATA[Correctness - Read of unwritten field]]></name> <configKey><![CDATA[NP_UNWRITTEN_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>The program is dereferencing a field that does not seem to ever have a non-null value written to it. Dereferencing this value will generate a null pointer exception.</p>]]></description> </rule> <rule key="UWF_UNWRITTEN_FIELD" priority="MINOR"> <name><![CDATA[Correctness - Unwritten field]]></name> <configKey><![CDATA[UWF_UNWRITTEN_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This field is never written. All reads of it will return the default value. Check for errors (should it have been initialized?), or remove it if it is useless.</p>]]></description> </rule> <rule key="SKIPPED_CLASS_TOO_BIG" priority="MINOR"> <name><![CDATA[Dodgy - Class too big for analysis]]></name> <configKey><![CDATA[SKIPPED_CLASS_TOO_BIG]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p>This class is bigger than can be effectively handled, and was not fully analyzed for errors. </p>]]></description> </rule> <rule key="DMI_SCHEDULED_THREAD_POOL_EXECUTOR_WITH_ZERO_CORE_THREADS" priority="MINOR"> <name><![CDATA[Correctness - Creation of ScheduledThreadPoolExecutor with zero core threads]]></name> <configKey><![CDATA[DMI_SCHEDULED_THREAD_POOL_EXECUTOR_WITH_ZERO_CORE_THREADS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html#ScheduledThreadPoolExecutor(int)">Javadoc</a>) A ScheduledThreadPoolExecutor with zero core threads will never execute anything; changes to the max pool size are ignored. </p>]]></description> @@ -170,7 +170,7 @@ A ScheduledThreadPoolExecutor with zero core threads will never execute anything <rule key="DMI_FUTILE_ATTEMPT_TO_CHANGE_MAXPOOL_SIZE_OF_SCHEDULED_THREAD_POOL_EXECUTOR" priority="MINOR"> <name><![CDATA[Correctness - Futile attempt to change max pool size of ScheduledThreadPoolExecutor]]></name> <configKey><![CDATA[DMI_FUTILE_ATTEMPT_TO_CHANGE_MAXPOOL_SIZE_OF_SCHEDULED_THREAD_POOL_EXECUTOR]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html">Javadoc</a>) While ScheduledThreadPoolExecutor inherits from ThreadPoolExecutor, a few of the inherited tuning methods are not useful for it. In particular, because it acts as a fixed-sized pool using corePoolSize threads and an unbounded queue, adjustments to maximumPoolSize have no useful effect. </p>]]></description> @@ -178,21 +178,21 @@ While ScheduledThreadPoolExecutor inherits from ThreadPoolExecutor, a few of the <rule key="DMI_UNSUPPORTED_METHOD" priority="MAJOR"> <name><![CDATA[Dodgy - Call to unsupported method]]></name> <configKey><![CDATA[DMI_UNSUPPORTED_METHOD]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p>All targets of this method invocation throw an UnsupportedOperationException. </p>]]></description> </rule> <rule key="DMI_EMPTY_DB_PASSWORD" priority="CRITICAL"> <name><![CDATA[Security - Empty database password]]></name> <configKey><![CDATA[DMI_EMPTY_DB_PASSWORD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code creates a database connect using a blank or empty password. This indicates that the database is not protected by a password. </p>]]></description> </rule> <rule key="DMI_CONSTANT_DB_PASSWORD" priority="BLOCKER"> <name><![CDATA[Security - Hardcoded constant database password]]></name> <configKey><![CDATA[DMI_CONSTANT_DB_PASSWORD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code creates a database connect using a hardcoded, constant password. Anyone with access to either the source code or the compiled code can easily learn the password. </p>]]></description> @@ -200,7 +200,7 @@ While ScheduledThreadPoolExecutor inherits from ThreadPoolExecutor, a few of the <rule key="HRS_REQUEST_PARAMETER_TO_COOKIE" priority="MAJOR"> <name><![CDATA[Security - HTTP cookie formed from untrusted input]]></name> <configKey><![CDATA[HRS_REQUEST_PARAMETER_TO_COOKIE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code constructs an HTTP Cookie using an untrusted HTTP parameter. If this cookie is added to an HTTP response, it will allow a HTTP response splitting vulnerability. See <a href="http://en.wikipedia.org/wiki/HTTP_response_splitting">http://en.wikipedia.org/wiki/HTTP_response_splitting</a> for more information.</p> @@ -213,7 +213,7 @@ consider using a commercial static analysis or pen-testing tool. <rule key="HRS_REQUEST_PARAMETER_TO_HTTP_HEADER" priority="MAJOR"> <name><![CDATA[Security - HTTP Response splitting vulnerability]]></name> <configKey><![CDATA[HRS_REQUEST_PARAMETER_TO_HTTP_HEADER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code directly writes an HTTP parameter to an HTTP header, which allows for a HTTP response splitting vulnerability. See <a href="http://en.wikipedia.org/wiki/HTTP_response_splitting">http://en.wikipedia.org/wiki/HTTP_response_splitting</a> for more information.</p> @@ -226,7 +226,7 @@ consider using a commercial static analysis or pen-testing tool. <rule key="XSS_REQUEST_PARAMETER_TO_SERVLET_WRITER" priority="CRITICAL"> <name><![CDATA[Security - Servlet reflected cross site scripting vulnerability]]></name> <configKey><![CDATA[XSS_REQUEST_PARAMETER_TO_SERVLET_WRITER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code directly writes an HTTP parameter to Servlet output, which allows for a reflected cross site scripting vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a> for more information.</p> @@ -239,7 +239,7 @@ consider using a commercial static analysis or pen-testing tool. <rule key="XSS_REQUEST_PARAMETER_TO_SEND_ERROR" priority="CRITICAL"> <name><![CDATA[Security - Servlet reflected cross site scripting vulnerability]]></name> <configKey><![CDATA[XSS_REQUEST_PARAMETER_TO_SEND_ERROR]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code directly writes an HTTP parameter to a Server error page (using HttpServletResponse.sendError). Echoing this untrusted input allows for a reflected cross site scripting vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a> @@ -253,7 +253,7 @@ consider using a commercial static analysis or pen-testing tool. <rule key="XSS_REQUEST_PARAMETER_TO_JSP_WRITER" priority="CRITICAL"> <name><![CDATA[Security - JSP reflected cross site scripting vulnerability]]></name> <configKey><![CDATA[XSS_REQUEST_PARAMETER_TO_JSP_WRITER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This code directly writes an HTTP parameter to JSP output, which allows for a cross site scripting vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a> for more information.</p> @@ -266,7 +266,7 @@ consider using a commercial static analysis or pen-testing tool. <rule key="SW_SWING_METHODS_INVOKED_IN_SWING_THREAD" priority="MAJOR"> <name><![CDATA[Bad practice - Certain swing methods needs to be invoked in Swing thread]]></name> <configKey><![CDATA[SW_SWING_METHODS_INVOKED_IN_SWING_THREAD]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>(<a href="http://java.sun.com/developer/JDCTechTips/2003/tt1208.html#1">From JDC Tech Tip</a>): The Swing methods show(), setVisible(), and pack() will create the associated peer for the frame. With the creation of the peer, the system creates the event dispatch thread. @@ -280,21 +280,21 @@ visible), they could trigger listener notification on the event dispatch thread. <rule key="IL_INFINITE_LOOP" priority="CRITICAL"> <name><![CDATA[Correctness - An apparent infinite loop]]></name> <configKey><![CDATA[IL_INFINITE_LOOP]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This loop doesn't seem to have a way to terminate (other than by perhaps throwing an exception).</p>]]></description> </rule> <rule key="IL_INFINITE_RECURSIVE_LOOP" priority="CRITICAL"> <name><![CDATA[Correctness - An apparent infinite recursive loop]]></name> <configKey><![CDATA[IL_INFINITE_RECURSIVE_LOOP]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This method unconditionally invokes itself. This would seem to indicate an infinite recursive loop that will result in a stack overflow.</p>]]></description> </rule> <rule key="IL_CONTAINER_ADDED_TO_ITSELF" priority="CRITICAL"> <name><![CDATA[Correctness - A collection is added to itself]]></name> <configKey><![CDATA[IL_CONTAINER_ADDED_TO_ITSELF]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>A collection is added to itself. As a result, computing the hashCode of this set will throw a StackOverflowException. </p>]]></description> @@ -303,7 +303,7 @@ set will throw a StackOverflowException. <name> <![CDATA[Multithreaded correctness - A volatile reference to an array doesn't treat the array elements as volatile]]></name> <configKey><![CDATA[VO_VOLATILE_REFERENCE_TO_ARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This declares a volatile reference to an array, which might not be what you want. With a volatile reference to an array, reads and writes of the reference to the array are treated as volatile, but the array elements @@ -314,7 +314,7 @@ in Java 5.0).</p>]]></description> <rule key="UI_INHERITANCE_UNSAFE_GETRESOURCE" priority="MAJOR"> <name><![CDATA[Bad practice - Usage of GetResource may be unsafe if class is extended]]></name> <configKey><![CDATA[UI_INHERITANCE_UNSAFE_GETRESOURCE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>Calling <code>this.getClass().getResource(...)</code> could give results other than expected if this class is extended by a class in another package.</p>]]></description> @@ -322,7 +322,7 @@ another package.</p>]]></description> <rule key="NP_BOOLEAN_RETURN_NULL" priority="MAJOR"> <name><![CDATA[Bad practice - Method with Boolean return type returns explicit null]]></name> <configKey><![CDATA[NP_BOOLEAN_RETURN_NULL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> A method that returns either Boolean.TRUE, Boolean.FALSE or null is an accident waiting to happen. This method can be invoked as though it returned a value of type boolean, and @@ -333,7 +333,7 @@ another package.</p>]]></description> <rule key="NP_SYNC_AND_NULL_CHECK_FIELD" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Synchronize and null check on the same field.]]></name> <configKey><![CDATA[NP_SYNC_AND_NULL_CHECK_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>Since the field is synchronized on, it seems not likely to be null. If it is null and then synchronized on a NullPointerException will be thrown and the check would be pointless. Better to synchronize on @@ -342,7 +342,7 @@ another field.</p>]]></description> <rule key="RpC_REPEATED_CONDITIONAL_TEST" priority="MAJOR"> <name><![CDATA[Correctness - Repeated conditional tests]]></name> <configKey><![CDATA[RpC_REPEATED_CONDITIONAL_TEST]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>The code contains a conditional test is performed twice, one right after the other (e.g., <code>x == 0 || x == 0</code>). Perhaps the second occurrence is intended to be something else (e.g., <code>x == 0 || y == 0</code>). @@ -351,7 +351,7 @@ another field.</p>]]></description> <rule key="AM_CREATES_EMPTY_ZIP_FILE_ENTRY" priority="MAJOR"> <name><![CDATA[Bad practice - Creates an empty zip file entry]]></name> <configKey><![CDATA[AM_CREATES_EMPTY_ZIP_FILE_ENTRY]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>The code calls <code>putNextEntry()</code>, immediately followed by a call to <code>closeEntry()</code>. This results in an empty ZipFile entry. The contents of the entry @@ -362,7 +362,7 @@ should be written to the ZipFile between the calls to <rule key="AM_CREATES_EMPTY_JAR_FILE_ENTRY" priority="MAJOR"> <name><![CDATA[Bad practice - Creates an empty jar file entry]]></name> <configKey><![CDATA[AM_CREATES_EMPTY_JAR_FILE_ENTRY]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>The code calls <code>putNextEntry()</code>, immediately followed by a call to <code>closeEntry()</code>. This results in an empty JarFile entry. The contents of the entry @@ -373,7 +373,7 @@ should be written to the JarFile between the calls to <rule key="IMSE_DONT_CATCH_IMSE" priority="MAJOR"> <name><![CDATA[Bad practice - Dubious catching of IllegalMonitorStateException]]></name> <configKey><![CDATA[IMSE_DONT_CATCH_IMSE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>IllegalMonitorStateException is generally only thrown in case of a design flaw in your code (calling wait or notify on an object you do not hold a lock on).</p>]]></description> @@ -381,7 +381,7 @@ should be written to the JarFile between the calls to <rule key="FL_MATH_USING_FLOAT_PRECISION" priority="CRITICAL"> <name><![CDATA[Correctness - Method performs math using floating point precision]]></name> <configKey><![CDATA[FL_MATH_USING_FLOAT_PRECISION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The method performs math operations using floating point precision. Floating point precision is very imprecise. For example, @@ -390,7 +390,7 @@ should be written to the JarFile between the calls to <rule key="CN_IDIOM" priority="MAJOR"> <name><![CDATA[Bad practice - Class implements Cloneable but does not define or use clone method]]></name> <configKey><![CDATA[CN_IDIOM]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> Class implements Cloneable but does not define or use the clone method.</p>]]></description> @@ -398,7 +398,7 @@ should be written to the JarFile between the calls to <rule key="CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE" priority="MAJOR"> <name><![CDATA[Bad practice - Class defines clone() but doesn't implement Cloneable]]></name> <configKey><![CDATA[CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a clone() method but the class doesn't implement Cloneable. There are some situations in which this is OK (e.g., you want to control how subclasses can clone themselves), but just make sure that this is what you intended. @@ -407,7 +407,7 @@ can clone themselves), but just make sure that this is what you intended. <rule key="CN_IDIOM_NO_SUPER_CALL" priority="MAJOR"> <name><![CDATA[Bad practice - clone method does not call super.clone()]]></name> <configKey><![CDATA[CN_IDIOM_NO_SUPER_CALL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This non-final class defines a clone() method that does not call super.clone(). If this class ("<i>A</i>") is extended by a subclass ("<i>B</i>"), and the subclass <i>B</i> calls super.clone(), then it is likely that @@ -420,14 +420,14 @@ to use Object.clone(), which always returns an object of the correct type.</p>]] <rule key="NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER" priority="MAJOR"> <name><![CDATA[Bad practice - Use of identifier that is a keyword in later versions of Java]]></name> <configKey><![CDATA[NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>The identifier is a word that is reserved as a keyword in later versions of Java, and your code will need to be changed in order to compile it in later versions of Java.</p>]]></description> </rule> <rule key="NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER" priority="MAJOR"> <name><![CDATA[Bad practice - Use of identifier that is a keyword in later versions of Java]]></name> <configKey><![CDATA[NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>This identifier is used as a keyword in later versions of Java. This code, and any code that references this API, will need to be changed in order to compile it in later versions of Java.</p>]]></description> @@ -435,7 +435,7 @@ will need to be changed in order to compile it in later versions of Java.</p>]]> <rule key="DE_MIGHT_DROP" priority="MAJOR"> <name><![CDATA[Bad practice - Method might drop exception]]></name> <configKey><![CDATA[DE_MIGHT_DROP]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method might drop an exception. In general, exceptions should be handled or reported in some way, or they should be thrown out of the method.</p>]]></description> @@ -443,7 +443,7 @@ will need to be changed in order to compile it in later versions of Java.</p>]]> <rule key="DE_MIGHT_IGNORE" priority="MAJOR"> <name><![CDATA[Bad practice - Method might ignore exception]]></name> <configKey><![CDATA[DE_MIGHT_IGNORE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method might ignore an exception. In general, exceptions should be handled or reported in some way, or they should be thrown out of the method.</p>]]></description> @@ -451,7 +451,7 @@ will need to be changed in order to compile it in later versions of Java.</p>]]> <rule key="DP_DO_INSIDE_DO_PRIVILEGED" priority="MAJOR"> <name><![CDATA[Bad practice - Method invoked that should be only be invoked inside a doPrivileged block]]></name> <configKey><![CDATA[DP_DO_INSIDE_DO_PRIVILEGED]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This code invokes a method that requires a security permission check. If this code will be granted security permissions, but might be invoked by code that does not have security permissions, then the invocation needs to occur inside a doPrivileged block.</p>]]></description> @@ -459,7 +459,7 @@ will need to be changed in order to compile it in later versions of Java.</p>]]> <rule key="DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED" priority="MAJOR"> <name><![CDATA[Bad practice - Classloaders should only be created inside doPrivileged block]]></name> <configKey><![CDATA[DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This code creates a classloader, which requires a security manager. If this code will be granted security permissions, but might be invoked by code that does not have security permissions, then the classloader creation needs to occur inside a doPrivileged block.</p>]]></description> @@ -467,7 +467,7 @@ will need to be changed in order to compile it in later versions of Java.</p>]]> <rule key="JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS" priority="MINOR"> <name><![CDATA[Bad practice - Fields of immutable classes should be final]]></name> <configKey><![CDATA[JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The class is annotated with net.jcip.annotations.Immutable, and the rules for that annotation require that all fields are final. .</p>]]></description> @@ -475,7 +475,7 @@ that all fields are final. <rule key="DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED" priority="MAJOR"> <name><![CDATA[Dodgy - Thread passed where Runnable expected]]></name> <configKey><![CDATA[DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> A Thread object is passed as a parameter to a method where a Runnable is expected. This is rather unusual, and may indicate a logic error or cause unexpected behavior. @@ -484,7 +484,7 @@ or cause unexpected behavior. <rule key="DMI_COLLECTION_OF_URLS" priority="BLOCKER"> <name><![CDATA[Performance - Maps and sets of URLs can be performance hogs]]></name> <configKey><![CDATA[DMI_COLLECTION_OF_URLS]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This method or field is or uses a Map or Set of URLs. Since both the equals and hashCode method of URL perform domain name resolution, this can result in a big performance hit. See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information. @@ -494,7 +494,7 @@ Consider using <code>java.net.URI</code> instead. <rule key="DMI_BLOCKING_METHODS_ON_URL" priority="BLOCKER"> <name><![CDATA[Performance - The equals and hashCode methods of URL are blocking]]></name> <configKey><![CDATA[DMI_BLOCKING_METHODS_ON_URL]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> The equals and hashCode method of URL perform domain name resolution, this can result in a big performance hit. See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information. @@ -505,7 +505,7 @@ Consider using <code>java.net.URI</code> instead. <name> <![CDATA[Correctness - Can't use reflection to check for presence of annotation without runtime retention]]></name> <configKey><![CDATA[DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Unless an annotation has itself been annotated with @Retention(RetentionPolicy.RUNTIME), the annotation can't be observed using reflection (e.g., by using the isAnnotationPresent method). .</p>]]></description> @@ -513,7 +513,7 @@ Consider using <code>java.net.URI</code> instead. <rule key="DM_EXIT" priority="MAJOR"> <name><![CDATA[Bad practice - Method invokes System.exit(...)]]></name> <configKey><![CDATA[DM_EXIT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> Invoking System.exit shuts down the entire Java virtual machine. This should only been done when it is appropriate. Such calls make it hard or impossible for your code to be invoked by other code. @@ -522,7 +522,7 @@ Consider using <code>java.net.URI</code> instead. <rule key="DM_RUN_FINALIZERS_ON_EXIT" priority="MAJOR"> <name><![CDATA[Bad practice - Method invokes dangerous method runFinalizersOnExit]]></name> <configKey><![CDATA[DM_RUN_FINALIZERS_ON_EXIT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> <em>Never call System.runFinalizersOnExit or Runtime.runFinalizersOnExit for any reason: they are among the most dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></description> @@ -530,7 +530,7 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <rule key="DM_STRING_CTOR" priority="MAJOR"> <name><![CDATA[Performance - Method invokes inefficient new String(String) constructor]]></name> <configKey><![CDATA[DM_STRING_CTOR]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> Using the <code>java.lang.String(String)</code> constructor wastes memory because the object so constructed will be functionally indistinguishable from the <code>String</code> passed as a parameter. Just use the @@ -539,7 +539,7 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <rule key="DM_STRING_VOID_CTOR" priority="MAJOR"> <name><![CDATA[Performance - Method invokes inefficient new String() constructor]]></name> <configKey><![CDATA[DM_STRING_VOID_CTOR]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> Creating a new <code>java.lang.String</code> object using the no-argument constructor wastes memory because the object so created will be functionally indistinguishable from the empty string constant @@ -550,14 +550,14 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <rule key="DM_STRING_TOSTRING" priority="INFO"> <name><![CDATA[Performance - Method invokes toString() method on a String]]></name> <configKey><![CDATA[DM_STRING_TOSTRING]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> Calling <code>String.toString()</code> is just a redundant operation. Just use the String.</p>]]></description> </rule> <rule key="DM_GC" priority="MAJOR"> <name><![CDATA[Performance - Explicit garbage collection; extremely dubious except in benchmarking code]]></name> <configKey><![CDATA[DM_GC]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> Code explicitly invokes garbage collection. Except for specific use in benchmarking, this is very dubious.</p> <p>In the past, situations where people have explicitly invoked @@ -570,7 +570,7 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <name> <![CDATA[Performance - Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead]]></name> <configKey><![CDATA[DM_BOOLEAN_CTOR]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> Creating new instances of <code>java.lang.Boolean</code> wastes memory, since <code>Boolean</code> objects are immutable and there are only two useful values of this type. Use the <code>Boolean.valueOf()</code> @@ -579,7 +579,7 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <rule key="DM_NUMBER_CTOR" priority="CRITICAL"> <name><![CDATA[Performance - Method invokes inefficient Number constructor; use static valueOf instead]]></name> <configKey><![CDATA[DM_NUMBER_CTOR]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> Using <code>new Integer(int)</code> is guaranteed to always result in a new object whereas <code>Integer.valueOf(int)</code> allows caching of values to be done by the compiler, class library, or JVM. @@ -600,7 +600,7 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <name> <![CDATA[Performance - Method invokes inefficient floating-point Number constructor; use static valueOf instead]]></name> <configKey><![CDATA[DM_FP_NUMBER_CTOR]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> Using <code>new Double(double)</code> is guaranteed to always result in a new object whereas <code>Double.valueOf(double)</code> allows caching of values to be done by the compiler, class library, or JVM. @@ -614,7 +614,7 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <rule key="DM_CONVERT_CASE" priority="INFO"> <name><![CDATA[Internationalization - Consider using Locale parameterized version of invoked method]]></name> <configKey><![CDATA[DM_CONVERT_CASE]]></configKey> - <category name="Portability"/> + <description><![CDATA[<p> A String is being converted to upper or lowercase, using the platform's default encoding. This may result in improper conversions when used with international characters. Use the </p> <table><tr><td>String.toUpperCase( Locale l )</td></tr><tr><td>String.toLowerCase( Locale l )</td></tr></table> @@ -623,7 +623,7 @@ dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>]]></descriptio <rule key="BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR" priority="MAJOR"> <name><![CDATA[Correctness - Primitive value is unboxed and coerced for ternary operator]]></name> <configKey><![CDATA[BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>A wrapped primitive value is unboxed and converted to another primitive type as part of the evaluation of a conditional ternary operator (the <code> b ? e1 : e2</code> operator). The semantics of Java mandate that if <code>e1</code> and <code>e2</code> are wrapped @@ -636,7 +636,7 @@ converted to a floating point value, and boxed. See JLS Section 15.25. <rule key="BX_BOXING_IMMEDIATELY_UNBOXED" priority="MAJOR"> <name><![CDATA[Performance - Primitive value is boxed and then immediately unboxed]]></name> <configKey><![CDATA[BX_BOXING_IMMEDIATELY_UNBOXED]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p>A primitive is boxed, and then immediately unboxed. This probably is due to a manual boxing in a place where an unboxed value is required, thus forcing the compiler to immediately undo the work of the boxing. @@ -645,14 +645,14 @@ to immediately undo the work of the boxing. <rule key="BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION" priority="MAJOR"> <name><![CDATA[Performance - Primitive value is boxed then unboxed to perform primitive coercion]]></name> <configKey><![CDATA[BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p>A primitive boxed value constructed and then immediately converted into a different primitive type (e.g., <code>new Double(d).intValue()</code>). Just perform direct primitive coercion (e.g., <code>(int) d</code>).</p>]]></description> </rule> <rule key="DM_BOXED_PRIMITIVE_TOSTRING" priority="MAJOR"> <name><![CDATA[Performance - Method allocates a boxed primitive just to call toString]]></name> <configKey><![CDATA[DM_BOXED_PRIMITIVE_TOSTRING]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p>A boxed primitive is allocated just to call toString(). It is more effective to just use the static form of toString which takes the primitive value. So,</p> <table> @@ -669,14 +669,14 @@ to immediately undo the work of the boxing. <rule key="DM_NEW_FOR_GETCLASS" priority="MAJOR"> <name><![CDATA[Performance - Method allocates an object, only to get the class object]]></name> <configKey><![CDATA[DM_NEW_FOR_GETCLASS]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p>This method allocates an object just to call getClass() on it, in order to retrieve the Class object for it. It is simpler to just access the .class property of the class.</p>]]></description> </rule> <rule key="DM_MONITOR_WAIT_ON_CONDITION" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Monitor wait() called on Condition]]></name> <configKey><![CDATA[DM_MONITOR_WAIT_ON_CONDITION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls <code>wait()</code> on a <code>java.util.concurrent.locks.Condition</code> object. @@ -687,7 +687,7 @@ to immediately undo the work of the boxing. <rule key="RV_01_TO_INT" priority="MAJOR"> <name><![CDATA[Correctness - Random value from 0 to 1 is coerced to the integer 0]]></name> <configKey><![CDATA[RV_01_TO_INT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>A random value from 0 to 1 is being coerced to the integer value 0. You probably want to multiple the random value by something else before coercing it to an integer, or use the <code>Random.nextInt(n)</code> method. </p>]]></description> @@ -696,7 +696,7 @@ want to multiple the random value by something else before coercing it to an int <name> <![CDATA[Performance - Use the nextInt method of Random rather than nextDouble to generate a random integer]]></name> <configKey><![CDATA[DM_NEXTINT_VIA_NEXTDOUBLE]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p>If <code>r</code> is a <code>java.util.Random</code>, you can generate a random number from <code>0</code> to <code>n-1</code> using <code>r.nextInt(n)</code>, rather than using <code>(int)(r.nextDouble() * n)</code>. </p>]]></description> @@ -704,7 +704,7 @@ using <code>r.nextInt(n)</code>, rather than using <code>(int)(r.nextDouble() * <rule key="SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE" priority="CRITICAL"> <name><![CDATA[Security - Nonconstant string passed to execute method on an SQL statement]]></name> <configKey><![CDATA[SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>The method invokes the execute method on an SQL statement with a String that seems to be dynamically generated. Consider using a prepared statement instead. It is more efficient and less vulnerable to @@ -714,7 +714,7 @@ SQL injection attacks. <rule key="SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING" priority="CRITICAL"> <name><![CDATA[Security - A prepared statement is generated from a nonconstant String]]></name> <configKey><![CDATA[SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>The code creates an SQL prepared statement from a nonconstant String. If unchecked, tainted data from a user is used in building this String, SQL injection could be used to make the prepared statement do something unexpected and undesirable. @@ -723,7 +723,7 @@ be used to make the prepared statement do something unexpected and undesirable. <rule key="DM_USELESS_THREAD" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - A thread was created using the default empty run method]]></name> <configKey><![CDATA[DM_USELESS_THREAD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>This method creates a thread without specifying a run method either by deriving from the Thread class, or by passing a Runnable object. This thread, then, does nothing but waste time. </p>]]></description> @@ -731,7 +731,7 @@ be used to make the prepared statement do something unexpected and undesirable. <rule key="DC_DOUBLECHECK" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Possible double check of field]]></name> <configKey><![CDATA[DC_DOUBLECHECK]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method may contain an instance of double-checked locking. This idiom is not correct according to the semantics of the Java memory model. For more information, see the web page @@ -741,14 +741,14 @@ be used to make the prepared statement do something unexpected and undesirable. <rule key="FI_FINALIZER_NULLS_FIELDS" priority="MAJOR"> <name><![CDATA[Bad practice - Finalizer nulls fields]]></name> <configKey><![CDATA[FI_FINALIZER_NULLS_FIELDS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This finalizer nulls out fields. This is usually an error, as it does not aid garbage collection, and the object is going to be garbage collected anyway.]]></description> </rule> <rule key="FI_FINALIZER_ONLY_NULLS_FIELDS" priority="MAJOR"> <name><![CDATA[Bad practice - Finalizer only nulls fields]]></name> <configKey><![CDATA[FI_FINALIZER_ONLY_NULLS_FIELDS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This finalizer does nothing except null out fields. This is completely pointless, and requires that the object be garbage collected, finalized, and then garbage collected again. You should just remove the finalize method.]]></description> @@ -756,21 +756,21 @@ method.]]></description> <rule key="FI_PUBLIC_SHOULD_BE_PROTECTED" priority="MAJOR"> <name><![CDATA[Malicious code vulnerability - Finalizer should be protected, not public]]></name> <configKey><![CDATA[FI_PUBLIC_SHOULD_BE_PROTECTED]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A class's <code>finalize()</code> method should have protected access, not public.</p>]]></description> </rule> <rule key="FI_EMPTY" priority="MAJOR"> <name><![CDATA[Bad practice - Empty finalizer should be deleted]]></name> <configKey><![CDATA[FI_EMPTY]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> Empty <code>finalize()</code> methods are useless, so they should be deleted.</p>]]></description> </rule> <rule key="FI_NULLIFY_SUPER" priority="CRITICAL"> <name><![CDATA[Bad practice - Finalizer nullifies superclass finalizer]]></name> <configKey><![CDATA[FI_NULLIFY_SUPER]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This empty <code>finalize()</code> method explicitly negates the effect of any finalizer defined by its superclass. Any finalizer actions defined for the superclass will not be performed. @@ -779,7 +779,7 @@ method.]]></description> <rule key="FI_USELESS" priority="MINOR"> <name><![CDATA[Bad practice - Finalizer does nothing but call superclass finalizer]]></name> <configKey><![CDATA[FI_USELESS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The only thing this <code>finalize()</code> method does is call the superclass's <code>finalize()</code> method, making it redundant. Delete it.</p>]]></description> @@ -787,7 +787,7 @@ method.]]></description> <rule key="FI_MISSING_SUPER_CALL" priority="MAJOR"> <name><![CDATA[Bad practice - Finalizer does not call superclass finalizer]]></name> <configKey><![CDATA[FI_MISSING_SUPER_CALL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This <code>finalize()</code> method does not make a call to its superclass's <code>finalize()</code> method. So, any finalizer actions defined for the superclass will not be performed. @@ -796,7 +796,7 @@ method.]]></description> <rule key="FI_EXPLICIT_INVOCATION" priority="MAJOR"> <name><![CDATA[Bad practice - Explicit invocation of finalizer]]></name> <configKey><![CDATA[FI_EXPLICIT_INVOCATION]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method contains an explicit invocation of the <code>finalize()</code> method on an object. Because finalizer methods are supposed to be executed once, and only by the VM, this is a bad idea.</p> @@ -808,7 +808,7 @@ on objects referenced by X, because they may already be getting finalized in a s <rule key="EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS" priority="MAJOR"> <name><![CDATA[Bad practice - Equals checks for noncompatible operand]]></name> <configKey><![CDATA[EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This equals method is checking to see if the argument is some incompatible type (i.e., a class that is neither a supertype nor subtype of the class that defines the equals method). For example, the Foo class might have an equals method @@ -830,7 +830,7 @@ is symmetric and transitive. Without those properties, very unexpected behavoirs <rule key="EQ_DONT_DEFINE_EQUALS_FOR_ENUM" priority="MAJOR"> <name><![CDATA[Correctness - Covariant equals() method defined for enum]]></name> <configKey><![CDATA[EQ_DONT_DEFINE_EQUALS_FOR_ENUM]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines an enumeration, and equality on enumerations are defined using object identity. Defining a covariant equals method for an enumeration value is exceptionally bad practice, since it would likely result @@ -842,7 +842,7 @@ Don't do it. <rule key="EQ_SELF_USE_OBJECT" priority="MAJOR"> <name><![CDATA[Correctness - Covariant equals() method defined, Object.equals(Object) inherited]]></name> <configKey><![CDATA[EQ_SELF_USE_OBJECT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines a covariant version of the <code>equals()</code> method, but inherits the normal <code>equals(Object)</code> method defined in the base <code>java.lang.Object</code> class. @@ -852,7 +852,7 @@ Don't do it. <rule key="EQ_OTHER_USE_OBJECT" priority="MAJOR"> <name><![CDATA[Correctness - equals() method defined that doesn't override Object.equals(Object)]]></name> <configKey><![CDATA[EQ_OTHER_USE_OBJECT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines an <code>equals()</code> method, that doesn't override the normal <code>equals(Object)</code> method defined in the base <code>java.lang.Object</code> class. @@ -862,7 +862,7 @@ Don't do it. <rule key="EQ_OTHER_NO_OBJECT" priority="MAJOR"> <name><![CDATA[Correctness - equals() method defined that doesn't override equals(Object)]]></name> <configKey><![CDATA[EQ_OTHER_NO_OBJECT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines an <code>equals()</code> method, that doesn't override the normal <code>equals(Object)</code> method defined in the base <code>java.lang.Object</code> class. Instead, it @@ -875,7 +875,7 @@ Don't do it. <rule key="EQ_DOESNT_OVERRIDE_EQUALS"> <name><![CDATA[Dodgy - Class doesn't override equals in superclass]]></name> <configKey><![CDATA[EQ_DOESNT_OVERRIDE_EQUALS]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class extends a class that defines an equals method and adds fields, but doesn't define an equals method itself. Thus, equality on instances of this class will ignore the identity of the subclass and the added fields. Be sure this is what is intended, @@ -888,7 +888,7 @@ invoking super.equals(o). <rule key="EQ_SELF_NO_OBJECT" priority="MAJOR"> <name><![CDATA[Bad practice - Covariant equals() method defined]]></name> <configKey><![CDATA[EQ_SELF_NO_OBJECT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a covariant version of <code>equals()</code>. To correctly override the <code>equals()</code> method in <code>java.lang.Object</code>, the parameter of <code>equals()</code> @@ -897,7 +897,7 @@ invoking super.equals(o). <rule key="EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC" priority="MAJOR"> <name><![CDATA[Correctness - equals method overrides equals in superclass and may not be symmetric]]></name> <configKey><![CDATA[EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines an equals method that overrides an equals method in a superclass. Both equals methods methods use <code>instanceof</code> in the determination of whether two objects are equal. This is fraught with peril, since it is important that the equals method is symmetrical (in other words, <code>a.equals(b) == b.equals(a)</code>). @@ -909,7 +909,7 @@ methods is not symmetric. <rule key="EQ_GETCLASS_AND_CLASS_CONSTANT" priority="CRITICAL"> <name><![CDATA[Bad practice - equals method fails for subtypes]]></name> <configKey><![CDATA[EQ_GETCLASS_AND_CLASS_CONSTANT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class has an equals method that will be broken if it is inherited by subclasses. It compares a class literal with the class of the argument (e.g., in class <code>Foo</code> it might check if <code>Foo.class == o.getClass()</code>). @@ -919,7 +919,7 @@ It is better to check if <code>this.getClass() == o.getClass()</code>. <rule key="EQ_UNUSUAL" priority="MINOR"> <name><![CDATA[Dodgy - Unusual equals method ]]></name> <configKey><![CDATA[EQ_UNUSUAL]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class doesn't do any of the patterns we recognize for checking that the type of the argument is compatible with the type of the <code>this</code> object. There might not be anything wrong with this code, but it is worth reviewing. @@ -928,7 +928,7 @@ this code, but it is worth reviewing. <rule key="EQ_COMPARING_CLASS_NAMES" priority="MAJOR"> <name><![CDATA[Correctness - equals method compares class names rather than class objects]]></name> <configKey><![CDATA[EQ_COMPARING_CLASS_NAMES]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method checks to see if two objects are the same class by checking to see if the names of their classes are equal. You can have different classes with the same name if they are loaded by different class loaders. Just check to see if the class objects are the same. @@ -937,7 +937,7 @@ different class loaders. Just check to see if the class objects are the same. <rule key="EQ_ALWAYS_TRUE" priority="BLOCKER"> <name><![CDATA[Correctness - equals method always returns true]]></name> <configKey><![CDATA[EQ_ALWAYS_TRUE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines an equals method that always returns true. This is imaginative, but not very smart. Plus, it means that the equals method is not symmetric. </p>]]></description> @@ -945,7 +945,7 @@ Plus, it means that the equals method is not symmetric. <rule key="EQ_ALWAYS_FALSE" priority="BLOCKER"> <name><![CDATA[Correctness - equals method always returns false]]></name> <configKey><![CDATA[EQ_ALWAYS_FALSE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines an equals method that always returns false. This means that an object is not equal to itself, and it is impossible to create useful Maps or Sets of this class. More fundamentally, it means that equals is not reflexive, one of the requirements of the equals method.</p> <p>The likely intended semantics are object identity: that an object is equal to itself. This is the behavior inherited from class <code>Object</code>. If you need to override an equals inherited from a different @@ -958,7 +958,7 @@ public boolean equals(Object o) { return this == o; } <rule key="HSC_HUGE_SHARED_STRING_CONSTANT" priority="CRITICAL"> <name><![CDATA[Performance - Huge string constants is duplicated across multiple class files]]></name> <configKey><![CDATA[HSC_HUGE_SHARED_STRING_CONSTANT]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> A large String constant is duplicated across multiple class files. This is likely because a final field is initialized to a String constant, and the Java language @@ -971,7 +971,7 @@ that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id= <rule key="NP_ARGUMENT_MIGHT_BE_NULL" priority="MAJOR"> <name><![CDATA[Correctness - Method does not check for null argument]]></name> <configKey><![CDATA[NP_ARGUMENT_MIGHT_BE_NULL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A parameter to this method has been identified as a value that should always be checked to see whether or not it is null, but it is being dereferenced @@ -981,7 +981,7 @@ that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id= <rule key="NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT" priority="CRITICAL"> <name><![CDATA[Bad practice - equals() method does not check for null argument]]></name> <configKey><![CDATA[NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This implementation of equals(Object) violates the contract defined by java.lang.Object.equals() because it does not check for null @@ -992,7 +992,7 @@ that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id= <rule key="CO_SELF_NO_OBJECT" priority="MAJOR"> <name><![CDATA[Bad practice - Covariant compareTo() method defined]]></name> <configKey><![CDATA[CO_SELF_NO_OBJECT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a covariant version of <code>compareTo()</code>. To correctly override the <code>compareTo()</code> method in the <code>Comparable</code> interface, the parameter of <code>compareTo()</code> @@ -1001,7 +1001,7 @@ that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id= <rule key="HE_SIGNATURE_DECLARES_HASHING_OF_UNHASHABLE_CLASS" priority="CRITICAL"> <name><![CDATA[Correctness - Signature declares use of unhashable class in hashed construct]]></name> <configKey><![CDATA[HE_SIGNATURE_DECLARES_HASHING_OF_UNHASHABLE_CLASS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A method, field or class declares a generic signature where a non-hashable class is used in context where a hashable class is required. A class that declares an equals method but inherits a hashCode() method @@ -1012,7 +1012,7 @@ equal objects have equal hashCodes. <rule key="HE_USE_OF_UNHASHABLE_CLASS" priority="CRITICAL"> <name><![CDATA[Correctness - Use of class without a hashCode() method in a hashed data structure]]></name> <configKey><![CDATA[HE_USE_OF_UNHASHABLE_CLASS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A class defines an equals(Object) method but not a hashCode() method, and thus doesn't fulfill the requirement that equal objects have equal hashCodes. An instance of this class is used in a hash data structure, making the need to @@ -1021,7 +1021,7 @@ fix this problem of highest importance.]]></description> <rule key="HE_HASHCODE_USE_OBJECT_EQUALS" priority="CRITICAL"> <name><![CDATA[Bad practice - Class defines hashCode() and uses Object.equals()]]></name> <configKey><![CDATA[HE_HASHCODE_USE_OBJECT_EQUALS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a <code>hashCode()</code> method but inherits its <code>equals()</code> method from <code>java.lang.Object</code> (which defines equality by comparing object references). Although @@ -1040,7 +1040,7 @@ the recommended <code>hashCode</code> implementation to use is:</p> <rule key="EQ_COMPARETO_USE_OBJECT_EQUALS" priority="CRITICAL"> <name><![CDATA[Bad practice - Class defines compareTo(...) and uses Object.equals()]]></name> <configKey><![CDATA[EQ_COMPARETO_USE_OBJECT_EQUALS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a <code>compareTo(...)</code> method but inherits its <code>equals()</code> method from <code>java.lang.Object</code>. Generally, the value of compareTo should return zero if and only if @@ -1060,7 +1060,7 @@ is "Note: this class has a natural ordering that is inconsistent with equals." <rule key="HE_HASHCODE_NO_EQUALS" priority="CRITICAL"> <name><![CDATA[Bad practice - Class defines hashCode() but not equals()]]></name> <configKey><![CDATA[HE_HASHCODE_NO_EQUALS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a <code>hashCode()</code> method but not an <code>equals()</code> method. Therefore, the class may violate the invariant that equal objects must have equal hashcodes.</p>]]></description> @@ -1068,7 +1068,7 @@ is "Note: this class has a natural ordering that is inconsistent with equals." <rule key="HE_EQUALS_USE_HASHCODE" priority="CRITICAL"> <name><![CDATA[Bad practice - Class defines equals() and uses Object.hashCode()]]></name> <configKey><![CDATA[HE_EQUALS_USE_HASHCODE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class overrides <code>equals(Object)</code>, but does not override <code>hashCode()</code>, and inherits the implementation of <code>hashCode()</code> from <code>java.lang.Object</code> (which returns @@ -1086,7 +1086,7 @@ the recommended <code>hashCode</code> implementation to use is:</p> <rule key="HE_INHERITS_EQUALS_USE_HASHCODE" priority="CRITICAL"> <name><![CDATA[Bad practice - Class inherits equals() and uses Object.hashCode()]]></name> <configKey><![CDATA[HE_INHERITS_EQUALS_USE_HASHCODE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class inherits <code>equals(Object)</code> from an abstract superclass, and <code>hashCode()</code> from <code>java.lang.Object</code> (which returns @@ -1102,7 +1102,7 @@ the recommended <code>hashCode</code> implementation to use is:</p> <rule key="HE_EQUALS_NO_HASHCODE" priority="MAJOR"> <name><![CDATA[Bad practice - Class defines equals() but not hashCode()]]></name> <configKey><![CDATA[HE_EQUALS_NO_HASHCODE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class overrides <code>equals(Object)</code>, but does not override <code>hashCode()</code>. Therefore, the class may violate the invariant that equal objects must have equal hashcodes.</p>]]></description> @@ -1110,7 +1110,7 @@ the recommended <code>hashCode</code> implementation to use is:</p> <rule key="EQ_ABSTRACT_SELF" priority="MAJOR"> <name><![CDATA[Bad practice - Abstract class defines covariant equals() method]]></name> <configKey><![CDATA[EQ_ABSTRACT_SELF]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a covariant version of <code>equals()</code>. To correctly override the <code>equals()</code> method in <code>java.lang.Object</code>, the parameter of <code>equals()</code> @@ -1119,7 +1119,7 @@ the recommended <code>hashCode</code> implementation to use is:</p> <rule key="ES_COMPARING_STRINGS_WITH_EQ" priority="MAJOR"> <name><![CDATA[Bad practice - Comparison of String objects using == or !=]]></name> <configKey><![CDATA[ES_COMPARING_STRINGS_WITH_EQ]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>This code compares <code>java.lang.String</code> objects for reference equality using the == or != operators. Unless both strings are either constants in a source file, or have been @@ -1130,7 +1130,7 @@ using the <code>equals(Object)</code> method instead.</p>]]></description> <rule key="ES_COMPARING_PARAMETER_STRING_WITH_EQ" priority="MAJOR"> <name><![CDATA[Bad practice - Comparison of String parameter using == or !=]]></name> <configKey><![CDATA[ES_COMPARING_PARAMETER_STRING_WITH_EQ]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p>This code compares a <code>java.lang.String</code> parameter for reference equality using the == or != operators. Requiring callers to pass only String constants or interned strings to a method is unnecessarily @@ -1140,7 +1140,7 @@ using the <code>equals(Object)</code> method instead.</p>]]></description> <rule key="CO_ABSTRACT_SELF" priority="MAJOR"> <name><![CDATA[Bad practice - Abstract class defines covariant compareTo() method]]></name> <configKey><![CDATA[CO_ABSTRACT_SELF]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a covariant version of <code>compareTo()</code>. To correctly override the <code>compareTo()</code> method in the <code>Comparable</code> interface, the parameter of <code>compareTo()</code> @@ -1149,14 +1149,14 @@ using the <code>equals(Object)</code> method instead.</p>]]></description> <rule key="IS_FIELD_NOT_GUARDED" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Field not guarded against concurrent access]]></name> <configKey><![CDATA[IS_FIELD_NOT_GUARDED]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This field is annotated with net.jcip.annotations.GuardedBy, but can be accessed in a way that seems to violate the annotation.</p>]]></description> </rule> <rule key="MSF_MUTABLE_SERVLET_FIELD" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Mutable servlet field]]></name> <configKey><![CDATA[MSF_MUTABLE_SERVLET_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>A web server generally only creates one instance of servlet or jsp class (i.e., treats the class as a Singleton), and will @@ -1167,7 +1167,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <rule key="IS2_INCONSISTENT_SYNC" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Inconsistent synchronization]]></name> <configKey><![CDATA[IS2_INCONSISTENT_SYNC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The fields of this class appear to be accessed inconsistently with respect to synchronization. This bug report indicates that the bug pattern detector judged that @@ -1195,7 +1195,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <rule key="NN_NAKED_NOTIFY" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Naked notify]]></name> <configKey><![CDATA[NN_NAKED_NOTIFY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A call to <code>notify()</code> or <code>notifyAll()</code> was made without any (apparent) accompanying modification to mutable object state. In general, calling a notify @@ -1211,7 +1211,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <name> <![CDATA[Malicious code vulnerability - Public static method may expose internal representation by returning array]]></name> <configKey><![CDATA[MS_EXPOSE_REP]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A public static method returns a reference to an array that is part of the static state of the class. Any code that calls this method can freely modify @@ -1222,7 +1222,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <name> <![CDATA[Malicious code vulnerability - May expose internal representation by returning reference to mutable object]]></name> <configKey><![CDATA[EI_EXPOSE_REP]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Returning a reference to a mutable object value stored in one of the object's fields exposes the internal representation of the object. If instances @@ -1235,7 +1235,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <name> <![CDATA[Malicious code vulnerability - May expose internal representation by incorporating reference to mutable object]]></name> <configKey><![CDATA[EI_EXPOSE_REP2]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code stores a reference to an externally mutable object into the internal representation of the object. If instances @@ -1248,7 +1248,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <name> <![CDATA[Malicious code vulnerability - May expose internal static state by storing a mutable object into a static field]]></name> <configKey><![CDATA[EI_EXPOSE_STATIC_REP2]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code stores a reference to an externally mutable object into a static field. If unchecked changes to @@ -1259,7 +1259,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <rule key="RU_INVOKE_RUN" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Invokes run on a thread (did you mean to start it instead?)]]></name> <configKey><![CDATA[RU_INVOKE_RUN]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method explicitly invokes <code>run()</code> on an object. In general, classes implement the <code>Runnable</code> interface because they are going to have their <code>run()</code> method invoked in a new thread, @@ -1268,7 +1268,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <rule key="SP_SPIN_ON_FIELD" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Method spins on field]]></name> <configKey><![CDATA[SP_SPIN_ON_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method spins in a loop which reads a field. The compiler may legally hoist the read out of the loop, turning the code into an infinite loop. The class should be changed so it uses proper @@ -1277,7 +1277,7 @@ Thus, having a mutable instance field generally creates race conditions.]]></des <rule key="NS_DANGEROUS_NON_SHORT_CIRCUIT" priority="CRITICAL"> <name><![CDATA[Dodgy - Potentially dangerous use of non-short-circuit logic]]></name> <configKey><![CDATA[NS_DANGEROUS_NON_SHORT_CIRCUIT]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code seems to be using non-short-circuit logic (e.g., & or |) rather than short-circuit logic (&& or ||). In addition, @@ -1300,7 +1300,7 @@ Language Specification</a> for details <rule key="NS_NON_SHORT_CIRCUIT" priority="MAJOR"> <name><![CDATA[Dodgy - Questionable use of non-short-circuit logic]]></name> <configKey><![CDATA[NS_NON_SHORT_CIRCUIT]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code seems to be using non-short-circuit logic (e.g., & or |) rather than short-circuit logic (&& or ||). @@ -1318,7 +1318,7 @@ Language Specification</a> for details <rule key="TLW_TWO_LOCK_WAIT" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Wait with two locks held]]></name> <configKey><![CDATA[TLW_TWO_LOCK_WAIT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Waiting on a monitor while two locks are held may cause deadlock. @@ -1331,7 +1331,7 @@ This not necessarily a bug, but is worth examining <rule key="UW_UNCOND_WAIT" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Unconditional wait]]></name> <configKey><![CDATA[UW_UNCOND_WAIT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a call to <code>java.lang.Object.wait()</code> which is not guarded by conditional control flow. The code should verify that condition it intends to wait for is not already satisfied @@ -1341,7 +1341,7 @@ This not necessarily a bug, but is worth examining <rule key="UR_UNINIT_READ" priority="MAJOR"> <name><![CDATA[Correctness - Uninitialized read of field in constructor]]></name> <configKey><![CDATA[UR_UNINIT_READ]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This constructor reads a field which has not yet been assigned a value. This is often caused when the programmer mistakenly uses the field instead of one of the constructor's parameters.</p>]]></description> @@ -1349,7 +1349,7 @@ This not necessarily a bug, but is worth examining <rule key="UG_SYNC_SET_UNSYNC_GET" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Unsynchronized get method, synchronized set method]]></name> <configKey><![CDATA[UG_SYNC_SET_UNSYNC_GET]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class contains similarly-named get and set methods where the set method is synchronized and the get method is not. This may result in incorrect behavior at runtime, as callers of the get @@ -1359,7 +1359,7 @@ This not necessarily a bug, but is worth examining <rule key="IC_INIT_CIRCULARITY" priority="CRITICAL"> <name><![CDATA[Dodgy - Initialization circularity]]></name> <configKey><![CDATA[IC_INIT_CIRCULARITY]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> A circularity was detected in the static initializers of the two classes referenced by the bug instance. Many kinds of unexpected behavior may arise from such circularity.</p>]]></description> @@ -1367,7 +1367,7 @@ This not necessarily a bug, but is worth examining <rule key="IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION" priority="MAJOR"> <name><![CDATA[Bad practice - Superclass uses subclass during initialization]]></name> <configKey><![CDATA[IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> During the initialization of a class, the class makes an active use of a subclass. That subclass will not yet be initialized at the time of this use. For example, in the following code, <code>foo</code> will be null.</p> @@ -1385,7 +1385,7 @@ public class CircularClassInitialization { <rule key="IT_NO_SUCH_ELEMENT" priority="MINOR"> <name><![CDATA[Bad practice - Iterator next() method can't throw NoSuchElementException]]></name> <configKey><![CDATA[IT_NO_SUCH_ELEMENT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class implements the <code>java.util.Iterator</code> interface. However, its <code>next()</code> method is not capable of throwing <code>java.util.NoSuchElementException</code>. The <code>next()</code> @@ -1395,7 +1395,7 @@ public class CircularClassInitialization { <rule key="DL_SYNCHRONIZATION_ON_SHARED_CONSTANT" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Synchronization on interned String could lead to deadlock]]></name> <configKey><![CDATA[DL_SYNCHRONIZATION_ON_SHARED_CONSTANT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code synchronizes on interned String. <pre> private static String LOCK = "LOCK"; @@ -1412,7 +1412,7 @@ blocking and deadlock behavior. See <a href="http://www.javalobby.org/java/forum <rule key="DL_SYNCHRONIZATION_ON_BOOLEAN" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Synchronization on Boolean could lead to deadlock]]></name> <configKey><![CDATA[DL_SYNCHRONIZATION_ON_BOOLEAN]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code synchronizes on a boxed primitive constant, such as an Boolean. <pre> private static Boolean inited = Boolean.FALSE; @@ -1432,7 +1432,7 @@ and possible deadlock</p>]]></description> <rule key="DL_SYNCHRONIZATION_ON_UNSHARED_BOXED_PRIMITIVE" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Synchronization on boxed primitive values]]></name> <configKey><![CDATA[DL_SYNCHRONIZATION_ON_UNSHARED_BOXED_PRIMITIVE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code synchronizes on an apparently unshared boxed primitive, such as an Integer. <pre> @@ -1457,7 +1457,7 @@ throughout the JVM, leading to very confusing behavior and potential deadlock. <rule key="DL_SYNCHRONIZATION_ON_BOXED_PRIMITIVE" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Synchronization on boxed primitive could lead to deadlock]]></name> <configKey><![CDATA[DL_SYNCHRONIZATION_ON_BOXED_PRIMITIVE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code synchronizes on a boxed primitive constant, such as an Integer. <pre> private static Integer count = 0; @@ -1475,7 +1475,7 @@ and possible deadlock</p>]]></description> <rule key="ESync_EMPTY_SYNC" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Empty synchronized block]]></name> <configKey><![CDATA[ESync_EMPTY_SYNC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code contains an empty synchronized block:</p> <pre> synchronized() {} @@ -1489,7 +1489,7 @@ than less contrived solutions. <rule key="IS_INCONSISTENT_SYNC" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Inconsistent synchronization]]></name> <configKey><![CDATA[IS_INCONSISTENT_SYNC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The fields of this class appear to be accessed inconsistently with respect to synchronization. This bug report indicates that the bug pattern detector judged that @@ -1513,7 +1513,7 @@ than less contrived solutions. <rule key="ML_SYNC_ON_FIELD_TO_GUARD_CHANGING_THAT_FIELD" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Synchronization on field in futile attempt to guard that field]]></name> <configKey><![CDATA[ML_SYNC_ON_FIELD_TO_GUARD_CHANGING_THAT_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method synchronizes on a field in what appears to be an attempt to guard against simultaneous updates to that field. But guarding a field gets a lock on the referenced object, not on the field. This may not @@ -1539,7 +1539,7 @@ private Long getNotificationSequenceNumber() { <rule key="ML_SYNC_ON_UPDATED_FIELD" priority="MAJOR"> <name><![CDATA[Multithreaded correctness - Method synchronizes on an updated field]]></name> <configKey><![CDATA[ML_SYNC_ON_UPDATED_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method synchronizes on an object referenced from a mutable field. This is unlikely to have useful semantics, since different @@ -1549,7 +1549,7 @@ threads may be synchronizing on different objects.</p>]]></description> <name> <![CDATA[Malicious code vulnerability - Field should be moved out of an interface and made package protected]]></name> <configKey><![CDATA[MS_OOI_PKGPROTECT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A final static field that is defined in an interface references a mutable @@ -1565,7 +1565,7 @@ defined in an interface references a mutable <rule key="MS_FINAL_PKGPROTECT" priority="MAJOR"> <name><![CDATA[Malicious code vulnerability - Field should be both final and package protected]]></name> <configKey><![CDATA[MS_FINAL_PKGPROTECT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A mutable static field could be changed by malicious code or by accident from another package. @@ -1576,7 +1576,7 @@ defined in an interface references a mutable <rule key="MS_SHOULD_BE_FINAL" priority="MAJOR"> <name><![CDATA[Malicious code vulnerability - Field isn't final but should be]]></name> <configKey><![CDATA[MS_SHOULD_BE_FINAL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A mutable static field could be changed by malicious code or by accident from another package. @@ -1586,7 +1586,7 @@ defined in an interface references a mutable <rule key="MS_PKGPROTECT" priority="MAJOR"> <name><![CDATA[Malicious code vulnerability - Field should be package protected]]></name> <configKey><![CDATA[MS_PKGPROTECT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A mutable static field could be changed by malicious code or by accident. The field could be made package protected to avoid @@ -1595,7 +1595,7 @@ defined in an interface references a mutable <rule key="MS_MUTABLE_HASHTABLE" priority="MAJOR"> <name><![CDATA[Malicious code vulnerability - Field is a mutable Hashtable]]></name> <configKey><![CDATA[MS_MUTABLE_HASHTABLE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>A final static field references a Hashtable and can be accessed by malicious code or by accident from another package. @@ -1604,7 +1604,7 @@ defined in an interface references a mutable <rule key="MS_MUTABLE_ARRAY" priority="MAJOR"> <name><![CDATA[Malicious code vulnerability - Field is a mutable array]]></name> <configKey><![CDATA[MS_MUTABLE_ARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A final static field references an array and can be accessed by malicious code or by accident from another package. @@ -1613,7 +1613,7 @@ defined in an interface references a mutable <rule key="MS_CANNOT_BE_FINAL" priority="MAJOR"> <name><![CDATA[Malicious code vulnerability - Field isn't final and can't be protected from malicious code]]></name> <configKey><![CDATA[MS_CANNOT_BE_FINAL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A mutable static field could be changed by malicious code or by accident from another package. @@ -1623,7 +1623,7 @@ defined in an interface references a mutable <rule key="IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD" priority="MAJOR"> <name><![CDATA[Dodgy - Ambiguous invocation of either an inherited or outer method]]></name> <configKey><![CDATA[IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> An inner class is invoking a method that could be resolved to either a inherited method or a method defined in an outer class. By the Java semantics, it will be resolved to invoke the inherited method, but this may not be want you intend. If you really intend to invoke the inherited method, @@ -1635,7 +1635,7 @@ that you want to invoke the inherited method, not the method in the outer class. <rule key="NM_SAME_SIMPLE_NAME_AS_SUPERCLASS" priority="MAJOR"> <name><![CDATA[Bad practice - Class names shouldn't shadow simple name of superclass]]></name> <configKey><![CDATA[NM_SAME_SIMPLE_NAME_AS_SUPERCLASS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class has a simple name that is identical to that of its superclass, except that its superclass is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>). This can be exceptionally confusing, create lots of situations in which you have to look at import statements @@ -1646,7 +1646,7 @@ opportunities to accidently define methods that do not override methods in their <rule key="NM_SAME_SIMPLE_NAME_AS_INTERFACE" priority="MAJOR"> <name><![CDATA[Bad practice - Class names shouldn't shadow simple name of implemented interface]]></name> <configKey><![CDATA[NM_SAME_SIMPLE_NAME_AS_INTERFACE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class/interface has a simple name that is identical to that of an implemented/extended interface, except that the interface is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>). This can be exceptionally confusing, create lots of situations in which you have to look at import statements @@ -1657,7 +1657,7 @@ opportunities to accidently define methods that do not override methods in their <rule key="NM_VERY_CONFUSING" priority="MAJOR"> <name><![CDATA[Correctness - Very confusing method names]]></name> <configKey><![CDATA[NM_VERY_CONFUSING]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The referenced methods have names that differ only by capitalization. This is very confusing because if the capitalization were identical then one of the methods would override the other. @@ -1666,7 +1666,7 @@ identical then one of the methods would override the other. <rule key="NM_VERY_CONFUSING_INTENTIONAL" priority="MAJOR"> <name><![CDATA[Bad practice - Very confusing method names (but perhaps intentional)]]></name> <configKey><![CDATA[NM_VERY_CONFUSING_INTENTIONAL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The referenced methods have names that differ only by capitalization. This is very confusing because if the capitalization were identical then one of the methods would override the other. From the existence of other methods, it @@ -1678,7 +1678,7 @@ You should try hard to eliminate one of them, unless you are forced to have both <name> <![CDATA[Correctness - Method doesn't override method in superclass due to wrong package for parameter]]></name> <configKey><![CDATA[NM_WRONG_PACKAGE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match the type of the corresponding parameter in the superclass. For example, if you have:</p> @@ -1706,7 +1706,7 @@ types are <code>Foo</code>'s from different packages. <name> <![CDATA[Bad practice - Method doesn't override method in superclass due to wrong package for parameter]]></name> <configKey><![CDATA[NM_WRONG_PACKAGE_INTENTIONAL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match the type of the corresponding parameter in the superclass. For example, if you have:</p> @@ -1739,13 +1739,13 @@ removing or deprecating the method with the similar but not identical signature. <rule key="NM_CONFUSING" priority="MAJOR"> <name><![CDATA[Bad practice - Confusing method names]]></name> <configKey><![CDATA[NM_CONFUSING]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The referenced methods have names that differ only by capitalization.</p>]]></description> </rule> <rule key="NM_METHOD_CONSTRUCTOR_CONFUSION" priority="MAJOR"> <name><![CDATA[Correctness - Apparent method/constructor confusion]]></name> <configKey><![CDATA[NM_METHOD_CONSTRUCTOR_CONFUSION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This regular method has the same name as the class it is defined in. It is likely that this was intended to be a constructor. If it was intended to be a constructor, remove the declaration of a void return value. If you had accidently defined this method, realized the mistake, defined a proper constructor @@ -1755,14 +1755,14 @@ removing or deprecating the method with the similar but not identical signature. <rule key="NM_CLASS_NOT_EXCEPTION" priority="MAJOR"> <name><![CDATA[Bad practice - Class is not derived from an Exception, even though it is named as such]]></name> <configKey><![CDATA[NM_CLASS_NOT_EXCEPTION]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class is not derived from another exception, but ends with 'Exception'. This will be confusing to users of this class.</p>]]></description> </rule> <rule key="RR_NOT_CHECKED" priority="MAJOR"> <name><![CDATA[Bad practice - Method ignores results of InputStream.read()]]></name> <configKey><![CDATA[RR_NOT_CHECKED]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method ignores the return value of one of the variants of <code>java.io.InputStream.read()</code> which can return multiple bytes. If the return value is not checked, the caller will not be able to correctly @@ -1774,7 +1774,7 @@ be confusing to users of this class.</p>]]></description> <rule key="SR_NOT_CHECKED" priority="MAJOR"> <name><![CDATA[Bad practice - Method ignores results of InputStream.skip()]]></name> <configKey><![CDATA[SR_NOT_CHECKED]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method ignores the return value of <code>java.io.InputStream.skip()</code> which can skip multiple bytes. If the return value is not checked, the caller will not be able to correctly @@ -1788,7 +1788,7 @@ be confusing to users of this class.</p>]]></description> <rule key="SE_READ_RESOLVE_IS_STATIC" priority="MAJOR"> <name><![CDATA[Correctness - The readResolve method must not be declared as a static method. ]]></name> <configKey><![CDATA[SE_READ_RESOLVE_IS_STATIC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> In order for the readResolve method to be recognized by the serialization mechanism, it must not be declared as a static method. </p>]]></description> @@ -1796,7 +1796,7 @@ mechanism, it must not be declared as a static method. <rule key="SE_PRIVATE_READ_RESOLVE_NOT_INHERITED" priority="MAJOR"> <name><![CDATA[Dodgy - private readResolve method not inherited by subclasses]]></name> <configKey><![CDATA[SE_PRIVATE_READ_RESOLVE_NOT_INHERITED]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class defines a private readResolve method. Since it is private, it won't be inherited by subclasses. This might be intentional and OK, but should be reviewed to ensure it is what is intended. </p>]]></description> @@ -1804,7 +1804,7 @@ This might be intentional and OK, but should be reviewed to ensure it is what is <rule key="SE_READ_RESOLVE_MUST_RETURN_OBJECT" priority="MAJOR"> <name><![CDATA[Bad practice - The readResolve method must be declared with a return type of Object. ]]></name> <configKey><![CDATA[SE_READ_RESOLVE_MUST_RETURN_OBJECT]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> In order for the readResolve method to be recognized by the serialization mechanism, it must be declared to have a return type of Object. </p>]]></description> @@ -1812,7 +1812,7 @@ mechanism, it must be declared to have a return type of Object. <rule key="SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS" priority="MAJOR"> <name><![CDATA[Dodgy - Transient field of class that isn't Serializable. ]]></name> <configKey><![CDATA[SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The field is marked as transient, but the class isn't Serializable, so marking it as transient has absolutely no effect. This may be leftover marking from a previous version of the code in which the class was transient, or @@ -1822,7 +1822,7 @@ it may indicate a misunderstanding of how serialization works. <rule key="SE_TRANSIENT_FIELD_NOT_RESTORED" priority="MAJOR"> <name><![CDATA[Bad practice - Transient field that isn't set by deserialization. ]]></name> <configKey><![CDATA[SE_TRANSIENT_FIELD_NOT_RESTORED]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class contains a field that is updated at multiple places in the class, thus it seems to be part of the state of the class. However, since the field is marked as transient and not set in readObject or readResolve, it will contain the default value in any deserialized instance of the class. </p>]]></description> @@ -1830,7 +1830,7 @@ deserialized instance of the class. <rule key="SE_METHOD_MUST_BE_PRIVATE" priority="MAJOR"> <name><![CDATA[Correctness - Method must be private in order for serialization to work]]></name> <configKey><![CDATA[SE_METHOD_MUST_BE_PRIVATE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class implements the <code>Serializable</code> interface, and defines a method for custom serialization/deserialization. But since that method isn't declared private, it will be silently ignored by the serialization/deserialization API.</p>]]></description> @@ -1838,7 +1838,7 @@ deserialized instance of the class. <rule key="SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION" priority="MAJOR"> <name><![CDATA[Bad practice - Class is Externalizable but doesn't define a void constructor]]></name> <configKey><![CDATA[SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class implements the <code>Externalizable</code> interface, but does not define a void constructor. When Externalizable objects are deserialized, they first need to be constructed by invoking the void @@ -1848,7 +1848,7 @@ deserialized instance of the class. <rule key="SE_NO_SUITABLE_CONSTRUCTOR" priority="MAJOR"> <name><![CDATA[Bad practice - Class is Serializable but its superclass doesn't define a void constructor]]></name> <configKey><![CDATA[SE_NO_SUITABLE_CONSTRUCTOR]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class implements the <code>Serializable</code> interface and its superclass does not. When such an object is deserialized, the fields of the superclass need to be initialized by @@ -1859,7 +1859,7 @@ deserialized instance of the class. <rule key="SE_NO_SERIALVERSIONID" priority="MAJOR"> <name><![CDATA[Bad practice - Class is Serializable, but doesn't define serialVersionUID]]></name> <configKey><![CDATA[SE_NO_SERIALVERSIONID]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class implements the <code>Serializable</code> interface, but does not define a <code>serialVersionUID</code> field. A change as simple as adding a reference to a .class object @@ -1876,7 +1876,7 @@ deserialized instance of the class. <rule key="SE_COMPARATOR_SHOULD_BE_SERIALIZABLE" priority="MAJOR"> <name><![CDATA[Bad practice - Comparator doesn't implement Serializable]]></name> <configKey><![CDATA[SE_COMPARATOR_SHOULD_BE_SERIALIZABLE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class implements the <code>Comparator</code> interface. You should consider whether or not it should also implement the <code>Serializable</code> interface. If a comparator is used to construct an ordered collection @@ -1890,14 +1890,14 @@ is generally easy and good defensive programming. <name> <![CDATA[Multithreaded correctness - Class's writeObject() method is synchronized but nothing else is]]></name> <configKey><![CDATA[WS_WRITEOBJECT_SYNC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class has a <code>writeObject()</code> method which is synchronized; however, no other method of the class is synchronized.</p>]]></description> </rule> <rule key="RS_READOBJECT_SYNC" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Class's readObject() method is synchronized]]></name> <configKey><![CDATA[RS_READOBJECT_SYNC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This serializable class defines a <code>readObject()</code> which is synchronized. By definition, an object created by deserialization is only reachable by one thread, and thus there is no need for @@ -1908,7 +1908,7 @@ is generally easy and good defensive programming. <rule key="SE_NONSTATIC_SERIALVERSIONID" priority="MAJOR"> <name><![CDATA[Bad practice - serialVersionUID isn't static]]></name> <configKey><![CDATA[SE_NONSTATIC_SERIALVERSIONID]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a <code>serialVersionUID</code> field that is not static. The field should be made static if it is intended to specify @@ -1917,7 +1917,7 @@ is generally easy and good defensive programming. <rule key="SE_NONFINAL_SERIALVERSIONID" priority="CRITICAL"> <name><![CDATA[Bad practice - serialVersionUID isn't final]]></name> <configKey><![CDATA[SE_NONFINAL_SERIALVERSIONID]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a <code>serialVersionUID</code> field that is not final. The field should be made final if it is intended to specify @@ -1926,7 +1926,7 @@ is generally easy and good defensive programming. <rule key="SE_NONLONG_SERIALVERSIONID" priority="MAJOR"> <name><![CDATA[Bad practice - serialVersionUID isn't long]]></name> <configKey><![CDATA[SE_NONLONG_SERIALVERSIONID]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class defines a <code>serialVersionUID</code> field that is not long. The field should be made long if it is intended to specify @@ -1935,7 +1935,7 @@ is generally easy and good defensive programming. <rule key="SE_BAD_FIELD_INNER_CLASS" priority="MINOR"> <name><![CDATA[Bad practice - Non-serializable class has a serializable inner class]]></name> <configKey><![CDATA[SE_BAD_FIELD_INNER_CLASS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This Serializable class is an inner class of a non-serializable class. Thus, attempts to serialize it will also attempt to associate instance of the outer class with which it is associated, leading to a runtime error. @@ -1948,7 +1948,7 @@ of the outer class, which it often not what you really want.]]></description> <rule key="SE_INNER_CLASS" priority="MAJOR"> <name><![CDATA[Bad practice - Serializable inner class]]></name> <configKey><![CDATA[SE_INNER_CLASS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This Serializable class is an inner class. Any attempt to serialize it will also serialize the associated outer instance. The outer instance is serializable, so this won't fail, but it might serialize a lot more data than intended. @@ -1958,14 +1958,14 @@ problem.]]></description> <rule key="SE_BAD_FIELD_STORE" priority="CRITICAL"> <name><![CDATA[Bad practice - Non-serializable value stored into instance field of a serializable class]]></name> <configKey><![CDATA[SE_BAD_FIELD_STORE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> A non-serializable value is stored into a non-transient field of a serializable class.</p>]]></description> </rule> <rule key="SC_START_IN_CTOR" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Constructor invokes Thread.start()]]></name> <configKey><![CDATA[SC_START_IN_CTOR]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The constructor starts a thread. This is likely to be wrong if the class is ever extended/subclassed, since the thread will be started before the subclass constructor is started.</p>]]></description> @@ -1973,7 +1973,7 @@ of a serializable class.</p>]]></description> <rule key="SS_SHOULD_BE_STATIC" priority="MAJOR"> <name><![CDATA[Performance - Unread field: should this field be static?]]></name> <configKey><![CDATA[SS_SHOULD_BE_STATIC]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This class contains an instance final field that is initialized to a compile-time static value. Consider making the field static.</p>]]></description> @@ -1981,19 +1981,19 @@ of a serializable class.</p>]]></description> <rule key="UUF_UNUSED_FIELD" priority="MAJOR"> <name><![CDATA[Performance - Unused field]]></name> <configKey><![CDATA[UUF_UNUSED_FIELD]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This field is never used. Consider removing it from the class.</p>]]></description> </rule> <rule key="URF_UNREAD_FIELD" priority="MAJOR"> <name><![CDATA[Performance - Unread field]]></name> <configKey><![CDATA[URF_UNREAD_FIELD]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This field is never read. Consider removing it from the class.</p>]]></description> </rule> <rule key="QF_QUESTIONABLE_FOR_LOOP" priority="CRITICAL"> <name><![CDATA[Dodgy - Complicated, subtle or wrong increment in for-loop ]]></name> <configKey><![CDATA[QF_QUESTIONABLE_FOR_LOOP]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p>Are you sure this for loop is incrementing the correct variable? It appears that another variable is being initialized and checked by the for loop. @@ -2002,7 +2002,7 @@ of a serializable class.</p>]]></description> <rule key="UWF_NULL_FIELD" priority="CRITICAL"> <name><![CDATA[Correctness - Field only ever set to null]]></name> <configKey><![CDATA[UWF_NULL_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> All writes to this field are of the constant value null, and thus all reads of the field will return null. Check for errors, or remove it if it is useless.</p>]]></description> @@ -2010,7 +2010,7 @@ Check for errors, or remove it if it is useless.</p>]]></description> <rule key="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD" priority="CRITICAL"> <name><![CDATA[Dodgy - Write to static field from instance method]]></name> <configKey><![CDATA[ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This instance method writes to a static field. This is tricky to get correct if multiple instances are being manipulated, and generally bad practice. @@ -2019,7 +2019,7 @@ and generally bad practice. <rule key="NP_LOAD_OF_KNOWN_NULL_VALUE" priority="CRITICAL"> <name><![CDATA[Dodgy - Load of known null value]]></name> <configKey><![CDATA[NP_LOAD_OF_KNOWN_NULL_VALUE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The variable referenced at this point is known to be null due to an earlier check against null. Although this is valid, it might be a mistake (perhaps you intended to refer to a different variable, or perhaps the earlier check to see if the @@ -2029,7 +2029,7 @@ variable is null should have been a check to see if it was nonnull). <rule key="NP_DEREFERENCE_OF_READLINE_VALUE" priority="CRITICAL"> <name><![CDATA[Dodgy - Dereference of the result of readLine() without nullcheck]]></name> <configKey><![CDATA[NP_DEREFERENCE_OF_READLINE_VALUE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The result of invoking readLine() is dereferenced without checking to see if the result is null. If there are no more lines of text to read, readLine() will return null and dereferencing that will generate a null pointer exception. </p>]]></description> @@ -2037,7 +2037,7 @@ to read, readLine() will return null and dereferencing that will generate a null <rule key="NP_IMMEDIATE_DEREFERENCE_OF_READLINE" priority="CRITICAL"> <name><![CDATA[Dodgy - Immediate dereference of the result of readLine()]]></name> <configKey><![CDATA[NP_IMMEDIATE_DEREFERENCE_OF_READLINE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The result of invoking readLine() is immediately dereferenced. If there are no more lines of text to read, readLine() will return null and dereferencing that will generate a null pointer exception. </p>]]></description> @@ -2045,7 +2045,7 @@ to read, readLine() will return null and dereferencing that will generate a null <rule key="SIC_INNER_SHOULD_BE_STATIC" priority="MAJOR"> <name><![CDATA[Performance - Should be a static inner class]]></name> <configKey><![CDATA[SIC_INNER_SHOULD_BE_STATIC]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This class is an inner class, but does not use its embedded reference to the object which created it. This reference makes the instances of the class larger, and may keep the reference to the creator object @@ -2056,7 +2056,7 @@ to read, readLine() will return null and dereferencing that will generate a null <rule key="SIC_INNER_SHOULD_BE_STATIC_ANON" priority="MAJOR"> <name><![CDATA[Performance - Could be refactored into a named static inner class]]></name> <configKey><![CDATA[SIC_INNER_SHOULD_BE_STATIC_ANON]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This class is an inner class, but does not use its embedded reference to the object which created it. This reference makes the instances of the class larger, and may keep the reference to the creator object @@ -2068,7 +2068,7 @@ the inner class so that it is a named inner class.</p>]]></description> <rule key="SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS" priority="MAJOR"> <name><![CDATA[Performance - Could be refactored into a static inner class]]></name> <configKey><![CDATA[SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This class is an inner class, but does not use its embedded reference to the object which created it except during construction of the inner object. This reference makes the instances @@ -2083,7 +2083,7 @@ inner object. This reference makes the instances <rule key="WA_NOT_IN_LOOP" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Wait not in loop ]]></name> <configKey><![CDATA[WA_NOT_IN_LOOP]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a call to <code>java.lang.Object.wait()</code> which is not in a loop. If the monitor is used for multiple conditions, the condition the caller intended to wait for might not be the one @@ -2092,7 +2092,7 @@ inner object. This reference makes the instances <rule key="WA_AWAIT_NOT_IN_LOOP" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Condition.await() not in loop ]]></name> <configKey><![CDATA[WA_AWAIT_NOT_IN_LOOP]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a call to <code>java.util.concurrent.await()</code> (or variants) which is not in a loop. If the object is used for multiple conditions, @@ -2102,7 +2102,7 @@ inner object. This reference makes the instances <rule key="NO_NOTIFY_NOT_NOTIFYALL" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Using notify() rather than notifyAll()]]></name> <configKey><![CDATA[NO_NOTIFY_NOT_NOTIFYALL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls <code>notify()</code> rather than <code>notifyAll()</code>. Java monitors are often used for multiple conditions. Calling <code>notify()</code> only wakes up one thread, meaning that the thread woken up might not be the @@ -2111,7 +2111,7 @@ inner object. This reference makes the instances <rule key="RV_CHECK_FOR_POSITIVE_INDEXOF" priority="MINOR"> <name><![CDATA[Dodgy - Method checks to see if result of String.indexOf is positive]]></name> <configKey><![CDATA[RV_CHECK_FOR_POSITIVE_INDEXOF]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The method invokes String.indexOf and checks to see if the result is positive or non-positive. It is much more typical to check to see if the result is negative or non-negative. It is positive only if the substring checked for occurs at some place other than at the beginning of @@ -2120,7 +2120,7 @@ inner object. This reference makes the instances <rule key="RV_DONT_JUST_NULL_CHECK_READLINE" priority="MAJOR"> <name><![CDATA[Dodgy - Method discards result of readLine after checking if it is nonnull]]></name> <configKey><![CDATA[RV_DONT_JUST_NULL_CHECK_READLINE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The value returned by readLine is discarded after checking to see if the return value is non-null. In almost all situations, if the result is non-null, you will want to use that non-null value. Calling readLine again will give you a different line.</p>]]></description> @@ -2128,7 +2128,7 @@ to use that non-null value. Calling readLine again will give you a different lin <rule key="RV_RETURN_VALUE_IGNORED" priority="MINOR"> <name><![CDATA[Correctness - Method ignores return value]]></name> <configKey><![CDATA[RV_RETURN_VALUE_IGNORED]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The return value of this method should be checked. One common cause of this warning is to invoke a method on an immutable object, thinking that it updates the object. For example, in the following code @@ -2153,7 +2153,7 @@ dateString = dateString.trim(); <rule key="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE" priority="MAJOR"> <name><![CDATA[Bad practice - Method ignores exceptional return value]]></name> <configKey><![CDATA[RV_RETURN_VALUE_IGNORED_BAD_PRACTICE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method returns a value that is not checked. The return value should be checked since it can indicate an unusual or unexpected function execution. For example, the <code>File.delete()</code> method returns false @@ -2166,7 +2166,7 @@ signals unexpected behavior by returning an atypical return value. <rule key="RV_EXCEPTION_NOT_THROWN" priority="CRITICAL"> <name><![CDATA[Correctness - Exception created and dropped rather than thrown]]></name> <configKey><![CDATA[RV_EXCEPTION_NOT_THROWN]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code creates an exception (or error) object, but doesn't do anything with it. For example, something like </p> <blockquote> @@ -2186,7 +2186,7 @@ if (x < 0) <rule key="RV_RETURN_VALUE_IGNORED2" priority="MAJOR"> <name><![CDATA[Correctness - Method ignores return value]]></name> <configKey><![CDATA[RV_RETURN_VALUE_IGNORED2]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The return value of this method should be checked. One common cause of this warning is to invoke a method on an immutable object, thinking that it updates the object. For example, in the following code @@ -2211,21 +2211,21 @@ dateString = dateString.trim(); <rule key="NP_ALWAYS_NULL" priority="CRITICAL"> <name><![CDATA[Correctness - Null pointer dereference]]></name> <configKey><![CDATA[NP_ALWAYS_NULL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A null pointer is dereferenced here. This will lead to a <code>NullPointerException</code> when the code is executed.</p>]]></description> </rule> <rule key="NP_STORE_INTO_NONNULL_FIELD" priority="CRITICAL"> <name><![CDATA[Correctness - Store of null value into field annotated NonNull]]></name> <configKey><![CDATA[NP_STORE_INTO_NONNULL_FIELD]]></configKey> - <category name="Reliability"/> + <description> <![CDATA[<p> A value that could be null is stored into a field that has been annotated as NonNull. </p>]]></description> </rule> <rule key="NP_ALWAYS_NULL_EXCEPTION" priority="CRITICAL"> <name><![CDATA[Correctness - Null pointer dereference in method on exception path]]></name> <configKey><![CDATA[NP_ALWAYS_NULL_EXCEPTION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A pointer which is null on an exception path is dereferenced here. This will lead to a <code>NullPointerException</code> when the code is executed. Note that because FindBugs currently does not prune infeasible exception paths, @@ -2237,7 +2237,7 @@ be an exception path, since the default case is often infeasible.</p>]]></descri <rule key="NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE" priority="CRITICAL"> <name><![CDATA[Dodgy - Parameter must be nonnull but is marked as nullable]]></name> <configKey><![CDATA[NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This parameter is always used in a way that requires it to be nonnull, but the parameter is explicitly annotated as being Nullable. Either the use of the parameter or the annotation is wrong. @@ -2246,7 +2246,7 @@ of the parameter or the annotation is wrong. <rule key="NP_NULL_ON_SOME_PATH" priority="CRITICAL"> <name><![CDATA[Correctness - Possible null pointer dereference]]></name> <configKey><![CDATA[NP_NULL_ON_SOME_PATH]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> There is a branch of statement that, <em>if executed,</em> guarantees that a null value will be dereferenced, which would generate a <code>NullPointerException</code> when the code is executed. @@ -2257,7 +2257,7 @@ the null pointer exception can't ever be executed; deciding that is beyond the a <rule key="NP_NULL_ON_SOME_PATH_MIGHT_BE_INFEASIBLE" priority="CRITICAL"> <name><![CDATA[Dodgy - Possible null pointer dereference on path that might be infeasible]]></name> <configKey><![CDATA[NP_NULL_ON_SOME_PATH_MIGHT_BE_INFEASIBLE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> There is a branch of statement that, <em>if executed,</em> guarantees that a null value will be dereferenced, which would generate a <code>NullPointerException</code> when the code is executed. @@ -2269,7 +2269,7 @@ Due to the fact that this value had been previously tested for nullness, this is <rule key="NP_NULL_ON_SOME_PATH_EXCEPTION" priority="CRITICAL"> <name><![CDATA[Correctness - Possible null pointer dereference in method on exception path]]></name> <configKey><![CDATA[NP_NULL_ON_SOME_PATH_EXCEPTION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A reference value which is null on some exception control path is dereferenced here. This may lead to a <code>NullPointerException</code> when the code is executed. @@ -2282,7 +2282,7 @@ be an exception path, since the default case is often infeasible.</p>]]></descri <rule key="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE" priority="CRITICAL"> <name><![CDATA[Dodgy - Possible null pointer dereference due to return value of called method]]></name> <configKey><![CDATA[NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The return value from a method is dereferenced without a null check, and the return value of that method is one that should generally be checked for null. This may lead to a <code>NullPointerException</code> when the code is executed. @@ -2291,7 +2291,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_NULL_PARAM_DEREF_NONVIRTUAL" priority="CRITICAL"> <name><![CDATA[Correctness - Non-virtual method call passes null for nonnull parameter]]></name> <configKey><![CDATA[NP_NULL_PARAM_DEREF_NONVIRTUAL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A possibly-null value is passed to a nonnull method parameter. Either the parameter is annotated as a parameter that should @@ -2302,7 +2302,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS" priority="CRITICAL"> <name><![CDATA[Correctness - Method call passes null for nonnull parameter]]></name> <configKey><![CDATA[NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A possibly-null value is passed at a call site where all known target methods require the parameter to be nonnull. @@ -2314,7 +2314,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_NULL_PARAM_DEREF" priority="CRITICAL"> <name><![CDATA[Correctness - Method call passes null for nonnull parameter]]></name> <configKey><![CDATA[NP_NULL_PARAM_DEREF]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method call passes a null value for a nonnull method parameter. Either the parameter is annotated as a parameter that should @@ -2325,7 +2325,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_NONNULL_PARAM_VIOLATION" priority="CRITICAL"> <name><![CDATA[Correctness - Method call passes null to a nonnull parameter ]]></name> <configKey><![CDATA[NP_NONNULL_PARAM_VIOLATION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method passes a null value as the parameter of a method which must be nonnull. Either this parameter has been explicitly marked @@ -2336,7 +2336,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_NONNULL_RETURN_VIOLATION" priority="CRITICAL"> <name><![CDATA[Correctness - Method may return null, but is declared @NonNull]]></name> <configKey><![CDATA[NP_NONNULL_RETURN_VIOLATION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method may return a null value, but the method (or a superclass method which it overrides) is declared to return @NonNull. @@ -2345,7 +2345,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_CLONE_COULD_RETURN_NULL" priority="CRITICAL"> <name><![CDATA[Bad practice - Clone method may return null]]></name> <configKey><![CDATA[NP_CLONE_COULD_RETURN_NULL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This clone method seems to return null in some circumstances, but clone is never allowed to return a null value. If you are convinced this path is unreachable, throw an AssertionError @@ -2355,7 +2355,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_TOSTRING_COULD_RETURN_NULL" priority="CRITICAL"> <name><![CDATA[Bad practice - toString method may return null]]></name> <configKey><![CDATA[NP_TOSTRING_COULD_RETURN_NULL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This toString method seems to return null in some circumstances. A liberal reading of the spec could be interpreted as allowing this, but it is probably a bad idea and could cause @@ -2365,7 +2365,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_GUARANTEED_DEREF" priority="BLOCKER"> <name><![CDATA[Correctness - Null value is guaranteed to be dereferenced]]></name> <configKey><![CDATA[NP_GUARANTEED_DEREF]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> There is a statement or branch that if executed guarantees that a value is null at this point, and that @@ -2376,7 +2376,7 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH" priority="CRITICAL"> <name><![CDATA[Correctness - Value is null and guaranteed to be dereferenced on exception path]]></name> <configKey><![CDATA[NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> There is a statement or branch on an exception path that if executed guarantees that @@ -2388,14 +2388,14 @@ for null. This may lead to a <code>NullPointerException</code> when the code is <rule key="SI_INSTANCE_BEFORE_FINALS_ASSIGNED" priority="CRITICAL"> <name><![CDATA[Bad practice - Static initializer creates instance before all static final fields assigned]]></name> <configKey><![CDATA[SI_INSTANCE_BEFORE_FINALS_ASSIGNED]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The class's static initializer creates an instance of the class before all of the static final fields are assigned.</p>]]></description> </rule> <rule key="OS_OPEN_STREAM" priority="CRITICAL"> <name><![CDATA[Bad practice - Method may fail to close stream]]></name> <configKey><![CDATA[OS_OPEN_STREAM]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The method creates an IO stream object, does not assign it to any fields, pass it to other methods that might close it, or return it, and does not appear to close @@ -2407,7 +2407,7 @@ closed.</p>]]></description> <rule key="OS_OPEN_STREAM_EXCEPTION_PATH" priority="CRITICAL"> <name><![CDATA[Bad practice - Method may fail to close stream on exception]]></name> <configKey><![CDATA[OS_OPEN_STREAM_EXCEPTION_PATH]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The method creates an IO stream object, does not assign it to any fields, pass it to other methods, or return it, and does not appear to close it on all possible exception paths out of the method. @@ -2418,7 +2418,7 @@ closed.</p>]]></description> <rule key="PZLA_PREFER_ZERO_LENGTH_ARRAYS" priority="MAJOR"> <name><![CDATA[Dodgy - Consider returning a zero length array rather than null]]></name> <configKey><![CDATA[PZLA_PREFER_ZERO_LENGTH_ARRAYS]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> It is often a better design to return a length zero array rather than a null reference to indicate that there are no results (i.e., an empty list of results). @@ -2433,7 +2433,7 @@ is not a directory.</p>]]></description> <rule key="UCF_USELESS_CONTROL_FLOW" priority="CRITICAL"> <name><![CDATA[Dodgy - Useless control flow]]></name> <configKey><![CDATA[UCF_USELESS_CONTROL_FLOW]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method contains a useless control flow statement, where control flow continues onto the same place regardless of whether or not the branch is taken. For example, @@ -2448,7 +2448,7 @@ block for an <code>if</code> statement:</p> <rule key="UCF_USELESS_CONTROL_FLOW_NEXT_LINE" priority="CRITICAL"> <name><![CDATA[Correctness - Useless control flow to next line]]></name> <configKey><![CDATA[UCF_USELESS_CONTROL_FLOW_NEXT_LINE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a useless control flow statement in which control flow follows to the same or following line regardless of whether or not the branch is taken. @@ -2462,7 +2462,7 @@ body of an <code>if</code> statement, e.g.:</p> <rule key="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE" priority="CRITICAL"> <name><![CDATA[Correctness - Nullcheck of value previously dereferenced]]></name> <configKey><![CDATA[RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value is checked here to see whether it is null, but this value can't be null because it was previously dereferenced and if it were null a null pointer exception would have occurred at the earlier dereference. @@ -2473,35 +2473,35 @@ or the previous dereference is erroneous.</p>]]></description> <rule key="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE" priority="CRITICAL"> <name><![CDATA[Dodgy - Redundant nullcheck of value known to be null]]></name> <configKey><![CDATA[RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method contains a redundant check of a known null value against the constant null.</p>]]></description> </rule> <rule key="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE" priority="CRITICAL"> <name><![CDATA[Dodgy - Redundant nullcheck of value known to be non-null]]></name> <configKey><![CDATA[RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method contains a redundant check of a known non-null value against the constant null.</p>]]></description> </rule> <rule key="RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES" priority="CRITICAL"> <name><![CDATA[Dodgy - Redundant comparison of two null values]]></name> <configKey><![CDATA[RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method contains a redundant comparison of two references known to both be definitely null.</p>]]></description> </rule> <rule key="RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE" priority="CRITICAL"> <name><![CDATA[Dodgy - Redundant comparison of non-null value to null]]></name> <configKey><![CDATA[RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method contains a reference known to be non-null with another reference known to be null.</p>]]></description> </rule> <rule key="UL_UNRELEASED_LOCK" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Method does not release lock on all paths]]></name> <configKey><![CDATA[UL_UNRELEASED_LOCK]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock, but does not release it on all paths out of the method. In general, the correct idiom for using a JSR-166 lock is: @@ -2519,7 +2519,7 @@ for using a JSR-166 lock is: <rule key="UL_UNRELEASED_LOCK_EXCEPTION_PATH" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Method does not release lock on all exception paths]]></name> <configKey><![CDATA[UL_UNRELEASED_LOCK_EXCEPTION_PATH]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock, but does not release it on all exception paths out of the method. In general, the correct idiom for using a JSR-166 lock is: @@ -2537,7 +2537,7 @@ for using a JSR-166 lock is: <rule key="RC_REF_COMPARISON" priority="CRITICAL"> <name><![CDATA[Bad practice - Suspicious reference comparison]]></name> <configKey><![CDATA[RC_REF_COMPARISON]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method compares two reference values using the == or != operator, where the correct way to compare instances of this type is generally with the equals() method. Examples of classes which should generally @@ -2546,7 +2546,7 @@ not be compared by reference are java.lang.Integer, java.lang.Float, etc.</p>]]> <rule key="EC_UNRELATED_TYPES_USING_POINTER_EQUALITY" priority="CRITICAL"> <name><![CDATA[Correctness - Using pointer equality to compare different types]]></name> <configKey><![CDATA[EC_UNRELATED_TYPES_USING_POINTER_EQUALITY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method uses using pointer equality to compare two references that seem to be of different types. The result of this comparison will always be false at runtime. </p>]]></description> @@ -2554,7 +2554,7 @@ different types. The result of this comparison will always be false at runtime. <rule key="EC_UNRELATED_TYPES" priority="CRITICAL"> <name><![CDATA[Correctness - Call to equals() comparing different types]]></name> <configKey><![CDATA[EC_UNRELATED_TYPES]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls equals(Object) on two references of different class types with no common subclasses. Therefore, the objects being compared @@ -2571,7 +2571,7 @@ the result of this comparison will always be false at runtime. <rule key="EC_UNRELATED_INTERFACES" priority="CRITICAL"> <name><![CDATA[Correctness - Call to equals() comparing different interface types]]></name> <configKey><![CDATA[EC_UNRELATED_INTERFACES]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls equals(Object) on two references of unrelated interface types, where neither is a subtype of the other, and there are no known non-abstract classes which implement both interfaces. @@ -2589,7 +2589,7 @@ the result of this comparison will always be false at runtime. <rule key="EC_UNRELATED_CLASS_AND_INTERFACE" priority="CRITICAL"> <name><![CDATA[Correctness - Call to equals() comparing unrelated class and interface]]></name> <configKey><![CDATA[EC_UNRELATED_CLASS_AND_INTERFACE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls equals(Object) on two references, one of which is a class and the other an interface, where neither the class nor any of its @@ -2608,7 +2608,7 @@ the result of this comparison will always be false at runtime. <rule key="EC_NULL_ARG" priority="CRITICAL"> <name><![CDATA[Correctness - Call to equals() with null argument]]></name> <configKey><![CDATA[EC_NULL_ARG]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls equals(Object), passing a null value as the argument. According to the contract of the equals() method, this call should always return <code>false</code>.</p>]]></description> @@ -2616,7 +2616,7 @@ this call should always return <code>false</code>.</p>]]></description> <rule key="MWN_MISMATCHED_WAIT" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Mismatched wait()]]></name> <configKey><![CDATA[MWN_MISMATCHED_WAIT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls Object.wait() without obviously holding a lock on the object. Calling wait() without a lock held will result in an <code>IllegalMonitorStateException</code> being thrown.</p>]]></description> @@ -2624,7 +2624,7 @@ an <code>IllegalMonitorStateException</code> being thrown.</p>]]></description> <rule key="MWN_MISMATCHED_NOTIFY" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Mismatched notify()]]></name> <configKey><![CDATA[MWN_MISMATCHED_NOTIFY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls Object.notify() or Object.notifyAll() without obviously holding a lock on the object. Calling notify() or notifyAll() without a lock held will result in an <code>IllegalMonitorStateException</code> being thrown.</p>]]></description> @@ -2632,7 +2632,7 @@ an <code>IllegalMonitorStateException</code> being thrown.</p>]]></description> <rule key="SA_LOCAL_SELF_ASSIGNMENT" priority="CRITICAL"> <name><![CDATA[Dodgy - Self assignment of local variable]]></name> <configKey><![CDATA[SA_LOCAL_SELF_ASSIGNMENT]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method contains a self assignment of a local variable; e.g.</p> <pre> public void foo() { @@ -2647,7 +2647,7 @@ Such assignments are useless, and may indicate a logic error or typo. <rule key="SA_FIELD_SELF_ASSIGNMENT" priority="CRITICAL"> <name><![CDATA[Correctness - Self assignment of field]]></name> <configKey><![CDATA[SA_FIELD_SELF_ASSIGNMENT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a self assignment of a field; e.g. </p> <pre> @@ -2661,7 +2661,7 @@ Such assignments are useless, and may indicate a logic error or typo. <rule key="SA_FIELD_DOUBLE_ASSIGNMENT" priority="CRITICAL"> <name><![CDATA[Correctness - Double assignment of field]]></name> <configKey><![CDATA[SA_FIELD_DOUBLE_ASSIGNMENT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a double assignment of a field; e.g. </p> <pre> @@ -2675,7 +2675,7 @@ Such assignments are useless, and may indicate a logic error or typo. <rule key="SA_LOCAL_DOUBLE_ASSIGNMENT" priority="CRITICAL"> <name><![CDATA[Dodgy - Double assignment of local variable ]]></name> <configKey><![CDATA[SA_LOCAL_DOUBLE_ASSIGNMENT]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method contains a double assignment of a local variable; e.g. </p> <pre> @@ -2689,7 +2689,7 @@ Such assignments are useless, and may indicate a logic error or typo. <rule key="SA_FIELD_SELF_COMPUTATION" priority="CRITICAL"> <name><![CDATA[Correctness - Nonsensical self computation involving a field (e.g., x & x)]]></name> <configKey><![CDATA[SA_FIELD_SELF_COMPUTATION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method performs a nonsensical computation of a field with another reference to the same field (e.g., x&x or x-x). Because of the nature of the computation, this operation doesn't seem to make sense, @@ -2700,7 +2700,7 @@ a logic error. Double check the computation. <rule key="SA_LOCAL_SELF_COMPUTATION" priority="CRITICAL"> <name><![CDATA[Correctness - Nonsensical self computation involving a variable (e.g., x & x)]]></name> <configKey><![CDATA[SA_LOCAL_SELF_COMPUTATION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method performs a nonsensical computation of a local variable with another reference to the same variable (e.g., x&x or x-x). Because of the nature of the computation, this operation doesn't seem to make sense, @@ -2711,7 +2711,7 @@ a logic error. Double check the computation. <rule key="SA_FIELD_SELF_COMPARISON" priority="CRITICAL"> <name><![CDATA[Correctness - Self comparison of field with itself]]></name> <configKey><![CDATA[SA_FIELD_SELF_COMPARISON]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method compares a field with itself, and may indicate a typo or a logic error. Make sure that you are comparing the right things. </p>]]></description> @@ -2719,7 +2719,7 @@ a logic error. Make sure that you are comparing the right things. <rule key="SA_LOCAL_SELF_COMPARISON" priority="CRITICAL"> <name><![CDATA[Correctness - Self comparison of value with itself]]></name> <configKey><![CDATA[SA_LOCAL_SELF_COMPARISON]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method compares a local variable with itself, and may indicate a typo or a logic error. Make sure that you are comparing the right things. </p>]]></description> @@ -2727,7 +2727,7 @@ a logic error. Make sure that you are comparing the right things. <rule key="DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT" priority="CRITICAL"> <name><![CDATA[Correctness - Double.longBitsToDouble invoked on an int]]></name> <configKey><![CDATA[DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The Double.longBitsToDouble method is invoked, but a 32 bit int value is passed as an argument. This almostly certainly is not intended and is unlikely to give the intended result. @@ -2736,7 +2736,7 @@ a logic error. Make sure that you are comparing the right things. <rule key="DMI_RANDOM_USED_ONLY_ONCE" priority="CRITICAL"> <name><![CDATA[Bad practice - Random object created and used only once]]></name> <configKey><![CDATA[DMI_RANDOM_USED_ONLY_ONCE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This code creates a java.util.Random object, uses it to generate one random number, and then discards the Random object. This produces mediocre quality random numbers and is inefficient. If possible, rewrite the code so that the Random object is created once and saved, and each time a new random number @@ -2751,7 +2751,7 @@ number; the values are too easily guessable. You should strongly consider using <rule key="RV_ABSOLUTE_VALUE_OF_RANDOM_INT" priority="CRITICAL"> <name><![CDATA[Correctness - Bad attempt to compute absolute value of signed 32-bit random integer]]></name> <configKey><![CDATA[RV_ABSOLUTE_VALUE_OF_RANDOM_INT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code generates a random signed integer and then computes the absolute value of that random integer. If the number returned by the random number generator is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since @@ -2761,7 +2761,7 @@ generator is <code>Integer.MIN_VALUE</code>, then the result will be negative as <rule key="RV_ABSOLUTE_VALUE_OF_HASHCODE" priority="CRITICAL"> <name><![CDATA[Correctness - Bad attempt to compute absolute value of signed 32-bit hashcode ]]></name> <configKey><![CDATA[RV_ABSOLUTE_VALUE_OF_HASHCODE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code generates a hashcode and then computes the absolute value of that hashcode. If the hashcode is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since @@ -2771,7 +2771,7 @@ is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (sin <rule key="RV_REM_OF_RANDOM_INT" priority="CRITICAL"> <name><![CDATA[Dodgy - Remainder of 32-bit signed random integer]]></name> <configKey><![CDATA[RV_REM_OF_RANDOM_INT]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code generates a random signed integer and then computes the remainder of that value modulo another value. Since the random number can be negative, the result of the remainder operation @@ -2782,7 +2782,7 @@ consider using the Random.nextInt(int) method instead. <rule key="RV_REM_OF_HASHCODE" priority="CRITICAL"> <name><![CDATA[Dodgy - Remainder of hashCode could be negative]]></name> <configKey><![CDATA[RV_REM_OF_HASHCODE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code computes a hashCode, and then computes the remainder of that value modulo another value. Since the hashCode can be negative, the result of the remainder operation @@ -2801,14 +2801,14 @@ value of the result of the remainder operation (i.e., use <rule key="INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE" priority="CRITICAL"> <name><![CDATA[Correctness - Bad comparison of nonnegative value with negative constant]]></name> <configKey><![CDATA[INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code compares a value that is guaranteed to be non-negative with a negative constant. </p>]]></description> </rule> <rule key="INT_BAD_COMPARISON_WITH_SIGNED_BYTE" priority="CRITICAL"> <name><![CDATA[Correctness - Bad comparison of signed byte]]></name> <configKey><![CDATA[INT_BAD_COMPARISON_WITH_SIGNED_BYTE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Signed bytes can only have a value in the range -128 to 127. Comparing a signed byte with a value outside that range is vacuous and likely to be incorrect. To convert a signed byte <code>b</code> to an unsigned value in the range 0..255, @@ -2818,7 +2818,7 @@ use <code>0xff & b</code> <rule key="INT_VACUOUS_BIT_OPERATION" priority="CRITICAL"> <name><![CDATA[Dodgy - Vacuous bit mask operation on integer value]]></name> <configKey><![CDATA[INT_VACUOUS_BIT_OPERATION]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This is an integer bit operation (and, or, or exclusive or) that doesn't do any useful work (e.g., <code>v & 0xffffffff</code>). @@ -2827,7 +2827,7 @@ use <code>0xff & b</code> <rule key="INT_VACUOUS_COMPARISON" priority="CRITICAL"> <name><![CDATA[Dodgy - Vacuous comparison of integer value]]></name> <configKey><![CDATA[INT_VACUOUS_COMPARISON]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> There is an integer comparison that always returns the same value (e.g., x <= Integer.MAX_VALUE). </p>]]></description> @@ -2835,7 +2835,7 @@ the same value (e.g., x <= Integer.MAX_VALUE). <rule key="INT_BAD_REM_BY_1" priority="CRITICAL"> <name><![CDATA[Correctness - Integer remainder modulo 1]]></name> <configKey><![CDATA[INT_BAD_REM_BY_1]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Any expression (exp % 1) is guaranteed to always return zero. Did you mean (exp & 1) or (exp % 2) instead? </p>]]></description> @@ -2843,7 +2843,7 @@ Did you mean (exp & 1) or (exp % 2) instead? <rule key="BIT_IOR_OF_SIGNED_BYTE" priority="CRITICAL"> <name><![CDATA[Correctness - Bitwise OR of signed byte value]]></name> <configKey><![CDATA[BIT_IOR_OF_SIGNED_BYTE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Loads a value from a byte array and performs a bitwise OR with that value. Values loaded from a byte array are sign extended to 32 bits before any any bitwise operations are performed on the value. @@ -2871,7 +2871,7 @@ for(int i = 0; i < 4; i++) <rule key="BIT_ADD_OF_SIGNED_BYTE" priority="CRITICAL"> <name><![CDATA[Correctness - Bitwise add of signed byte value]]></name> <configKey><![CDATA[BIT_ADD_OF_SIGNED_BYTE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Adds a byte value and a value which is known to the 8 lower bits clear. Values loaded from a byte array are sign extended to 32 bits before any any bitwise operations are performed on the value. @@ -2899,7 +2899,7 @@ for(int i = 0; i < 4; i++) <rule key="BIT_AND" priority="CRITICAL"> <name><![CDATA[Correctness - Incompatible bit masks]]></name> <configKey><![CDATA[BIT_AND]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method compares an expression of the form (e & C) to D, which will always compare unequal due to the specific values of constants C and D. @@ -2908,7 +2908,7 @@ This may indicate a logic error or typo.</p>]]></description> <rule key="BIT_SIGNED_CHECK" priority="CRITICAL"> <name><![CDATA[Bad practice - Check for sign of bitwise operation]]></name> <configKey><![CDATA[BIT_SIGNED_CHECK]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This method compares an expression such as <pre>((event.detail & SWT.SELECTED) > 0)</pre>. Using bit arithmetic and then comparing with the greater than operator can @@ -2924,7 +2924,7 @@ to use '!= 0' instead of '> 0'. <rule key="BIT_SIGNED_CHECK_HIGH_BIT" priority="CRITICAL"> <name><![CDATA[Correctness - Check for sign of bitwise operation]]></name> <configKey><![CDATA[BIT_SIGNED_CHECK_HIGH_BIT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method compares an expression such as <pre>((event.detail & SWT.SELECTED) > 0)</pre>. Using bit arithmetic and then comparing with the greater than operator can @@ -2940,7 +2940,7 @@ to use '!= 0' instead of '> 0'. <rule key="BIT_AND_ZZ" priority="CRITICAL"> <name><![CDATA[Correctness - Check to see if ((...) & 0) == 0]]></name> <configKey><![CDATA[BIT_AND_ZZ]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method compares an expression of the form (e & 0) to 0, which will always compare equal. This may indicate a logic error or typo.</p>]]></description> @@ -2948,7 +2948,7 @@ This may indicate a logic error or typo.</p>]]></description> <rule key="BIT_IOR" priority="CRITICAL"> <name><![CDATA[Correctness - Incompatible bit masks]]></name> <configKey><![CDATA[BIT_IOR]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method compares an expression of the form (e | C) to D. which will always compare unequal due to the specific values of constants C and D. @@ -2961,7 +2961,7 @@ operator ("|") instead of bitwise AND ("&").</p>]]></description> <rule key="LI_LAZY_INIT_STATIC" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Incorrect lazy initialization of static field]]></name> <configKey><![CDATA[LI_LAZY_INIT_STATIC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains an unsynchronized lazy initialization of a non-volatile static field. Because the compiler or processor may reorder instructions, threads are not guaranteed to see a completely initialized object, @@ -2974,7 +2974,7 @@ For more information, see the <rule key="LI_LAZY_INIT_UPDATE_STATIC" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Incorrect lazy initialization and update of static field]]></name> <configKey><![CDATA[LI_LAZY_INIT_UPDATE_STATIC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains an unsynchronized lazy initialization of a static field. After the field is set, the object stored into that location is further accessed. The setting of the field is visible to other threads as soon as it is set. If the @@ -2986,7 +2986,7 @@ any other thread from accessing the stored object until it is fully initialized. <rule key="JLM_JSR166_LOCK_MONITORENTER" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Synchronization performed on java.util.concurrent Lock]]></name> <configKey><![CDATA[JLM_JSR166_LOCK_MONITORENTER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method performs synchronization on an implementation of <code>java.util.concurrent.locks.Lock</code>. You should use the <code>lock()</code> and <code>unlock()</code> methods instead. @@ -2995,7 +2995,7 @@ the <code>lock()</code> and <code>unlock()</code> methods instead. <rule key="UPM_UNCALLED_PRIVATE_METHOD" priority="CRITICAL"> <name><![CDATA[Performance - Private method is never called]]></name> <configKey><![CDATA[UPM_UNCALLED_PRIVATE_METHOD]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This private method is never called. Although it is possible that the method will be invoked through reflection, it is more likely that the method is never used, and should be @@ -3005,7 +3005,7 @@ removed. <rule key="UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS" priority="CRITICAL"> <name><![CDATA[Correctness - Uncallable method defined in anonymous class]]></name> <configKey><![CDATA[UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This anonymous class defined a method that is not directly invoked and does not override a method in a superclass. Since methods in other classes cannot directly invoke methods declared in an anonymous class, it seems that this method is uncallable. The method @@ -3017,7 +3017,7 @@ in fact, override the method it is intended to. <rule key="ODR_OPEN_DATABASE_RESOURCE" priority="CRITICAL"> <name><![CDATA[Bad practice - Method may fail to close database resource]]></name> <configKey><![CDATA[ODR_OPEN_DATABASE_RESOURCE]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The method creates a database resource (such as a database connection or row set), does not assign it to any fields, pass it to other methods, or return it, and does not appear to close @@ -3030,7 +3030,7 @@ have problems communicating with the database. <rule key="ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH" priority="CRITICAL"> <name><![CDATA[Bad practice - Method may fail to close database resource on exception]]></name> <configKey><![CDATA[ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The method creates a database resource (such as a database connection or row set), does not assign it to any fields, pass it to other methods, or return it, and does not appear to close @@ -3042,7 +3042,7 @@ have problems communicating with the database.</p>]]></description> <rule key="SBSC_USE_STRINGBUFFER_CONCATENATION" priority="CRITICAL"> <name><![CDATA[Performance - Method concatenates strings using + in a loop]]></name> <configKey><![CDATA[SBSC_USE_STRINGBUFFER_CONCATENATION]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> The method seems to be building a String using concatenation in a loop. In each iteration, the String is converted to a StringBuffer/StringBuilder, appended to, and converted back to a String. @@ -3071,7 +3071,7 @@ a StringBuffer (or StringBuilder in Java 1.5) explicitly.</p> <rule key="ITA_INEFFICIENT_TO_ARRAY" priority="CRITICAL"> <name><![CDATA[Performance - Method uses toArray() with zero-length array argument]]></name> <configKey><![CDATA[ITA_INEFFICIENT_TO_ARRAY]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This method uses the toArray() method of a collection derived class, and passes in a zero-length prototype array argument. It is more efficient to use <code>myCollection.toArray(new Foo[myCollection.size()])</code> @@ -3083,7 +3083,7 @@ directly. This avoids the need to create a second array <rule key="IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD" priority="CRITICAL"> <name><![CDATA[Correctness - JUnit assertion in run method will not be noticed by JUnit]]></name> <configKey><![CDATA[IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A JUnit assertion is performed in a run method. Failed JUnit assertions just result in exceptions being thrown. Thus, if this exception occurs in a thread other than the thread that invokes @@ -3094,28 +3094,28 @@ in the test failing. <rule key="IJU_SETUP_NO_SUPER" priority="CRITICAL"> <name><![CDATA[Correctness - TestCase defines setUp that doesn't call super.setUp()]]></name> <configKey><![CDATA[IJU_SETUP_NO_SUPER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Class is a JUnit TestCase and implements the setUp method. The setUp method should call super.setUp(), but doesn't.</p>]]></description> </rule> <rule key="IJU_TEARDOWN_NO_SUPER" priority="CRITICAL"> <name><![CDATA[Correctness - TestCase defines tearDown that doesn't call super.tearDown()]]></name> <configKey><![CDATA[IJU_TEARDOWN_NO_SUPER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Class is a JUnit TestCase and implements the tearDown method. The tearDown method should call super.tearDown(), but doesn't.</p>]]></description> </rule> <rule key="IJU_SUITE_NOT_STATIC" priority="CRITICAL"> <name><![CDATA[Correctness - TestCase implements a non-static suite method ]]></name> <configKey><![CDATA[IJU_SUITE_NOT_STATIC]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Class is a JUnit TestCase and implements the suite() method. The suite method should be declared as being static, but isn't.</p>]]></description> </rule> <rule key="IJU_BAD_SUITE_METHOD" priority="CRITICAL"> <name><![CDATA[Correctness - TestCase declares a bad suite method ]]></name> <configKey><![CDATA[IJU_BAD_SUITE_METHOD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Class is a JUnit TestCase and defines a suite() method. However, the suite method needs to be declared as either <pre>public static junit.framework.Test suite()</pre> @@ -3126,13 +3126,13 @@ or <rule key="IJU_NO_TESTS" priority="CRITICAL"> <name><![CDATA[Correctness - TestCase has no tests]]></name> <configKey><![CDATA[IJU_NO_TESTS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Class is a JUnit TestCase but has not implemented any test methods</p>]]></description> </rule> <rule key="BOA_BADLY_OVERRIDDEN_ADAPTER" priority="CRITICAL"> <name><![CDATA[Correctness - Class overrides a method implemented in super class Adapter wrongly]]></name> <configKey><![CDATA[BOA_BADLY_OVERRIDDEN_ADAPTER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method overrides a method found in a parent class, where that class is an Adapter that implements a listener defined in the java.awt.event or javax.swing.event package. As a result, this method will not get called when the event occurs.</p>]]></description> @@ -3140,28 +3140,28 @@ get called when the event occurs.</p>]]></description> <rule key="SQL_BAD_RESULTSET_ACCESS" priority="CRITICAL"> <name><![CDATA[Correctness - Method attempts to access a result set field with index 0]]></name> <configKey><![CDATA[SQL_BAD_RESULTSET_ACCESS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A call to getXXX or updateXXX methods of a result set was made where the field index is 0. As ResultSet fields start at index 1, this is always a mistake.</p>]]></description> </rule> <rule key="SQL_BAD_PREPARED_STATEMENT_ACCESS" priority="CRITICAL"> <name><![CDATA[Correctness - Method attempts to access a prepared statement parameter with index 0]]></name> <configKey><![CDATA[SQL_BAD_PREPARED_STATEMENT_ACCESS]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A call to a setXXX method of a prepared statement was made where the parameter index is 0. As parameter indexes start at index 1, this is always a mistake.</p>]]></description> </rule> <rule key="SIO_SUPERFLUOUS_INSTANCEOF" priority="CRITICAL"> <name><![CDATA[Correctness - Unnecessary type check done using instanceof operator]]></name> <configKey><![CDATA[SIO_SUPERFLUOUS_INSTANCEOF]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Type check performed using the instanceof operator where it can be statically determined whether the object is of the type requested. </p>]]></description> </rule> <rule key="EC_ARRAY_AND_NONARRAY" priority="CRITICAL"> <name><![CDATA[Correctness - equals() used to compare array and nonarray]]></name> <configKey><![CDATA[EC_ARRAY_AND_NONARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method invokes the .equals(Object o) to compare an array and a reference that doesn't seem to be an array. If things being compared are of different types, they are guaranteed to be unequal @@ -3174,7 +3174,7 @@ contents of the arrays, use java.util.Arrays.equals(Object[], Object[]). <rule key="EC_BAD_ARRAY_COMPARE" priority="CRITICAL"> <name><![CDATA[Correctness - Invocation of equals() on an array, which is equivalent to ==]]></name> <configKey><![CDATA[EC_BAD_ARRAY_COMPARE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method invokes the .equals(Object o) method on an array. Since arrays do not override the equals method of Object, calling equals on an array is the same as comparing their addresses. To compare the @@ -3184,7 +3184,7 @@ contents of the arrays, use java.util.Arrays.equals(Object[], Object[]). <rule key="STI_INTERRUPTED_ON_CURRENTTHREAD" priority="CRITICAL"> <name><![CDATA[Correctness - Unneeded use of currentThread() call, to call interrupted() ]]></name> <configKey><![CDATA[STI_INTERRUPTED_ON_CURRENTTHREAD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method invokes the Thread.currentThread() call, just to call the interrupted() method. As interrupted() is a static method, is more simple and clear to use Thread.interrupted(). @@ -3193,7 +3193,7 @@ static method, is more simple and clear to use Thread.interrupted(). <rule key="STI_INTERRUPTED_ON_UNKNOWNTHREAD" priority="CRITICAL"> <name><![CDATA[Correctness - Static Thread.interrupted() method invoked on thread instance]]></name> <configKey><![CDATA[STI_INTERRUPTED_ON_UNKNOWNTHREAD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method invokes the Thread.interrupted() method on a Thread object that appears to be a Thread object that is not the current thread. As the interrupted() method is static, the interrupted method will be called on a different @@ -3203,7 +3203,7 @@ object than the one the author intended. <rule key="IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN" priority="CRITICAL"> <name><![CDATA[Correctness - A parameter is dead upon entry to a method but overwritten]]></name> <configKey><![CDATA[IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The initial value of this parameter is ignored, and the parameter is overwritten here. This often indicates a mistaken belief that @@ -3214,7 +3214,7 @@ the caller. <rule key="DLS_DEAD_LOCAL_STORE" priority="CRITICAL"> <name><![CDATA[Dodgy - Dead store to local variable]]></name> <configKey><![CDATA[DLS_DEAD_LOCAL_STORE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This instruction assigns a value to a local variable, but the value is not read or used in any subsequent instruction. @@ -3230,7 +3230,7 @@ there is no easy way to eliminate these false positives. <rule key="DLS_DEAD_LOCAL_STORE_IN_RETURN" priority="CRITICAL"> <name><![CDATA[Correctness - Useless assignment in return statement]]></name> <configKey><![CDATA[DLS_DEAD_LOCAL_STORE_IN_RETURN]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This statement assigns to a local variable in a return statement. This assignment has effect. Please verify that this statement does the right thing. @@ -3239,7 +3239,7 @@ has effect. Please verify that this statement does the right thing. <rule key="DLS_DEAD_STORE_OF_CLASS_LITERAL" priority="CRITICAL"> <name><![CDATA[Correctness - Dead store of class literal]]></name> <configKey><![CDATA[DLS_DEAD_STORE_OF_CLASS_LITERAL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This instruction assigns a class literal to a variable and then never uses it. <a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">The behavior of this differs in Java 1.4 and in Java 5.</a> @@ -3254,7 +3254,7 @@ for more details and examples, and suggestions on how to force class initializat <rule key="DLS_DEAD_LOCAL_STORE_OF_NULL" priority="CRITICAL"> <name><![CDATA[Dodgy - Dead store of null to local variable]]></name> <configKey><![CDATA[DLS_DEAD_LOCAL_STORE_OF_NULL]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p>The code stores null into a local variable, and the stored value is not read. This store may have been introduced to assist the garbage collector, but as of Java SE 6.0, this is no longer needed or useful. @@ -3263,7 +3263,7 @@ as of Java SE 6.0, this is no longer needed or useful. <rule key="MF_METHOD_MASKS_FIELD" priority="MAJOR"> <name><![CDATA[Correctness - Method defines a variable that obscures a field]]></name> <configKey><![CDATA[MF_METHOD_MASKS_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method defines a local variable with the same name as a field in this class or a superclass. This may cause the method to read an uninitialized value from the field, leave the field uninitialized, @@ -3272,7 +3272,7 @@ or both.</p>]]></description> <rule key="MF_CLASS_MASKS_FIELD" priority="MAJOR"> <name><![CDATA[Correctness - Class defines field that masks a superclass field]]></name> <configKey><![CDATA[MF_CLASS_MASKS_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines a field with the same name as a visible instance field in a superclass. This is confusing, and may indicate an error if methods update or access one of @@ -3281,7 +3281,7 @@ the fields when they wanted the other.</p>]]></description> <rule key="WMI_WRONG_MAP_ITERATOR" priority="CRITICAL"> <name><![CDATA[Performance - Inefficient use of keySet iterator instead of entrySet iterator]]></name> <configKey><![CDATA[WMI_WRONG_MAP_ITERATOR]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This method accesses the value of a Map entry, using a key that was retrieved from a keySet iterator. It is more efficient to use an iterator on the entrySet of the map, to avoid the Map.get(key) lookup.</p>]]></description> @@ -3289,14 +3289,14 @@ Map.get(key) lookup.</p>]]></description> <rule key="ISC_INSTANTIATE_STATIC_CLASS" priority="MAJOR"> <name><![CDATA[Bad practice - Needless instantiation of class that only supplies static methods]]></name> <configKey><![CDATA[ISC_INSTANTIATE_STATIC_CLASS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This class allocates an object that is based on a class that only supplies static methods. This object does not need to be created, just access the static methods directly using the class name as a qualifier.</p>]]></description> </rule> <rule key="REC_CATCH_EXCEPTION" priority="MAJOR"> <name><![CDATA[Dodgy - Exception is caught when Exception is not thrown]]></name> <configKey><![CDATA[REC_CATCH_EXCEPTION]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method uses a try-catch block that catches Exception objects, but Exception is not thrown within the try block, and RuntimeException is not explicitly caught. It is a common bug pattern to @@ -3308,7 +3308,7 @@ does not need to be created, just access the static methods directly using the c <rule key="FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER" priority="CRITICAL"> <name><![CDATA[Correctness - Doomed test for equality to NaN]]></name> <configKey><![CDATA[FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code checks to see if a floating point value is equal to the special Not A Number value (e.g., <code>if (x == Double.NaN)</code>). However, @@ -3325,7 +3325,7 @@ does not need to be created, just access the static methods directly using the c <rule key="FE_FLOATING_POINT_EQUALITY" priority="CRITICAL"> <name><![CDATA[Dodgy - Test for floating point equality]]></name> <configKey><![CDATA[FE_FLOATING_POINT_EQUALITY]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This operation compares two floating point values for equality. Because floating point calculations may involve rounding, @@ -3341,7 +3341,7 @@ does not need to be created, just access the static methods directly using the c <rule key="UM_UNNECESSARY_MATH" priority="CRITICAL"> <name><![CDATA[Performance - Method calls static Math class method on a constant value]]></name> <configKey><![CDATA[UM_UNNECESSARY_MATH]]></configKey> - <category name="Efficiency"/> + <description><![CDATA[<p> This method uses a static method from java.lang.Math on a constant value. This method's result in this case, can be determined statically, and is faster and sometimes more accurate to just use the constant. Methods detected are: @@ -3424,7 +3424,7 @@ just use the constant. Methods detected are: <rule key="RI_REDUNDANT_INTERFACES" priority="MAJOR"> <name><![CDATA[Dodgy - Class implements same interface as superclass]]></name> <configKey><![CDATA[RI_REDUNDANT_INTERFACES]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class declares that it implements an interface that is also implemented by a superclass. This is redundant because once a superclass implements an interface, all subclasses by default also @@ -3436,7 +3436,7 @@ just use the constant. Methods detected are: <rule key="MTIA_SUSPECT_STRUTS_INSTANCE_FIELD" priority="CRITICAL"> <name><![CDATA[Dodgy - Class extends Struts Action class and uses instance variables]]></name> <configKey><![CDATA[MTIA_SUSPECT_STRUTS_INSTANCE_FIELD]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class extends from a Struts Action class, and uses an instance member variable. Since only one instance of a struts Action class is created by the Struts framework, and used in a @@ -3448,7 +3448,7 @@ just use the constant. Methods detected are: <rule key="MTIA_SUSPECT_SERVLET_INSTANCE_FIELD" priority="CRITICAL"> <name><![CDATA[Dodgy - Class extends Servlet class and uses instance variables]]></name> <configKey><![CDATA[MTIA_SUSPECT_SERVLET_INSTANCE_FIELD]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class extends from a Servlet class, and uses an instance member variable. Since only one instance of a Servlet class is created by the J2EE framework, and used in a @@ -3459,7 +3459,7 @@ just use the constant. Methods detected are: <rule key="PS_PUBLIC_SEMAPHORES" priority="CRITICAL"> <name><![CDATA[Dodgy - Class exposes synchronization and semaphores in its public interface]]></name> <configKey><![CDATA[PS_PUBLIC_SEMAPHORES]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class uses synchronization along with wait(), notify() or notifyAll() on itself (the this reference). Client classes that use this class, may, in addition, use an instance of this class @@ -3471,7 +3471,7 @@ just use the constant. Methods detected are: <rule key="ICAST_INTEGER_MULTIPLY_CAST_TO_LONG" priority="CRITICAL"> <name><![CDATA[Dodgy - Result of integer multiplication cast to long]]></name> <configKey><![CDATA[ICAST_INTEGER_MULTIPLY_CAST_TO_LONG]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code performs integer multiply and then converts the result to a long, as in: @@ -3497,7 +3497,7 @@ or <rule key="ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND" priority="CRITICAL"> <name><![CDATA[Correctness - int value cast to float and then passed to Math.round]]></name> <configKey><![CDATA[ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code converts an int value to a float precision floating point number and then @@ -3512,7 +3512,7 @@ floating point arithmetic. <rule key="ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL" priority="CRITICAL"> <name><![CDATA[Correctness - int value cast to double and then passed to Math.ceil]]></name> <configKey><![CDATA[ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code converts an int value to a double precision floating point number and then @@ -3527,7 +3527,7 @@ floating point arithmetic. <rule key="ICAST_IDIV_CAST_TO_DOUBLE" priority="CRITICAL"> <name><![CDATA[Dodgy - int division result cast to double or float]]></name> <configKey><![CDATA[ICAST_IDIV_CAST_TO_DOUBLE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code casts the result of an integer division operation to double or float. @@ -3552,7 +3552,7 @@ double value2 = x / (double) y; <rule key="J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION" priority="CRITICAL"> <name><![CDATA[Bad practice - Store of non serializable object into HttpSession]]></name> <configKey><![CDATA[J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This code seems to be storing a non-serializable object into an HttpSession. If this session is passivated or migrated, an error will result. @@ -3561,7 +3561,7 @@ If this session is passivated or migrated, an error will result. <rule key="DMI_NONSERIALIZABLE_OBJECT_WRITTEN" priority="CRITICAL"> <name><![CDATA[Dodgy - Non serializable object written to ObjectOutput]]></name> <configKey><![CDATA[DMI_NONSERIALIZABLE_OBJECT_WRITTEN]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code seems to be passing a non-serializable object to the ObjectOutput.writeObject method. If the object is, indeed, non-serializable, an error will result. @@ -3570,7 +3570,7 @@ If the object is, indeed, non-serializable, an error will result. <rule key="VA_FORMAT_STRING_NO_PREVIOUS_ARGUMENT" priority="CRITICAL"> <name><![CDATA[Correctness - No previous argument for format string]]></name> <configKey><![CDATA[VA_FORMAT_STRING_NO_PREVIOUS_ARGUMENT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The format string specifies a relative index to request that the argument for the previous format specifier be reused. However, there is no previous argument. @@ -3584,7 +3584,7 @@ For example, <rule key="VA_FORMAT_STRING_BAD_CONVERSION" priority="CRITICAL"> <name><![CDATA[Correctness - The type of a supplied argument doesn't match format specifier]]></name> <configKey><![CDATA[VA_FORMAT_STRING_BAD_CONVERSION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> One of the arguments is uncompatible with the corresponding format string specifier. As a result, this will generate a runtime exception when executed. @@ -3595,7 +3595,7 @@ the String "1" is incompatible with the format specifier %d. <rule key="VA_FORMAT_STRING_BAD_CONVERSION_TO_BOOLEAN" priority="MAJOR"> <name><![CDATA[Dodgy - Non-Boolean argument formatted using %b format specifier]]></name> <configKey><![CDATA[VA_FORMAT_STRING_BAD_CONVERSION_TO_BOOLEAN]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> An argument not of type Boolean is being formatted with a %b format specifier. This won't throw an exception; instead, it will print true for any nonnull value, and false for null. @@ -3605,7 +3605,7 @@ This feature of format strings is strange, and may not be what you intended. <rule key="VA_FORMAT_STRING_BAD_CONVERSION_FROM_ARRAY" priority="MAJOR"> <name><![CDATA[Correctness - Array formatted in useless way using format string]]></name> <configKey><![CDATA[VA_FORMAT_STRING_BAD_CONVERSION_FROM_ARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> One of the arguments being formatted with a format string is an array. This will be formatted using a fairly useless format, such as [I@304282, which doesn't actually show the contents @@ -3617,7 +3617,7 @@ Consider wrapping the array using <code>Arrays.asList(...)</code> before handlin <name> <![CDATA[Correctness - Number of format-string arguments does not correspond to number of placeholders]]></name> <configKey><![CDATA[VA_FORMAT_STRING_ARG_MISMATCH]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A format-string method with a variable number of arguments is called, but the number of arguments passed does not match with the number of @@ -3628,7 +3628,7 @@ author intended. <rule key="VA_FORMAT_STRING_EXTRA_ARGUMENTS_PASSED" priority="MAJOR"> <name><![CDATA[Correctness - More arguments are passed that are actually used in the format string]]></name> <configKey><![CDATA[VA_FORMAT_STRING_EXTRA_ARGUMENTS_PASSED]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A format-string method with a variable number of arguments is called, but more arguments are passed than are actually used by the format string. @@ -3639,7 +3639,7 @@ information that was intended to be included in the formatted string. <rule key="VA_FORMAT_STRING_ILLEGAL" priority="CRITICAL"> <name><![CDATA[Correctness - Illegal format string]]></name> <configKey><![CDATA[VA_FORMAT_STRING_ILLEGAL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The format string is syntactically invalid, and a runtime exception will occur when @@ -3649,7 +3649,7 @@ this statement is executed. <rule key="VA_FORMAT_STRING_MISSING_ARGUMENT" priority="CRITICAL"> <name><![CDATA[Correctness - Format string references missing argument]]></name> <configKey><![CDATA[VA_FORMAT_STRING_MISSING_ARGUMENT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> Not enough arguments are passed to satisfy a placeholder in the format string. A runtime exception will occur when @@ -3659,7 +3659,7 @@ this statement is executed. <rule key="VA_FORMAT_STRING_BAD_ARGUMENT" priority="CRITICAL"> <name><![CDATA[Correctness - Format string placeholder incompatible with passed argument]]></name> <configKey><![CDATA[VA_FORMAT_STRING_BAD_ARGUMENT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The format string placeholder is incompatible with the corresponding argument. For example, @@ -3676,7 +3676,7 @@ this statement is executed. <name> <![CDATA[Correctness - Primitive array passed to function expecting a variable number of object arguments]]></name> <configKey><![CDATA[VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code passes a primitive array to a function that takes a variable number of object arguments. This creates an array of length one to hold the primitive array and passes it to the function. @@ -3685,7 +3685,7 @@ This creates an array of length one to hold the primitive array and passes it to <rule key="BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS" priority="CRITICAL"> <name><![CDATA[Bad practice - Equals method should not assume anything about the type of its argument]]></name> <configKey><![CDATA[BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> The <code>equals(Object o)</code> method shouldn't make any assumptions about the type of <code>o</code>. It should simply return @@ -3695,7 +3695,7 @@ false if <code>o</code> is not the same type as <code>this</code>. <rule key="BC_BAD_CAST_TO_ABSTRACT_COLLECTION" priority="MAJOR"> <name><![CDATA[Dodgy - Questionable cast to abstract collection ]]></name> <configKey><![CDATA[BC_BAD_CAST_TO_ABSTRACT_COLLECTION]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code casts a Collection to an abstract collection (such as <code>List</code>, <code>Set</code>, or <code>Map</code>). @@ -3707,7 +3707,7 @@ to iterate through a collection, you don't need to cast it to a Set or List. <rule key="BC_IMPOSSIBLE_CAST" priority="BLOCKER"> <name><![CDATA[Correctness - Impossible cast]]></name> <configKey><![CDATA[BC_IMPOSSIBLE_CAST]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This cast will always throw a ClassCastException. </p>]]></description> @@ -3715,7 +3715,7 @@ This cast will always throw a ClassCastException. <rule key="NP_NULL_INSTANCEOF" priority="BLOCKER"> <name><![CDATA[Correctness - A known null value is checked to see if it is an instance of a type]]></name> <configKey><![CDATA[NP_NULL_INSTANCEOF]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This instanceof test will always return false, since the value being checked is guaranteed to be null. Although this is safe, make sure it isn't @@ -3725,7 +3725,7 @@ an indication of some misunderstanding or some other logic error. <rule key="BC_IMPOSSIBLE_INSTANCEOF" priority="CRITICAL"> <name><![CDATA[Correctness - instanceof will always return false]]></name> <configKey><![CDATA[BC_IMPOSSIBLE_INSTANCEOF]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This instanceof test will always return false. Although this is safe, make sure it isn't an indication of some misunderstanding or some other logic error. @@ -3734,7 +3734,7 @@ an indication of some misunderstanding or some other logic error. <rule key="BC_VACUOUS_INSTANCEOF" priority="CRITICAL"> <name><![CDATA[Dodgy - instanceof will always return true]]></name> <configKey><![CDATA[BC_VACUOUS_INSTANCEOF]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This instanceof test will always return true (unless the value being tested is null). Although this is safe, make sure it isn't @@ -3746,7 +3746,7 @@ better to do a null test rather than an instanceof test. <rule key="BC_UNCONFIRMED_CAST" priority="CRITICAL"> <name><![CDATA[Dodgy - Unchecked/unconfirmed cast]]></name> <configKey><![CDATA[BC_UNCONFIRMED_CAST]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This cast is unchecked, and not all instances of the type casted from can be cast to the type it is being cast to. Ensure that your program logic ensures that this @@ -3756,7 +3756,7 @@ cast will not fail. <rule key="BC_BAD_CAST_TO_CONCRETE_COLLECTION" priority="CRITICAL"> <name><![CDATA[Dodgy - Questionable cast to concrete collection]]></name> <configKey><![CDATA[BC_BAD_CAST_TO_CONCRETE_COLLECTION]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code casts an abstract collection (such as a Collection, List, or Set) to a specific concrete implementation (such as an ArrayList or HashSet). @@ -3769,7 +3769,7 @@ collection class. <rule key="RE_POSSIBLE_UNINTENDED_PATTERN" priority="CRITICAL"> <name><![CDATA[Correctness - "." used for regular expression]]></name> <configKey><![CDATA[RE_POSSIBLE_UNINTENDED_PATTERN]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A String function is being invoked and "." is being passed to a parameter that takes a regular expression as an argument. Is this what you intended? @@ -3781,7 +3781,7 @@ character has been replaced by a / character. <rule key="RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION" priority="CRITICAL"> <name><![CDATA[Correctness - Invalid syntax for regular expression]]></name> <configKey><![CDATA[RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code here uses a regular expression that is invalid according to the syntax for regular expressions. This statement will throw a PatternSyntaxException when @@ -3791,7 +3791,7 @@ executed. <rule key="RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION" priority="CRITICAL"> <name><![CDATA[Correctness - File.separator used for regular expression]]></name> <configKey><![CDATA[RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code here uses <code>File.separator</code> where a regular expression is required. This will fail on Windows @@ -3805,7 +3805,7 @@ regular expression as an escape character. Amoung other options, you can just us <rule key="DLS_OVERWRITTEN_INCREMENT" priority="CRITICAL"> <name><![CDATA[Correctness - Overwritten increment]]></name> <configKey><![CDATA[DLS_OVERWRITTEN_INCREMENT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code performs an increment operation (e.g., <code>i++</code>) and then immediately overwrites it. For example, <code>i = i++</code> immediately @@ -3815,7 +3815,7 @@ overwrites the incremented value with the original value. <rule key="ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT" priority="CRITICAL"> <name><![CDATA[Dodgy - Unsigned right shift cast to short/byte]]></name> <configKey><![CDATA[ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The code performs an unsigned right shift, whose result is then cast to a short or byte, which discards the upper bits of the result. @@ -3826,7 +3826,7 @@ a signed and unsigned right shift (depending upon the size of the shift). <rule key="ICAST_BAD_SHIFT_AMOUNT" priority="CRITICAL"> <name><![CDATA[Correctness - Integer shift by an amount not in the range 0..31]]></name> <configKey><![CDATA[ICAST_BAD_SHIFT_AMOUNT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code performs an integer shift by a constant amount outside the range 0..31. @@ -3838,7 +3838,7 @@ and it at least confusing. <rule key="IM_MULTIPLYING_RESULT_OF_IREM" priority="CRITICAL"> <name><![CDATA[Correctness - Integer multiply of result of integer remainder]]></name> <configKey><![CDATA[IM_MULTIPLYING_RESULT_OF_IREM]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code multiplies the result of an integer remaining by an integer constant. Be sure you don't have your operator precedence confused. For example @@ -3848,7 +3848,7 @@ i % 60 * 1000 is (i % 60) * 1000, not i % (60 * 1000). <rule key="DMI_INVOKING_HASHCODE_ON_ARRAY" priority="CRITICAL"> <name><![CDATA[Correctness - Invocation of hashCode on an array]]></name> <configKey><![CDATA[DMI_INVOKING_HASHCODE_ON_ARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code invokes hashCode on an array. Calling hashCode on an array returns the same value as System.identityHashCode, and ingores @@ -3861,7 +3861,7 @@ use <code>java.util.Arrays.hashCode(a)</code>. <rule key="DMI_INVOKING_TOSTRING_ON_ARRAY" priority="CRITICAL"> <name><![CDATA[Correctness - Invocation of toString on an array]]></name> <configKey><![CDATA[DMI_INVOKING_TOSTRING_ON_ARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code invokes toString on an array, which will generate a fairly useless result such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable @@ -3871,7 +3871,7 @@ String that gives the contents of the array. See Programming Puzzlers, chapter 3 <rule key="DMI_INVOKING_TOSTRING_ON_ANONYMOUS_ARRAY" priority="CRITICAL"> <name><![CDATA[Correctness - Invocation of toString on an array]]></name> <configKey><![CDATA[DMI_INVOKING_TOSTRING_ON_ANONYMOUS_ARRAY]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The code invokes toString on an (anonymous) array. Calling toString on an array generates a fairly useless result such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable @@ -3881,7 +3881,7 @@ String that gives the contents of the array. See Programming Puzzlers, chapter 3 <rule key="IM_AVERAGE_COMPUTATION_COULD_OVERFLOW" priority="CRITICAL"> <name><![CDATA[Dodgy - Computation of average could overflow]]></name> <configKey><![CDATA[IM_AVERAGE_COMPUTATION_COULD_OVERFLOW]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p>The code computes the average of two integers using either division or signed right shift, and then uses the result as the index of an array. If the values being averaged are very large, this can overflow (resulting in the computation @@ -3899,7 +3899,7 @@ publicized the bug pattern</a>. <rule key="IM_BAD_CHECK_FOR_ODD" priority="CRITICAL"> <name><![CDATA[Dodgy - Check for oddness that won't work for negative numbers ]]></name> <configKey><![CDATA[IM_BAD_CHECK_FOR_ODD]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check @@ -3909,7 +3909,7 @@ for oddness, consider using x & 1 == 1, or x % 2 != 0. <rule key="DMI_HARDCODED_ABSOLUTE_FILENAME" priority="CRITICAL"> <name><![CDATA[Dodgy - Code contains a hard coded reference to an absolute pathname]]></name> <configKey><![CDATA[DMI_HARDCODED_ABSOLUTE_FILENAME]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p>This code constructs a File object using a hard coded to an absolute pathname (e.g., <code>new File("/home/dannyc/workspace/j2ee/src/share/com/sun/enterprise/deployment");</code> </p>]]></description> @@ -3917,7 +3917,7 @@ for oddness, consider using x & 1 == 1, or x % 2 != 0. <rule key="DMI_BAD_MONTH" priority="CRITICAL"> <name><![CDATA[Correctness - Bad constant value for month]]></name> <configKey><![CDATA[DMI_BAD_MONTH]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code passes a constant month value outside the expected range of 0..11 to a method. @@ -3926,7 +3926,7 @@ value outside the expected range of 0..11 to a method. <rule key="DMI_USELESS_SUBSTRING" priority="CRITICAL"> <name><![CDATA[Dodgy - Invocation of substring(0), which returns the original value]]></name> <configKey><![CDATA[DMI_USELESS_SUBSTRING]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This code invokes substring(0) on a String, which returns the original value. </p>]]></description> @@ -3934,7 +3934,7 @@ This code invokes substring(0) on a String, which returns the original value. <rule key="DMI_CALLING_NEXT_FROM_HASNEXT" priority="CRITICAL"> <name><![CDATA[Correctness - hasNext method invokes next]]></name> <configKey><![CDATA[DMI_CALLING_NEXT_FROM_HASNEXT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> The hasNext() method invokes the next() method. This is almost certainly wrong, since the hasNext() method is not supposed to change the state of the iterator, @@ -3944,7 +3944,7 @@ and the next method is supposed to change the state of the iterator. <rule key="SWL_SLEEP_WITH_LOCK_HELD" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Method calls Thread.sleep() with a lock held]]></name> <configKey><![CDATA[SWL_SLEEP_WITH_LOCK_HELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method calls Thread.sleep() with a lock held. This may result in very poor performance and scalability, or a deadlock, since other threads may @@ -3956,7 +3956,7 @@ and the next method is supposed to change the state of the iterator. <rule key="DB_DUPLICATE_BRANCHES" priority="CRITICAL"> <name><![CDATA[Dodgy - Method uses the same code for two branches]]></name> <configKey><![CDATA[DB_DUPLICATE_BRANCHES]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method uses the same code to implement two branches of a conditional branch. Check to ensure that this isn't a coding mistake. @@ -3965,7 +3965,7 @@ and the next method is supposed to change the state of the iterator. <rule key="DB_DUPLICATE_SWITCH_CLAUSES" priority="CRITICAL"> <name><![CDATA[Dodgy - Method uses the same code for two switch clauses]]></name> <configKey><![CDATA[DB_DUPLICATE_SWITCH_CLAUSES]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method uses the same code to implement two clauses of a switch statement. This could be a case of duplicate code, but it might also indicate @@ -3975,7 +3975,7 @@ and the next method is supposed to change the state of the iterator. <rule key="XFB_XML_FACTORY_BYPASS" priority="CRITICAL"> <name><![CDATA[Dodgy - Method directly allocates a specific implementation of xml interfaces]]></name> <configKey><![CDATA[XFB_XML_FACTORY_BYPASS]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This method allocates a specific implementation of an xml interface. It is preferable to use the supplied factory classes to create these objects so that the implementation can be @@ -3992,7 +3992,7 @@ and the next method is supposed to change the state of the iterator. <rule key="CI_CONFUSED_INHERITANCE" priority="MINOR"> <name><![CDATA[Dodgy - Class is final but declares protected field]]></name> <configKey><![CDATA[CI_CONFUSED_INHERITANCE]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> This class is declared to be final, but declares fields to be protected. Since the class is final, it can not be derived from, and the use of protected is confusing. The access @@ -4003,7 +4003,7 @@ and the next method is supposed to change the state of the iterator. <rule key="QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT" priority="CRITICAL"> <name><![CDATA[Correctness - Method assigns boolean literal in boolean expression]]></name> <configKey><![CDATA[QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method assigns a literal boolean value (true or false) to a boolean variable inside an if or while expression. Most probably this was supposed to be a boolean comparison using @@ -4013,7 +4013,7 @@ and the next method is supposed to change the state of the iterator. <rule key="GC_UNCHECKED_TYPE_IN_GENERIC_CALL" priority="CRITICAL"> <name><![CDATA[Bad practice - Unchecked type in generic call]]></name> <configKey><![CDATA[GC_UNCHECKED_TYPE_IN_GENERIC_CALL]]></configKey> - <category name="Maintainability"/> + <description><![CDATA[<p> This call to a generic collection method passes an argument while compile type Object where a specific type from the generic type parameters is expected. @@ -4025,7 +4025,7 @@ and the next method is supposed to change the state of the iterator. <rule key="GC_UNRELATED_TYPES" priority="CRITICAL"> <name><![CDATA[Correctness - No relationship between generic parameter and method argument]]></name> <configKey><![CDATA[GC_UNRELATED_TYPES]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This call to a generic collection method contains an argument with an incompatible class from that of the collection's parameter (i.e., the type of the argument is neither a supertype nor a subtype @@ -4053,7 +4053,7 @@ and the next method is supposed to change the state of the iterator. <rule key="DMI_COLLECTIONS_SHOULD_NOT_CONTAIN_THEMSELVES" priority="CRITICAL"> <name><![CDATA[Correctness - Collections should not contain themselves]]></name> <configKey><![CDATA[DMI_COLLECTIONS_SHOULD_NOT_CONTAIN_THEMSELVES]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This call to a generic collection's method would only make sense if a collection contained itself (e.g., if <code>s.contains(s)</code> were true). This is unlikely to be true and would cause problems if it were true (such as the computation of the hash code resulting in infinite recursion). @@ -4063,7 +4063,7 @@ It is likely that the wrong value is being passed as a parameter. <rule key="DMI_VACUOUS_SELF_COLLECTION_CALL" priority="CRITICAL"> <name><![CDATA[Correctness - Vacuous call to collections]]></name> <configKey><![CDATA[DMI_VACUOUS_SELF_COLLECTION_CALL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This call doesn't make sense. For any collection <code>c</code>, calling <code>c.containsAll(c)</code> should always be true, and <code>c.retainAll(c)</code> should have no effect. </p>]]></description> @@ -4071,7 +4071,7 @@ always be true, and <code>c.retainAll(c)</code> should have no effect. <rule key="DMI_USING_REMOVEALL_TO_CLEAR_COLLECTION" priority="CRITICAL"> <name><![CDATA[Correctness - Don't use removeAll to clear a collection]]></name> <configKey><![CDATA[DMI_USING_REMOVEALL_TO_CLEAR_COLLECTION]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> If you want to remove all elements from a collection <code>c</code>, use <code>c.clear</code>, not <code>c.removeAll(c)</code>. </p>]]></description> @@ -4079,7 +4079,7 @@ not <code>c.removeAll(c)</code>. <rule key="STCAL_STATIC_CALENDAR_INSTANCE" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Static Calendar]]></name> <configKey><![CDATA[STCAL_STATIC_CALENDAR_INSTANCE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see @@ -4092,7 +4092,7 @@ and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug <rule key="STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Call to static Calendar]]></name> <configKey><![CDATA[STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use. The detector has found a call to an instance of Calendar that has been obtained via a static field. This looks suspicous.</p> @@ -4102,7 +4102,7 @@ and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug <rule key="STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Static DateFormat]]></name> <configKey><![CDATA[STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use. Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the application.</p> @@ -4114,7 +4114,7 @@ and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug <rule key="STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Call to static DateFormat]]></name> <configKey><![CDATA[STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use. The detector has found a call to an instance of DateFormat that has been obtained via a static field. This looks suspicous.</p> @@ -4125,7 +4125,7 @@ and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug <name> <![CDATA[Correctness - Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required]]></name> <configKey><![CDATA[TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value specified as carrying a type qualifier annotation is consumed in a location or locations requiring that the value not @@ -4156,7 +4156,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Correctness - Value annotated as never carrying a type qualifier used where value carrying that qualifier is required]]></name> <configKey><![CDATA[TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value specified as not carrying a type qualifier annotation is guaranteed to be consumed in a location or locations requiring that the value does @@ -4176,7 +4176,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Correctness - Value that might not carry a type qualifier is always used in a way requires that type qualifier]]></name> <configKey><![CDATA[TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value that is annotated as possibility not being an instance of the values denoted by the type qualifier, and the value is guaranteed to be used @@ -4187,7 +4187,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Correctness - Value that might carry a type qualifier is always used in a way prohibits it from having that type qualifier]]></name> <configKey><![CDATA[TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value that is annotated as possibility being an instance of the values denoted by the type qualifier, and the value is guaranteed to be used @@ -4197,7 +4197,7 @@ public @NonNegative Integer example(@Negative Integer value) { <rule key="TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_NEVER_SINK" priority="CRITICAL"> <name><![CDATA[Correctness - Explicit annotation inconsistent with use]]></name> <configKey><![CDATA[TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_NEVER_SINK]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value is used in a way that requires it to be never be a value denoted by a type qualifier, but there is an explicit annotation stating that it is not known where the value is prohibited from having that type qualifier. @@ -4207,7 +4207,7 @@ public @NonNegative Integer example(@Negative Integer value) { <rule key="TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_ALWAYS_SINK" priority="CRITICAL"> <name><![CDATA[Correctness - Explicit annotation inconsistent with use]]></name> <configKey><![CDATA[TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_ALWAYS_SINK]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value is used in a way that requires it to be always be a value denoted by a type qualifier, but there is an explicit annotation stating that it is not known where the value is required to have that type qualifier. @@ -4217,7 +4217,7 @@ public @NonNegative Integer example(@Negative Integer value) { <rule key="IO_APPENDING_TO_OBJECT_OUTPUT_STREAM" priority="CRITICAL"> <name><![CDATA[Correctness - Doomed attempt to append to an object output stream]]></name> <configKey><![CDATA[IO_APPENDING_TO_OBJECT_OUTPUT_STREAM]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This code opens a file in append mode and then wraps the result in an object output stream. This won't allow you to append to an existing object output stream stored in a file. If you want to be @@ -4235,7 +4235,7 @@ public @NonNegative Integer example(@Negative Integer value) { <rule key="WL_USING_GETCLASS_RATHER_THAN_CLASS_LITERAL" priority="CRITICAL"> <name><![CDATA[Multithreaded correctness - Sychronization on getClass rather than class literal]]></name> <configKey><![CDATA[WL_USING_GETCLASS_RATHER_THAN_CLASS_LITERAL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This instance method synchronizes on <code>this.getClass()</code>. If this class is subclassed, subclasses will synchronize on the class object for the subclass, which isn't likely what was intended. @@ -4266,7 +4266,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Switch statement found where one case falls through to the next case]]></name> <configKey><![CDATA[SF_SWITCH_FALLTHROUGH]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a switch statement where one case branch will fall through to the next case. Usually you need to end this case with a break or return. @@ -4276,7 +4276,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Switch statement found where default case is missing]]></name> <configKey><![CDATA[SF_SWITCH_NO_DEFAULT]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This method contains a switch statement where default case is missing. Usually you need to provide a default case. @@ -4286,7 +4286,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Dead store due to switch statement fall through]]></name> <configKey><![CDATA[SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value stored in the previous switch case is overwritten here due to a switch fall through. It is likely that you forgot to put a @@ -4297,7 +4297,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Dead store due to switch statement fall through to throw]]></name> <configKey><![CDATA[SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH_TO_THROW]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> A value stored in the previous switch case is ignored here due to a switch fall through to a place where an exception is thrown. It is likely that you forgot to put a break or return at the end of the previous case. @@ -4307,7 +4307,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Class names should start with an upper case letter]]></name> <configKey><![CDATA[NM_CLASS_NAMING_CONVENTION]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations @@ -4318,7 +4318,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Field names should start with a lower case letter]]></name> <configKey><![CDATA[NM_FIELD_NAMING_CONVENTION]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> Names of fields that are not final should be in mixed case with a lowercase first letter and the first letters of subsequent words capitalized. @@ -4328,7 +4328,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Method names should start with a lower case letter]]></name> <configKey><![CDATA[NM_METHOD_NAMING_CONVENTION]]></configKey> - <category name="Usability"/> + <description><![CDATA[<p> Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized. @@ -4338,7 +4338,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Non-transient non-serializable instance field in serializable class]]></name> <configKey><![CDATA[SE_BAD_FIELD]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This Serializable class defines a non-primitive instance field which is neither transient, Serializable, or <code>java.lang.Object</code>, and does not appear to implement the <code>Externalizable</code> @@ -4350,7 +4350,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Class defines equal(Object); should it be equals(Object)?]]></name> <configKey><![CDATA[NM_BAD_EQUAL]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines a method <code>equal(Object)</code>. This method does not override the <code>equals(Object)</code> method @@ -4361,7 +4361,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Class defines hashcode(); should it be hashCode()?]]></name> <configKey><![CDATA[NM_LCASE_HASHCODE]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines a method called <code>hashcode()</code>. This method does not override the <code>hashCode()</code> @@ -4372,7 +4372,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Class defines tostring(); should it be toString()?]]></name> <configKey><![CDATA[NM_LCASE_TOSTRING]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines a method called <code>tostring()</code>. This method does not override the <code>toString()</code> @@ -4383,7 +4383,7 @@ public @NonNegative Integer example(@Negative Integer value) { <name> <![CDATA[Class defines tostring(); should it be toString()?]]></name> <configKey><![CDATA[NM_LCASE_TOSTRING]]></configKey> - <category name="Reliability"/> + <description><![CDATA[<p> This class defines a method called <code>tostring()</code>. This method does not override the <code>toString()</code> |