| 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 parameters for methods, constructors, catch and for-each blocks are final.
|
class |
NewlineAtEndOfFileCheck
Checks whether files end with a line separator.
|
class |
OrderedPropertiesCheck
Detects if keys in properties files are in correct order.
|
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 requires that comments be the only thing on a line.
|
class |
UniquePropertiesCheck
Checks properties files for duplicate property keys.
|
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 |
AnnotationOnSameLineCheck
The check does verifying that annotations are located on the same line with their targets.
|
class |
AnnotationUseStyleCheck
This check controls the style with the usage of annotations.
|
class |
MissingDeprecatedCheck
Verifies that both the @Deprecated annotation is present
and the @deprecated javadoc tag are present when either one is present.
|
class |
MissingOverrideCheck
Verifies 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, i.e.
|
class |
EmptyBlockCheck
Checks for empty blocks.
|
class |
EmptyCatchBlockCheck
Checks for empty catch blocks.
|
class |
LeftCurlyCheck
Checks for the placement of left curly braces (
'{') for code blocks. |
class |
NeedBracesCheck
Checks for braces around code blocks.
|
class |
RightCurlyCheck
Checks the placement of right curly braces (
'}')
for if-else, try-catch-finally blocks, while-loops, for-loops,
method definitions, class definitions, constructor definitions,
instance and static initialization blocks. |
| Modifier and Type | Class and Description |
|---|---|
class |
ArrayTrailingCommaCheck
Checks that array initialization contains a 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
";" semicolon). |
class |
ExplicitInitializationCheck
Checks if any class or object member is 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. |
class |
IllegalCatchCheck
Checks that certain exception types do not appear in a
catch statement. |
class |
IllegalThrowsCheck
This check can be used to ensure that types are not declared to be thrown.
|
class |
IllegalTokenCheck
Checks for illegal tokens.
|
class |
IllegalTokenTextCheck
Checks specified tokens text for matching an illegal pattern from
format property. |
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 ones) define a constructor and don't rely
on the default one.
|
class |
MissingSwitchDefaultCheck
Checks that switch statement has a "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
Verifies there are no
finalize() methods defined in a class. |
class |
OverloadMethodsDeclarationOrderCheck
Checks that overload methods are grouped together.
|
class |
SimplifyBooleanExpressionCheck
Checks for over-complicated boolean expressions.
|
class |
SimplifyBooleanReturnCheck
Checks for over-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 |
UnnecessarySemicolonAfterTypeMemberDeclarationCheck
Checks if unnecessary semicolon is used after type member declaration.
|
class |
UnnecessarySemicolonInEnumerationCheck
Checks if unnecessary semicolon is in enum definitions.
|
class |
UnnecessarySemicolonInTryWithResourcesCheck
Checks if unnecessary semicolon is used in last resource declaration.
|
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
Makes sure that utility classes (classes that contain only static methods or fields in their API)
do not have a public constructor.
|
class |
InterfaceIsTypeCheck
Implements Joshua Bloch, Effective Java, Item 17 -
Use Interfaces only to define types.
|
class |
ThrowsCountCheck
Restricts throws statements to a specified count (4 by default).
|
| Modifier and Type | Class and Description |
|---|---|
class |
HeaderCheck
Checks that a source file begins with a specified header.
|
class |
RegexpHeaderCheck
Checks the header of a source file against a header that contains a
regular expression for each line of the source header.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AvoidStarImportCheck
Checks that there are no import statements that use the
* notation. |
class |
AvoidStaticImportCheck
Checks that there are no static import statements.
|
class |
IllegalImportCheck
Checks for imports from a set of illegal packages.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CommentsIndentationCheck
Controls the indentation between comments and surrounding code.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AtclauseOrderCheck
Checks the order of
javadoc block-tags or javadoc tags.
|
class |
InvalidJavadocPositionCheck
Checks that Javadocs are located at the correct position.
|
class |
JavadocBlockTagLocationCheck
Checks that a
javadoc block tag appears only at the beginning of a line, ignoring
leading asterisks and white space.
|
class |
JavadocParagraphCheck
Checks that:
There is one blank line between each of two paragraphs
and one blank line before the at-clauses block if it is present.
Each paragraph but the first has <p> immediately
before the first word, with no space after.
|
class |
JavadocStyleCheck
Custom Checkstyle Check to validate Javadoc.
|
class |
JavadocTagContinuationIndentationCheck
Checks the indentation of the continuation lines in at-clauses.
|
class |
JavadocTypeCheck
Checks the Javadoc of a type.
|
class |
JavadocVariableCheck
Checks that a variable has Javadoc comment.
|
class |
MissingJavadocPackageCheck
Checks for missing Javadoc comments in package-info.java files.
|
class |
MissingJavadocTypeCheck
Checks for missing Javadoc comments for class, enum, interface, and annotation interface
definitions.
|
class |
NonEmptyAtclauseDescriptionCheck
Checks that the at-clause tag is followed by description .
|
class |
SingleLineJavadocCheck
Checks that a JavaDoc block can fit on a single line and doesn't
contain at-clauses.
|
class |
SummaryJavadocCheck
Checks that
Javadoc summary sentence does not contain phrases that are not recommended to use.
|
class |
WriteTagCheck
Outputs a JavaDoc tag as information.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClassMemberImpliedModifierCheck
Checks for implicit modifiers on nested types in classes.
|
class |
InterfaceMemberImpliedModifierCheck
Checks for implicit modifiers on interface members and nested types.
|
class |
ModifierOrderCheck
Checks that the order of modifiers conforms to the suggestions in the
Java Language specification, § 8.1.1, 8.3.1, 8.4.3 and
9.4.
|
class |
RedundantModifierCheck
Checks for redundant modifiers.
|
| 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 |
RegexpMultilineCheck
A check for detecting that matches across multiple lines.
|
class |
RegexpOnFilenameCheck
Implementation of a check that looks for a file name and/or path match (or
mis-match) against specified patterns.
|
class |
RegexpSinglelineCheck
A check for detecting single lines that match a supplied regular expression.
|
class |
RegexpSinglelineJavaCheck
A check for detecting single lines that match a supplied
regular expression 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 and constructors.
|
class |
ParameterNumberCheck
Checks the number of parameters of a method or constructor.
|
| 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 white
space is required at an empty for initializer, or such white space is
forbidden.
|
class |
EmptyForIteratorPadCheck
Checks the padding of an empty for iterator; that is whether a white
space is required at an empty for iterator, or such white 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 that there are no tab characters (
'\t') in the source code. |
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 the policy on how to wrap lines on 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-2019. All Rights Reserved.