| Package | Description |
|---|---|
| com.puppycrawl.tools.checkstyle.checks |
Contains the checks that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.annotation |
Contains the Annotation checks that are
bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.blocks |
Contains the Block checks that are
bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.coding |
Contains the Coding checks that are
bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.design |
Contains the Class Design checks that
are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.header |
File Header checks.
|
| com.puppycrawl.tools.checkstyle.checks.imports |
Contains the Imports checks that are
bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.indentation |
Contains all classes required for the
indentation check.
|
| com.puppycrawl.tools.checkstyle.checks.javadoc |
Contains the Javadoc checks that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.modifier |
Contains the modifier checks that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.naming |
Contains the Naming conventions checks
that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.regexp |
Contains the regular expression checks that are bundled with the main
distribution.
|
| com.puppycrawl.tools.checkstyle.checks.sizes |
Contains the Size Violations checks
that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.whitespace |
Contains the Whitespace checks that
are bundled with the main distribution.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ArrayTypeStyleCheck
Checks the style of array type definitions.
|
class |
FinalParametersCheck
Check that method/constructor/catch/foreach parameters are final.
|
class |
NewlineAtEndOfFileCheck
Checks that there is a newline at the end of each file.
|
class |
SuppressWarningsHolder
Maintains a set of check suppressions from
SuppressWarnings
annotations. |
class |
TodoCommentCheck
A check for 'TODO:' comments.
|
class |
TrailingCommentCheck
The check to ensure that comments are the only thing on a line.
|
class |
UniquePropertiesCheck
Checks the uniqueness of property keys (left from equal sign) in the
properties file.
|
class |
UpperEllCheck
Checks that long constants are defined with an upper ell.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AnnotationLocationCheck
Check location of annotation on language elements.
|
class |
AnnotationUseStyleCheck
This check controls the style with the usage of annotations.
|
class |
MissingDeprecatedCheck
This class is used to verify that both the
Deprecated annotation
and the deprecated javadoc tag are present when
either one is present. |
class |
MissingOverrideCheck
This class is used to verify that the
Override
annotation is present when the inheritDoc javadoc tag is present. |
class |
PackageAnnotationCheck
This check makes sure that all package annotations are in the
package-info.java file.
|
class |
SuppressWarningsCheck
This check allows you to specify what warnings that
SuppressWarnings is not
allowed to suppress. |
| Modifier and Type | Class and Description |
|---|---|
class |
AvoidNestedBlocksCheck
Finds nested blocks.
|
class |
EmptyBlockCheck
Checks for empty blocks.
|
class |
EmptyCatchBlockCheck
Checks for empty catch blocks.
|
class |
LeftCurlyCheck
Checks the placement of left curly braces on types, methods and
other blocks:
LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, STATIC_INIT,
LAMBDA. |
class |
NeedBracesCheck
Checks for braces around code blocks.
|
class |
RightCurlyCheck
Checks the placement of right curly braces.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ArrayTrailingCommaCheck
Checks if array initialization contains optional trailing comma.
|
class |
AvoidInlineConditionalsCheck
Detects inline conditionals.
|
class |
DefaultComesLastCheck
Check that the
default is after all the cases
in a switch statement. |
class |
EmptyStatementCheck
Detects empty statements (standalone ';').
|
class |
ExplicitInitializationCheck
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. |
class |
FallThroughCheck
Checks for fall through in switch statements
Finds locations where a case contains Java code -
but lacks a break, return, throw or continue statement.
|
class |
IllegalCatchCheck
Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException
is almost never acceptable.
|
class |
IllegalThrowsCheck
Throwing java.lang.Error or java.lang.RuntimeException
is almost never acceptable.
|
class |
IllegalTokenCheck
Checks for illegal tokens.
|
class |
IllegalTokenTextCheck
Checks for illegal token text.
|
class |
InnerAssignmentCheck
Checks for assignments in subexpressions, such as in
String s = Integer.toString(i = 2);. |
class |
MagicNumberCheck
Checks that there are no
"magic numbers" where a magic
number is a numeric literal that is not defined as a constant.
|
class |
MissingCtorCheck
Checks that classes (except abstract one) define a ctor and don't rely
on the default one.
|
class |
MissingSwitchDefaultCheck
Checks that switch statement has "default" clause.
|
class |
MultipleVariableDeclarationsCheck
Checks that each variable declaration is in its own statement
and on its own line.
|
class |
NoCloneCheck
Checks that the clone method is not overridden from the
Object class.
|
class |
NoFinalizerCheck
Checks that no method having zero parameters is defined
using the name finalize.
|
class |
OverloadMethodsDeclarationOrderCheck
Checks that overload methods are grouped together.
|
class |
SimplifyBooleanExpressionCheck
Checks for overly complicated boolean expressions.
|
class |
SimplifyBooleanReturnCheck
Checks for overly complicated boolean return statements.
|
class |
StringLiteralEqualityCheck
Checks that string literals are not used with
== or !=. |
class |
SuperCloneCheck
Checks that an overriding clone() method invokes super.clone().
|
class |
SuperFinalizeCheck
Checks that an overriding finalize() method invokes super.finalize().
|
class |
VariableDeclarationUsageDistanceCheck
Checks the distance between declaration of variable and its first usage.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DesignForExtensionCheck
The check finds classes that are designed for extension (subclass creation).
|
class |
HideUtilityClassConstructorCheck
Make sure that utility classes (classes that contain only static methods)
do not have a public constructor.
|
class |
InterfaceIsTypeCheck
Implements Bloch, Effective Java, Item 17 -
Use Interfaces only to define types.
|
class |
ThrowsCountCheck
Restricts throws statements to a specified count (default = 4).
|
| Modifier and Type | Class and Description |
|---|---|
class |
HeaderCheck
Checks the header of the source against a fixed header file.
|
class |
RegexpHeaderCheck
Checks the header of the source against a header file that contains a
regular expression
for each line of the source header. |
| Modifier and Type | Class and Description |
|---|---|
class |
AvoidStarImportCheck
Check that finds import statements that use the * notation.
|
class |
AvoidStaticImportCheck
Check that finds static imports.
|
class |
IllegalImportCheck
Checks for imports from a set of illegal packages.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CommentsIndentationCheck
This Check controls the indentation between comments and surrounding code.
|
| Modifier and Type | Class and Description |
|---|---|
class |
JavadocStyleCheck
Custom Checkstyle Check to validate Javadoc.
|
class |
JavadocTypeCheck
Checks the Javadoc of a type.
|
class |
JavadocVariableCheck
Checks that a variable has Javadoc comment.
|
class |
WriteTagCheck
Outputs a JavaDoc tag as information.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ModifierOrderCheck
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.
|
class |
RedundantModifierCheck
Checks for redundant modifiers in interface and annotation definitions,
final modifier on methods of final classes, inner
interface
declarations that are declared as static, non public class
constructors and enum constructors, nested enum definitions that are declared
as static. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbbreviationAsWordInNameCheck
The Check validate abbreviations(consecutive capital letters) length in
identifier name, it also allows to enforce camel case naming.
|
class |
AbstractClassNameCheck
Ensures that the names of abstract classes conforming to some
regular expression and check that
abstract modifier exists. |
class |
AbstractNameCheck
Abstract class for checking that names conform to a specified format.
|
class |
PackageNameCheck
Checks that package names conform to a format specified
by the format property.
|
| Modifier and Type | Class and Description |
|---|---|
class |
RegexpOnFilenameCheck
Implementation of a check that looks for a file name and/or path match (or
mis-match) against specified patterns.
|
class |
RegexpSinglelineJavaCheck
Implementation of a check that looks for a single line in Java files.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AnonInnerLengthCheck
Checks for long anonymous inner classes.
|
class |
FileLengthCheck
Checks for long source files.
|
class |
LineLengthCheck
Checks for long lines.
|
class |
MethodLengthCheck
Checks for long methods.
|
class |
ParameterNumberCheck
Checks the number of parameters that a method or constructor has.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractParenPadCheck
Abstract class for checking the padding of parentheses.
|
class |
EmptyForInitializerPadCheck
Checks the padding of an empty for initializer; that is whether a
space is required at an empty for initializer, or such spaces are
forbidden.
|
class |
EmptyForIteratorPadCheck
Checks the padding of an empty for iterator; that is whether a
space is required at an empty for iterator, or such spaces are
forbidden.
|
class |
EmptyLineSeparatorCheck
Checks for empty line separators after header, package, all import declarations,
fields, constructors, methods, nested classes,
static initializers and instance initializers.
|
class |
FileTabCharacterCheck
Checks to see if a file contains a tab character.
|
class |
MethodParamPadCheck
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.
|
class |
NoLineWrapCheck
Checks that chosen statements are not line-wrapped.
|
class |
NoWhitespaceAfterCheck
Checks that there is no whitespace after a token.
|
class |
NoWhitespaceBeforeCheck
Checks that there is no whitespace before a token.
|
class |
OperatorWrapCheck
Checks line wrapping for operators.
|
class |
SeparatorWrapCheck
Checks line wrapping with separators.
|
class |
SingleSpaceSeparatorCheck
Checks that non-whitespace characters are separated by no more than one
whitespace.
|
class |
WhitespaceAfterCheck
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.
|
class |
WhitespaceAroundCheck
Checks that a token is surrounded by whitespace.
|
Copyright © 2001–2018. All rights reserved.