diff --git a/ant-phase-package.xml b/ant-phase-package.xml index 145f52994..ae24c741b 100644 --- a/ant-phase-package.xml +++ b/ant-phase-package.xml @@ -1,6 +1,6 @@ - + + + + + + + Available Checks + Checkstyle Development Team + + + +

+ Checkstyle provides many checks that you can apply to your + sourcecode. Below is an alphabetical reference, the site + navigation menu provides a reference organized by functionality. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AbstractClassName + Ensures that the names of abstract classes conforming to some + regular expression. +
AnnotationUseStyleThis check controls the style with the usage of annotations.
AnonInnerLengthChecks for long anonymous inner classes.
ArrayTrailingCommaChecks if array initialization contains optional trailing comma.
ArrayTypeStyleChecks the style of array type definitions.
AvoidInlineConditionalsDetects inline conditionals.
AvoidNestedBlocksFinds nested blocks.
AvoidStarImportCheck that finds import statements that use the * notation.
AvoidStaticImportCheck that finds static imports.
BooleanExpressionComplexity + Restricts nested boolean operators (&&, ||, &, | + and ^) to a specified depth (default = 3). +
ClassDataAbstractionCouplingThis metric measures the number of instantiations of other classes within the given class.
ClassFanOutComplexityThe number of other classes a given class relies on.
ClassTypeParameterName + Checks that class type parameter names conform to a format + specified by the format property. +
ConstantNameChecks that constant names conform to a format specified by the format property.
CovariantEquals + Checks that if a class defines a covariant method equals, then + it defines method equals(java.lang.Object). +
CyclomaticComplexityChecks cyclomatic complexity against a specified limit.
DeclarationOrder + Checks that the parts of a class or interface declaration + appear in the order suggested by the Code Conventions for the Java Programming Language. +
DefaultComesLast + Check that the default is after all the + cases in a switch statement. +
DescendantTokenChecks for restricted tokens beneath other tokens.
DesignForExtensionChecks that classes are designed for inheritance.
DoubleCheckedLocking + Detect the double-checked locking idiom, a technique that + tries to avoid synchronization overhead but is incorrect + because of subtle artifacts of the java memory model. +
EmptyBlockChecks for empty blocks.
EmptyForInitializerPadChecks the padding of an empty for initializer; that is whether a + space is required at an empty for initializer, or such spaces are + forbidden.
EmptyForIteratorPadChecks the padding of an empty for iterator; that is whether a + space is required at an empty for iterator, or such spaces are + forbidden.
EmptyStatement + Detects empty statements (standalone ';').
EqualsAvoidNull + Checks that any combination of String literals with optional + assignment is on the left side of an equals() comparison.
EqualsHashCode + Checks that classes that override equals() also override hashCode().
ExecutableStatementCount + Restricts the number of executable statements to a specified + limit (default = 30). +
ExplicitInitialization + Checks if any class or object member explicitly initialized + to default for its type value (null for object + references, zero for numeric types and char + and false for boolean. +
FallThroughChecks for fall through in switch statements + Finds locations where a case contains Java code - + but lacks a break, return, throw or continue statement.
FileLength + Checks for long source files.
FileTabCharacterChecks to see if a file contains a tab character.
FinalClass + Checks that class which has only private ctors + is declared as final.
FinalLocalVariable + Ensures that local variables that never get their values changed, + must be declared final.
FinalParametersCheck that method/constructor/catch/foreach parameters are final.
GenericWhitespaceChecks that the whitespace around the Generic tokens < and > are + correct to the typical convention.
HeaderChecks the header of the source against a fixed header file.
HiddenFieldChecks that a local variable or a parameter does not shadow + a field that is defined in the same class.
HideUtilityClassConstructorMake sure that utility classes (classes that contain only static methods) + do not have a public constructor.
IllegalCatchCatching java.lang.Exception, java.lang.Error or java.lang.RuntimeException + is almost never acceptable.
IllegalImport + Checks for imports from a set of illegal packages.
IllegalInstantiation + Checks for illegal instantiations where a factory method is preferred.
IllegalThrowsThrowing java.lang.Error or java.lang.RuntimeException + is almost never acceptable.
IllegalToken + Checks for illegal tokens.
IllegalTokenText + Checks for illegal token text.
IllegalType + Checks that particular class are never used as types in variable + declarations, return values or parameters.
ImportControlCheck that controls what packages can be imported in each package.
ImportOrderEnsures that groups of imports come in a specific order.
IndentationChecks correct indentation of Java Code.
InnerAssignment + Checks for assignments in subexpressions, such as in + String s = Integer.toString(i = 2);.
InnerTypeLast + Check nested (internal) classes/interfaces are declared at the bottom of the + class after all method and field declarations.
InterfaceIsTypeImplements Bloch, Effective Java, Item 17 - + Use Interfaces only to define types.
JUnitTestCaseEnsures that the setUp(), tearDown()methods are named correctly, + have no arguments, return void and are either public or protected.
JavaNCSSThis check calculates the Non Commenting Source Statements (NCSS) metric for + java source files and methods.
JavadocMethodChecks the Javadoc of a method or constructor.
JavadocPackageChecks that all packages have a package documentation.
JavadocStyleCustom Checkstyle Check to validate Javadoc.
JavadocTypeChecks the Javadoc of a type.
JavadocVariableChecks that a variable has Javadoc comment.
LeftCurly + Checks the placement of left curly braces on types, methods and + other blocks: +
LineLengthChecks for long lines.
LocalFinalVariableName + Checks that local final variable names conform to a format specified + by the format property.
LocalVariableName + Checks that local, non-final variable names conform to a format specified + by the format property.
MagicNumber + Checks for magic numbers.
MemberName + Checks that instance variable names conform to a format specified + by the format property.
MethodLength + Checks for long methods.
MethodName + Checks that method names conform to a format specified + by the format property.
MethodParamPad + Checks the padding between the identifier of a method definition, + constructor definition, method call, or constructor invocation; + and the left parenthesis of the parameter list.
MethodTypeParameterName + Checks that class type parameter names conform to a format specified + by the format property.
MissingCtor + Checks that classes (except abstract one) define a ctor and don't rely + on the default one.
MissingDeprecated + This class is used to verify that both the +
MissingOverride + This class is used to verify that the
MissingSwitchDefault + Checks that switch statement has "default" clause.
ModifiedControlVariableCheck for ensuring that for loop control variables are not modified + inside the for block.
ModifierOrder + Checks that the order of modifiers conforms to the suggestions in the + + Java Language specification, sections 8.1.1, 8.3.1 and 8.4.3.
MultipleStringLiteralsChecks for multiple occurrences of the same string literal within a + single file.
MultipleVariableDeclarations + Checks that each variable declaration is in its own statement + and on its own line.
MutableException Ensures that exceptions (defined as any class name conforming + to some regular expression) are immutable.
NPathComplexityChecks the npath complexity against a specified limit (default = 200).
NeedBraces + Checks for braces around code blocks.
NestedIfDepthRestricts nested if-else blocks to a specified depth (default = 1).
NestedTryDepthRestricts nested try-catch-finally blocks to a specified depth (default = 1).
NewlineAtEndOfFile + Checks that there is a newline at the end of each file.
NoClone + Checks that the clone method is not overridden from the + Object class.
NoFinalizerChecks that no method having zero parameters is defined + using the name finalize.
NoWhitespaceAfter + Checks that there is no whitespace after a token.
NoWhitespaceBefore + Checks that there is no whitespace before a token.
OperatorWrap + Checks line wrapping for operators.
OuterTypeNumberChecks for the number of defined types at the "outer" level.
PackageAnnotationThis check makes sure that all package annotations are in the + package-info.java file.
PackageDeclarationEnsures there is a package declaration.
PackageName + Checks that package names conform to a format specified + by the format property.
ParameterAssignment + Disallow assignment of parameters.
ParameterName + Checks that parameter names conform to a format specified + by the format property.
ParameterNumber + Checks the number of parameters that a method or constructor has.
ParenPadChecks the padding of parentheses; that is whether a space is required + after a left parenthesis and before a right parenthesis, or such spaces are + forbidden, with the exception that it does + not check for padding of the right parenthesis at an empty for iterator.
RedundantImport + Checks for imports that are redundant.
RedundantModifierChecks for redundant modifiers in interface and annotation definitions.
RedundantThrowsChecks for redundant exceptions declared in throws clause + such as duplicates, unchecked exceptions or subclasses of + another declared exception.
Regexp + A check that makes sure that a specified pattern exists (or not) in the file.
RegexpHeaderChecks the header of the source against a header file that contains a +
RegexpMultilineImplementation of a check that looks that matches across multiple lines in + any file type.
RegexpSinglelineImplementation of a check that looks for a single line in any file type.
RegexpSinglelineJavaImplementation of a check that looks for a single line in Java files.
RequireThisChecks that code doesn't rely on the "this" default.
ReturnCount + Restricts return statements to a specified count (default = 2).
RightCurly + Checks the placement of right curly braces.
SimplifyBooleanExpression + Checks for overly complicated boolean expressions.
SimplifyBooleanReturn + Checks for overly complicated boolean return statements.
StaticVariableName + Checks that static, non-final variable names conform to a format specified + by the format property.
StrictDuplicateCodePerforms a line-by-line comparison of all code lines and reports + duplicate code if a sequence of lines differs only in + indentation.
StringLiteralEqualityChecks that string literals are not used with + == or !=.
SuperClone + Checks that an overriding clone() method invokes super.clone().
SuperFinalize + Checks that an overriding finalize() method invokes super.finalize().
SuppressWarnings + This check allows you to specify what warnings that +
ThrowsCount + Restricts throws statements to a specified count (default = 1).
TodoComment + A check for TODO comments.
TrailingComment + The check to ensure that requires that comments be the only thing on a line.
Translation + The TranslationCheck class helps to ensure the correct translation of code by + checking property files for consistency regarding their keys.
TypeName + Checks that type names conform to a format specified + by the format property.
TypecastParenPadChecks the padding of parentheses for typecasts.
UncommentedMainDetects uncommented main methods.
UnnecessaryParentheses + Checks if unnecessary parentheses are used in a statement or expression.
UnusedImports + Checks for unused import statements.
UpperEllChecks that long constants are defined with an upper ell.
VisibilityModifierChecks visibility of class members.
WhitespaceAfter + Checks that a token is followed by whitespace, with the exception that it + does not check for whitespace after the semicolon of an empty for iterator.
WhitespaceAround + Checks that a token is surrounded by whitespace.
WriteTag + Outputs a JavaDoc tag as information.
+ +