- ABSTRACT_CLASS_WITH_ABSTRACT_METHOD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The abstract class does not contain any abstract methods.
- ABSTRACT_CLASS_WITHOUT_ANY_METHOD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
If an abstract class does not provides any methods, it may be acting as a simple data container that is not meant
to be instantiated.
- ABSTRACT_NAMING - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Abstract classes should be named 'AbstractXXX'.
- ACCESSOR_CLASS_GENERATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Instantiation by way of private constructors from outside of the constructor's class often causes the generation
of an accessor.
- ADD_EMPTY_STRING - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The conversion of literals to strings by concatenating them with empty strings is inefficient.
- ALL - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses all warnings
- APPEND_CHARACTER_WITH_CHAR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid concatenating characters as strings in StringBuffer/StringBuilder.append methods.
- ARRAY_IS_STORED_DIRECTLY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Constructors and methods receiving arrays should clone objects and store the copy.
- ASSIGNMENT_IN_OPERAND - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid assignments in operands; this can make code more complicated and harder to read.
- ASSIGNMENT_TO_NON_FINAL_STATIC - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Identifies a possible unsafe usage of a static field.
- AT_LEAST_ONE_CONSTRUCTOR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Each class should declare at least one constructor.
- AVOID_ACCESSIBILITY_ALTERATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Methods such as getDeclaredConstructors(), getDeclaredConstructor(Class[]) and setAccessible(), as the interface
PrivilegedAction, allows for the runtime alteration of variable, class, or method visibility, even if they are
private.
- AVOID_ARRAY_LOOPS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Instead of manually copying data between two arrays, use the efficient System.arraycopy method instead.
- AVOID_ASSERT_AS_IDENTIFIER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Use of the term 'assert' will conflict with newer versions of Java since it is a reserved word.
- AVOID_BRANCHING_STATEMENT_AS_LAST_IN_LOOP - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Using a branching statement as the last part of a loop may be a bug, and/or is confusing.
- AVOID_CALLING_FINALIZE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The method Object.finalize() is called by the garbage collector on an object when garbage collection determines
that there are no more references to the object.
- AVOID_CATCHING_GENERIC_EXCEPTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid catching generic exceptions such as NullPointerException, RuntimeException, Exception in try-catch block.
- AVOID_CATCHING_NPE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Code should never throw NullPointerExceptions under normal circumstances.
- AVOID_CATCHING_THROWABLE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Catching Throwable errors is not recommended since its scope is very broad.
- AVOID_CONSTANTS_INTERFACE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
An interface should be used only to characterize the external behaviour of an implementing class: using an
interface as a container of constants is a poor usage pattern and not recommended.
- AVOID_DECIMAL_LITERALS_IN_BIG_DECIMAL_CONSTRUCTOR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
One might assume that the result of "new BigDecimal(0.1)" is exactly equal to 0.1, but it is actually equal to
.1000000000000000055511151231257827021181583404541015625.
- AVOID_DEEPLY_NESTED_IF_STATEMENTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid creating deeply nested if-then statements since they are harder to read and error-prone to maintain.
- AVOID_DOLLAR_SIGNS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid using dollar signs in variable/method/class/interface names.
- AVOID_DUPLICATE_LITERALS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Code containing duplicate String literals can usually be improved by declaring the String as a constant field.
- AVOID_ENUM_AS_IDENTIFIER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Use of the term 'enum' will conflict with newer versions of Java since it is a reserved word.
- AVOID_FIELD_NAME_MATCHING_METHOD_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
It can be confusing to have a field name with the same name as a method.
- AVOID_FIELD_NAME_MATCHING_TYPE_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
It is somewhat confusing to have a field name matching the declaring class name.
- AVOID_FINAL_LOCAL_VARIABLE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid using final local variables, turn them into fields.
- AVOID_INSTANCEOF_CHECKS_IN_CATCH_CLAUSE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Each caught exception type should be handled in its own catch clause.
- AVOID_INSTANTIATING_OBJECTS_IN_LOOPS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
New objects created within loops should be checked to see if they can created outside them and reused.
- AVOID_LITERALS_IN_IF_CONDITION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid using hard-coded literals in conditional statements.
- AVOID_LOSING_EXCEPTION_INFORMATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Statements in a catch block that invoke accessors on the exception without using the information only add to code
size.
- AVOID_MULTIPLE_UNARY_OPERATORS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The use of multiple unary operators may be problematic, and/or confusing.
- AVOID_PREFIXING_METHOD_PARAMETERS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Prefixing parameters by 'in' or 'out' pollutes the name of the parameters and reduces code readability.
- AVOID_PRINT_STACK_TRACE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid printStackTrace(); use a logger call instead.
- AVOID_PROTECTED_FIELD_IN_FINAL_CLASS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Do not use protected fields in final classes since they cannot be subclassed.
- AVOID_REASSIGNING_PARAMETERS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Reassigning values to incoming parameters is not recommended.
- AVOID_RETHROWING_EXCEPTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Catch blocks that merely rethrow a caught exception only add to code size and runtime complexity.
- AVOID_STRING_BUFFER_FIELD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
StringBuffers/StringBuilders can grow considerably, and so may become a source of memory leaks if held within
objects with long lifetimes.
- AVOID_SYNCHRONIZED_AT_METHOD_LEVEL - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Method-level synchronization can cause problems when new code is added to the method.
- AVOID_THREAD_GROUP - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid using java.lang.ThreadGroup; although it is intended to be used in a threaded environment it contains
methods that are not thread-safe.
- AVOID_THROWING_NEW_INSTANCE_OF_SAME_EXCEPTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Catch blocks that merely rethrow a caught exception wrapped inside a new instance of the same type only add to
code size and runtime complexity.
- AVOID_THROWING_NULL_POINTER_EXCEPTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid throwing NullPointerExceptions.
- AVOID_THROWING_RAW_EXCEPTION_TYPES - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid throwing certain exception types.
- AVOID_USING_HARD_CODED_IP - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Application with hard-coded IP addresses can become impossible to deploy in some cases.
- AVOID_USING_NATIVE_CODE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Unnecessary reliance on Java Native Interface (JNI) calls directly reduces application portability and increases
the maintenance burden.
- AVOID_USING_OCTAL_VALUES - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Integer literals should not start with zero since this denotes that the rest of literal will be interpreted as an
octal value.
- AVOID_USING_SHORT_TYPE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Java uses the 'short' type to reduce memory usage, not to optimize calculation.
- AVOID_USING_VOLATILE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Use of the keyword 'volatile' is generally used to fine tune a Java application, and therefore, requires a good
expertise of the Java Memory Model.
- CALL_SUPER_IN_CONSTRUCTOR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
It is a good practice to call super() in a constructor.
- CAST - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to cast operations
- CHECK_RESULT_SET - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Always check the return values of navigation methods (next, previous, first, last) of a ResultSet.
- CHECK_SKIP_RESULT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The skip() method may skip a smaller number of bytes than requested.
- CLASS_CAST_EXCEPTION_WITH_TO_ARRAY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
When deriving an array of a specific class from your Collection, one should provide an array of the same class as
the parameter of the toArray() method.
- CLASS_NAMING_CONVENTIONS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Class names should always begin with an upper case character.
- CLASS_WITH_ONLY_PRIVATE_CONSTRUCTOR_SHOULD_BE_FINAL - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A class with only private constructors should be final, unless the private constructor is invoked by a inner
class.
- CLONE_METHOD_MUST_IMPLEMENT_CLONEABLE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The method clone() should only be implemented if the class implements the Cloneable interface with the exception
of a final method that only throws CloneNotSupportedException.
- CLONE_THROWS_CLONE_NOT_SUPPORTED_EXCEPTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The method clone() should throw a CloneNotSupportedException.
- CLOSE_RESOURCE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Ensure that resources (like Connection, Statement, and ResultSet objects) are always closed after use.
- COLLAPSIBLE_IF_STATEMENTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Sometimes two consecutive 'if' statements can be consolidated by separating their conditions with a boolean
short-circuit operator.
- com.github.sebhoss.common.annotation - package com.github.sebhoss.common.annotation
-
Common code for annotations.
- COMMENT_CONTENT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A rule for the politically correct...
- COMMENT_REQUIRED - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Denotes whether comments are required (or unwanted) for specific language elements.
- COMMENT_SIZE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Determines whether the dimensions of non-header comments found are within the specified limits.
- COMPARE_OBJECTS_WITH_EQUALS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Use equals() to compare object references; avoid comparing them with ==.
- CompilerWarnings - Class in com.github.sebhoss.common.annotation
-
List of Eclipse compiler warnings which can be suppressed by the
SuppressWarnings annotation.
- CONFUSING_TERNARY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid negation within an "if" expression with an "else" clause.
- CONSECUTIVE_LITERAL_APPENDS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Consecutively calling StringBuffer/StringBuilder.append with String literals
- CONSTRUCTOR_CALLS_OVERRIDABLE_METHOD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Calling overridable methods during construction poses a risk of invoking methods on an incompletely constructed
object and can be difficult to debug.
- COUPLING_BETWEEN_OBJECTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule counts the number of unique attributes, local variables, and return types within an object.
- CYCLOMATIC_COMPLEXITY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Complexity directly affects maintenance costs is determined by the number of decision points in a method plus one
for the method entry.
- DATAFLOW_ANOMALY_ANALYSIS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The dataflow analysis tracks local definitions, undefinitions and references to variables on different paths on
the data flow.
- DEFAULT_LABEL_NOT_LAST_IN_SWITCH_STATEMENT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
By convention, the default label should be the last label in a switch statement.
- DEFAULT_PACKAGE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Use explicit scoping instead of the default package private level.
- DEP_ANN - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to deprecated annotation
- DEPRECATION - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to deprecation
- DO_NOT_CALL_GARBAGE_COLLECTION_EXPLICITLY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised.
- DO_NOT_CALL_SYSTEM_EXIT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Web applications should not call System.exit(), since only the web container or the application server should
stop the JVM.
- DO_NOT_EXTEND_JAVA_LANG_ERROR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Errors are system exceptions.
- DO_NOT_THROW_EXCEPTION_IN_FINALLY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Throwing exceptions within a 'finally' block is confusing since they may mask other exceptions or code defects.
- DO_NOT_USE_THREADS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The J2EE specification explicitly forbids the use of threads.
- DONT_CALL_THREAD_RUN - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Explicitly calling Thread.run() method will execute in the caller's thread of control.
- DONT_IMPORT_JAVA_LANG - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid importing anything from the package 'java.lang'.
- DONT_IMPORT_SUN - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid importing anything from the 'sun.*' packages.
- DONT_USE_FLOAT_TYPE_FOR_LOOP_INDICES - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Don't use floating point for loop indices.
- DOUBLE_CHECKED_LOCKING - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Partially created objects can be returned by the Double Checked Locking pattern when used in Java.
- DUPLICATE_IMPORTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Duplicate or overlapping import statements should be avoided.
- EMPTY_CATCH_BLOCK - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty Catch Block finds instances where an exception is caught, but nothing is done.
- EMPTY_FINALLY_BLOCK - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty finally blocks serve no purpose and should be removed.
- EMPTY_FINANLIZER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty finalize methods serve no purpose and should be removed.
- EMPTY_IF_STATEMENT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty If Statement finds instances where a condition is checked but nothing is done about it.
- EMPTY_INITIALIZER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty initializers serve no purpose and should be removed.
- EMPTY_METHOD_IN_ABSTRACT_CLASS_SHOULD_BE_ABSTRACT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty methods in an abstract class should be tagged as abstract.
- EMPTY_STATEMENT_BLOCK - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty block statements serve no purpose and should be removed.
- EMPTY_STATEMENT_NOT_IN_LOOP - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
An empty statement (or a semicolon by itself) that is not used as the sole body of a 'for' or 'while' loop is
probably a bug.
- EMPTY_STATIC_INITIALIZER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
An empty static initializer serve no purpose and should be removed.
- EMPTY_SWITCH_STATEMENTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty switch statements serve no purpose and should be removed.
- EMPTY_SYNCHRONIZED_BLOCK - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty synchronized blocks serve no purpose and should be removed.
- EMPTY_TRY_BLOCK - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid empty try blocks - what's the point?
- EMPTY_WHILE_STATEMENT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Empty While Statement finds all instances where a while statement does nothing.
- EQUALS_NULL - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Tests for null should not use the equals() method.
- EXCEPTION_AS_FLOW_CONTROL - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Using Exceptions as form of flow control is not recommended as they obscure true exceptions when debugging.
- EXCESSIVE_CLASS_LENGTH - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Excessive class file lengths are usually indications that the class may be burdened with excessive
responsibilities that could be provided by external classes or functions.
- EXCESSIVE_IMPORTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A high number of imports can indicate a high degree of coupling within an object.
- EXCESSIVE_METHOD_LENGTH - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
When methods are excessively long this usually indicates that the method is doing more than its name/signature
might suggest.
- EXCESSIVE_PARAMETER_LIST - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Methods with numerous parameters are a challenge to maintain, especially if most of them share the same datatype.
- EXCESSIVE_PUBLIC_COUNT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Classes with large numbers of public methods and attributes require disproportionate testing efforts since
combinational side effects grow rapidly and increase risk.
- EXTENDS_OBJECT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
No need to explicitly extend Object.
- JAVADOC - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to javadoc warnings
- JUMBLED_INCREMENTER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid jumbled loop incrementers - its usually a mistake, and is confusing even if intentional.
- JUNIT_4_SUITES_SHOULD_USE_SUITE_ANNOTATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
In JUnit 3, test suites are indicated by the suite() method.
- JUNIT_4_TEST_SHOULD_USE_AFTER_ANNOTATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
In JUnit 3, the tearDown method was used to clean up all data entities required in running tests.
- JUNIT_4_TEST_SHOULD_USE_BEFORE_ANNOTATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
In JUnit 3, the setUp method was used to set up all data entities required in running tests.
- JUNIT_4_TEST_SHOULD_USE_TEST_ANNOTATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
In JUnit 3, the framework executed all methods which started with the word test as a unit test.
- JUNIT_ASSERTIONS_SHOULD_INCLUDE_MESSAGE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
JUnit assertions should include an informative message - i.e., use the three-argument version of assertEquals(),
not the two-argument version.
- JUNIT_SPELLING - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Some JUnit framework methods are easy to misspell.
- JUNIT_STATIC_SUITE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The suite() method in a JUnit test needs to be both public and static.
- JUNIT_TEST_CONTAINS_TOO_MANY_ASSERTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
JUnit tests should not contain too many asserts.
- JUNIT_TESTS_SHOULD_INCLUDE_ASSERT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
JUnit tests should include at least one assertion.
- JUNIT_USE_EXPECTED - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
In JUnit4, use the @Test(expected) annotation to denote tests that should throw exceptions.
- NCSS_CONSTRUCTOR_COUNT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines of code for
a given constructor.
- NCSS_METHOD_COUNT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines of code for
a given method.
- NCSS_TYPE_COUNT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines of code for
a given type.
- NLS - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to non-localized string literals
- NO_PACKAGE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Detects when a class or interface does not have a package definition.
- NON_CASE_LABEL_IN_SWITCH_STATEMENT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A non-case label (e.g.
- NON_STATIC_INITIALIZER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A non-static initializer block will be called any time a constructor is invoked (just prior to invoking the
constructor).
- NON_THREAD_SAFE_SINGLETON - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Non-thread safe singletons can result in bad state changes.
- NotNullByDefault - Annotation Type in com.github.sebhoss.common.annotation
-
This annotation can be applied to a package, class or method to indicate that the class fields, method return types
and parameters in that element are not null by default unless there is:
An explicit nullness annotation
The method overrides a method in a superclass (in which case the annotation of the corresponding parameter in the
superclass applies)
there is a default parameter annotation applied to a more tightly nested element.
- NPATH_COMPLEXITY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The NPath complexity of a method is the number of acyclic execution paths through that method.
- NULL - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to null analysis
- NULL_ASSIGNMENT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Assigning a "null" to a variable (outside of its declaration) is usually bad form.
- Nullsafe - Class in com.github.sebhoss.common.annotation
-
Utility classes which helps working with legacy (nullable) APIs.
- Nullsafe() - Constructor for class com.github.sebhoss.common.annotation.Nullsafe
-
- nullsafe(T) - Static method in class com.github.sebhoss.common.annotation.Nullsafe
-
- SERIAL - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to missing serialVersionUID field for a serializable class
- SHORT_CLASS_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Classnames with fewer than five characters are not recommended.
- SHORT_INSTANTIATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Calling new Short() causes memory allocation that can be avoided by the static Short.valueOf().
- SHORT_METHOD_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Method names that are very short are not helpful to the reader.
- SHORT_VARIABLE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Fields, local variables, or parameter names that are very short are not helpful to the reader.
- SIGNATURE_DECLARE_THROWS_EXCEPTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Methods that declare the generic Exception as a possible throwable are not very helpful since their failure modes
are unclear.
- SIMPLE_DATE_FORMAT_NEEDS_LOCALE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Be sure to specify a Locale when creating SimpleDateFormat instances to ensure that locale-appropriate formatting
is used.
- SIMPLIFY_BOOLEAN_ASSERTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid negation in an assertTrue or assertFalse test.
- SIMPLIFY_BOOLEAN_EXPRESSIONS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid unnecessary comparisons in boolean expressions, they serve no purpose and impacts readability.
- SIMPLIFY_BOOLEAN_RETURNS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid unnecessary if-then-else statements when returning a boolean.
- SIMPLIFY_CONDITIONAL - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
No need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
- SIMPLIFY_STARTS_WITH - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Since it passes in a literal of length 1, calls to (string).startsWith can be rewritten using (string).charAt(0)
at the expense of some readability.
- SINGULAR_FIELD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Fields whose scopes are limited to just single methods do not rely on the containing object to provide them to
other methods.
- STATIC_ACCESS - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to incorrect static access
- STATIC_EJB_FIELD_SHOULD_BE_FINAL - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
According to the J2EE specification, an EJB should not have any static fields with write access.
- STATIC_METHOD - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to methods that could be declared as static
- STRING_BUFFER_INSTANTIATION_WITH_CHAR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Individual character values provided as initialization arguments will be converted into integers.
- STRING_INSTANTIATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid instantiating String objects; this is usually unnecessary since they are immutable and can be safely
shared.
- STRING_TO_STRING - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid calling toString() on objects already known to be string instances; this is unnecessary.
- SUPER - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to overriding a method without super invocations
- SUSPICIOUS_CONSTANT_FIELD_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Field names using all uppercase characters - Sun's Java naming conventions indicating constants - should be
declared as final.
- SUSPICIOUS_EQUALS_METHOD_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The method name and parameter number are suspiciously close to equals(Object), which can denote an intention to
override the equals(Object) method.
- SUSPICIOUS_HASHCODE_METHOD_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The method name and return type are suspiciously close to hashCode(), which may denote an intention to override
the hashCode() method.
- SUSPICIOUS_OCTAL_ESCAPE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A suspicious octal escape sequence was found inside a String literal.
- SWITCH_DENSITY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A high ratio of statements to labels in a switch statement implies that the switch statement is overloaded.
- SWITCH_STATEMENTS_SHOULD_HAVE_DEFAULT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
All switch statements should include a default option to catch any unspecified values.
- SYNC_OVERRIDE - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings because of missing synchronize when overriding a synchronized method
- SYNTHETHIC_ACCESS - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to unoptimized access from inner classes
- SYSTEM_PRINTLN - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
References to System.(out|err).print are usually intended for debugging purposes and can remain in the codebase
even in production code.
- UNCHECKED - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to unchecked operations
- UNCOMMENTED_EMPTY_CONSTRUCTOR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Uncommented Empty Constructor finds instances where a constructor does not contain statements, but there is no
comment.
- UNCOMMENTED_EMPTY_METHOD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Uncommented Empty Method finds instances where a method does not contain statements, but there is no comment.
- UNCONDITIONAL_IF_STATEMENT - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Do not use "if" statements whose conditionals are always true or always false.
- UNNECESSARY_BOOLEAN_ASSERTION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
A JUnit test assertion with a boolean literal is unnecessary since it always will evaluate to the same thing.
- UNNECESSARY_CASE_CHANGE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Using equalsIgnoreCase() is faster than using toUpperCase/toLowerCase().equals()
- UNNECESSARY_CONSTRUCTOR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule detects when a constructor is not necessary; i.e., when there is only one constructor, its public, has
an empty body, and takes no arguments.
- UNNECESSARY_CONVERSION_TEMPORARY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid the use temporary objects when converting primitives to Strings.
- UNNECESSARY_FINAL_MODIFIER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
When a class has the final modifier, all the methods are automatically final and do not need to be tagged as
such.
- UNNECESSARY_FULLY_QUALIFIED_NAME - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Import statements allow the use of non-fully qualified names.
- UNNECESSARY_LOCAL_BEFORE_RETURN - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid the creation of unnecessary local variables.
- UNNECESSARY_PARENTHESES - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Sometimes expressions are wrapped in unnecessary parentheses, making them look like function calls.
- UNNECESSARY_RETURN - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid the use of unnecessary return statements.
- UNNECESSARY_WRAPPER_OBJECT_CREATION - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Most wrapper classes provide static conversion methods that avoid the need to create intermediate objects just to
create the primitive forms.
- UNQUALIFIED_FIELD_ACCESS - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to field access unqualified
- UNSYCHRONIZED_STATIC_DATE_FORMATTER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
SimpleDateFormat instances are not synchronized.
- UNUSED - Static variable in class com.github.sebhoss.common.annotation.CompilerWarnings
-
Suppresses warnings relative to unused code and dead code
- UNUSED_FORMAL_PARAMETER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid passing parameters to methods or constructors without actually referencing them in the method body.
- UNUSED_IMPORTS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Avoid the use of unused import statements to prevent unwanted dependencies.
- UNUSED_LOCAL_VARIABLE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Detects when a local variable is declared and/or assigned, but not used.
- UNUSED_MODIFIER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Fields in interfaces are automatically public static final, and methods are public abstract.
- UNUSED_NULL_CHECK_IN_EQUALS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
After checking an object reference for null, you should invoke equals() on that object rather than passing it to
another object's equals() method.
- UNUSED_PRIVATE_FIELD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Detects when a private field is declared and/or assigned a value, but not used.
- UNUSED_PRIVATE_METHOD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Unused Private Method detects when a private method is declared but is unused.
- USE_ARRAY_LIST_INSTEAD_OF_VECTOR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
ArrayList is a much better Collection implementation than Vector if thread-safe operation is not required.
- USE_ARRAYS_AS_LIST - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The java.util.Arrays class has a "asList" method that should be used when you want to create a new List from an
array of objects.
- USE_ASSERT_EQUALS_INSTEAD_OF_ASSERT_TRUE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule detects JUnit assertions in object equality.
- USE_ASSERT_NULL_INSTEAD_OF_ASSERT_TRUE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule detects JUnit assertions in object references equality.
- USE_ASSERT_SAME_INSTEAD_OF_ASSERT_TRUE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
This rule detects JUnit assertions in object references equality.
- USE_ASSERT_TRUE_INSTEAD_OF_ASSERT_EQUALS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
When asserting a value is the same as a boolean literal, use assertTrue/assertFalse, instead of assertEquals.
- USE_COLLECTION_IS_EMPTY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The isEmpty() method on java.util.Collection is provided to determine if a collection has any elements.
- USE_CONCURRENT_HASH_MAP - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Since Java5 brought a new implementation of the Map designed for multi-threaded access, you can perform efficient
map reads without blocking other threads.
- USE_CORRECT_EXCEPTION_LOGGING - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
To make sure the full stacktrace is printed out, use the logging statement with two arguments: a String and a
Throwable.
- USE_EQUALS_TO_COMPARE_STRINGS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Using '==' or '!=' to compare strings only works if intern version is used on both sides.
- USE_INDEX_OF_CHAR - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Use String.indexOf(char) when checking for the index of a single character; it executes faster.
- USE_LOCALE_WITH_CASE_CONVERSIONS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
When doing String.toLowerCase()/toUpperCase() conversions, use Locales to avoids problems with languages that
have unusual conventions, i.e.
- USE_NOTIFY_ALL_INSTEAD_OF_NOTIFY - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Thread.notify() awakens a thread monitoring the object.
- USE_OBJECT_FOR_CLEARER_API - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
When you write a public method, you should be thinking in terms of an API.
- USE_PROPER_CLASS_LOADER - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
In J2EE, the getClassLoader() method might not work as expected.
- USE_SINGLETON - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
For classes that only have static methods, consider making them Singletons.
- USE_STRING_BUFFER_FOR_STRING_APPENDS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The use of the '+=' operator for appending strings causes the JVM to create and use an internal StringBuffer.
- USE_STRING_BUFFER_LENGTH - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Use StringBuffer.length() to determine StringBuffer length rather than using StringBuffer.toString().equals("")
or StringBuffer.toString().length() == ...
- USE_VARARGS - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Java 5 introduced the varargs parameter declaration for methods and constructors.
- USELESS_OPERATION_ON_IMMUTABLE - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
An operation on an Immutable object (String, BigDecimal or BigInteger) won't change the object itself since the
result of the operation is a new object.
- USELESS_OVERRIDING_METHOD - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
The overriding method merely calls the same method defined in a superclass.
- USELESS_PARANTHESES - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
Useless parentheses should be removed.
- USELESS_STRING_VALUE_OF - Static variable in class com.github.sebhoss.common.annotation.PMDWarnings
-
No need to call String.valueOf to append to a string; just use the valueOf() argument directly.