Uses of Class
com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
Packages that use AutomaticBean Package Description com.puppycrawl.tools.checkstyle Contains the implementation of the Checkstyle framework.com.puppycrawl.tools.checkstyle.api Contains the core API to be used to implement checks.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.metrics Contains the Metrics 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.com.puppycrawl.tools.checkstyle.filefilters Contains the before execution file filters that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.filters Contains the filters that are bundled with the main distribution. -
-
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle Modifier and Type Class Description class
Checker
This class provides the functionality to check a set of files.class
DefaultLogger
Simple plain logger for text output.class
TreeWalker
Responsible for walking an abstract syntax tree and notifying interested checks at each each node.class
XMLLogger
Simple XML logger.class
XpathFileGeneratorAstFilter
CatchesTreeWalkerAuditEvent
and generates corresponding xpath query.class
XpathFileGeneratorAuditListener
Generates suppressions.xml file, based on violations occurred. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.api
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.api Modifier and Type Class Description class
AbstractCheck
The base class for checks.class
AbstractFileSetCheck
Provides common functionality for many FileSetChecks.class
AbstractViolationReporter
Serves as an abstract base class for all modules that report inspection findings. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks Modifier and Type Class Description class
ArrayTypeStyleCheck
Checks the style of array type definitions.class
AvoidEscapedUnicodeCharactersCheck
Restrict using Unicode escapes (such as \u221e).class
DescendantTokenCheck
Checks for restricted tokens beneath other tokens.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
OuterTypeFilenameCheck
Checks that the outer type name and the file name match.class
SuppressWarningsHolder
Maintains a set of check suppressions from@SuppressWarnings
annotations.class
TodoCommentCheck
A check forTODO:
comments.class
TrailingCommentCheck
The check to ensure that requires that comments be the only thing on a line.class
TranslationCheck
A FileSetCheck that ensures the correct translation of code by checking property files for consistency regarding their keys.class
UncommentedMainCheck
Checks for uncommented main() methods.class
UniquePropertiesCheck
Checks properties files for duplicate property keys.class
UpperEllCheck
Checks that long constants are defined with an upper ell. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.annotation
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.annotation Modifier and Type Class 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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.blocks
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.blocks Modifier and Type Class 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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.coding
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.coding Modifier and Type Class Description class
AbstractSuperCheck
Abstract class for checking that an overriding method with no parameters invokes the super method.class
ArrayTrailingCommaCheck
Checks that array initialization contains a trailing comma.class
AvoidInlineConditionalsCheck
Detects inline conditionals.class
CovariantEqualsCheck
Checks that classes which define a covariantequals()
method also override methodequals(Object)
.class
DeclarationOrderCheck
Checks the order in which parts of the class or interface declaration are defined.class
DefaultComesLastCheck
Check that thedefault
is after all the cases in aswitch
statement.class
EmptyStatementCheck
Detects empty statements (standalone";"
semicolon).class
EqualsAvoidNullCheck
Checks that any combination of String literals is on the left side of anequals()
comparison.class
EqualsHashCodeCheck
Checks that classes that either overrideequals()
orhashCode()
also overrides the other.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 andchar
andfalse
forboolean
.class
FallThroughCheck
Checks for fall-through inswitch
statements.class
FinalLocalVariableCheck
Checks that local variables that never have their values changed are declared final.class
HiddenFieldCheck
Checks that a local variable or a parameter does not shadow a field that is defined in the same class.class
IllegalCatchCheck
Checks that certain exception types do not appear in acatch
statement.class
IllegalInstantiationCheck
Checks for illegal instantiations where a factory method is preferred.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 fromformat
property.class
IllegalTypeCheck
Checks that particular classes or interfaces are never used.class
InnerAssignmentCheck
Checks for assignments in subexpressions, such as inString 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
ModifiedControlVariableCheck
Check for ensuring that for loop control variables are not modified inside the for block.class
MultipleStringLiteralsCheck
Checks for multiple occurrences of the same string literal within a single file.class
MultipleVariableDeclarationsCheck
Checks that each variable declaration is in its own statement and on its own line.class
NestedForDepthCheck
Restricts nestedfor
blocks to a specified depth (default = 1).class
NestedIfDepthCheck
Restricts nested if-else blocks to a specified depth (default = 1).class
NestedTryDepthCheck
Restricts nested try blocks to a specified depth (default = 1).class
NoCloneCheck
Checks that the clone method is not overridden from the Object class.class
NoFinalizerCheck
Verifies there are nofinalize()
methods defined in a class.class
OneStatementPerLineCheck
Checks that there is only one statement per line.class
OverloadMethodsDeclarationOrderCheck
Checks that overload methods are grouped together.class
PackageDeclarationCheck
Ensures that a class has a package declaration, and (optionally) whether the package name matches the directory name for the source file.class
ParameterAssignmentCheck
Disallows assignment of parameters.class
RequireThisCheck
Checks that references to instance variables and methods of the present object are explicitly of the form "this.varName" or "this.methodName(args)" and that those references don't rely on the default behavior when "this." is absent.class
ReturnCountCheck
Restricts the number of return statements in methods, constructors and lambda expressions (2 by default).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 overridingclone()
method invokessuper.clone()
.class
SuperFinalizeCheck
Checks that an overridingfinalize()
method invokessuper.finalize()
.class
UnnecessaryParenthesesCheck
Checks if unnecessary parentheses are used in a statement or expression.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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.design
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.design Modifier and Type Class Description class
DesignForExtensionCheck
The check finds classes that are designed for extension (subclass creation).class
FinalClassCheck
Checks that a class which has only private constructors is declared as final.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
InnerTypeLastCheck
Check nested (inner) classes/interfaces are declared at the bottom of the class after all method and field declarations.class
InterfaceIsTypeCheck
Implements Joshua Bloch, Effective Java, Item 17 - Use Interfaces only to define types.class
MutableExceptionCheck
Ensures that exception classes (classes with names conforming to some regular expression and explicitly extending classes with names conforming to other regular expression) are immutable, that is, that they have only final fields.class
OneTopLevelClassCheck
Checks that each top-level class, interface or enum resides in a source file of its own.class
ThrowsCountCheck
Restricts throws statements to a specified count (4 by default).class
VisibilityModifierCheck
Checks visibility of class members. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.header
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.header Modifier and Type Class Description class
AbstractHeaderCheck
Abstract super class for header checks.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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.imports
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.imports Modifier and Type Class 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
CustomImportOrderCheck
Checks that the groups of import declarations appear in the order specified by the user.class
IllegalImportCheck
Checks for imports from a set of illegal packages.class
ImportControlCheck
Controls what can be imported in each package and file.class
ImportOrderCheck
Checks the ordering/grouping of imports.class
RedundantImportCheck
Checks for redundant import statements.class
UnusedImportsCheck
Checks for unused import statements. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.indentation
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.indentation Modifier and Type Class Description class
CommentsIndentationCheck
Controls the indentation between comments and surrounding code.class
IndentationCheck
Checks correct indentation of Java code. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.javadoc
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.javadoc Modifier and Type Class Description class
AbstractJavadocCheck
Base class for Checks that process Javadoc comments.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
JavadocMethodCheck
Checks the Javadoc of a method or constructor.class
JavadocPackageCheck
Checks that all packages have a package documentation.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
MissingJavadocMethodCheck
Checks for missing Javadoc comments for a method or constructor.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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.metrics
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.metrics Modifier and Type Class Description class
AbstractClassCouplingCheck
Base class for coupling calculation.class
BooleanExpressionComplexityCheck
Restrict the number of&&
,||
,&
,|
and^
in an expression.class
ClassDataAbstractionCouplingCheck
This metric measures the number of instantiations of other classes within the given class.class
ClassFanOutComplexityCheck
The number of other classes a given class relies on.class
CyclomaticComplexityCheck
Checks cyclomatic complexity against a specified limit.class
JavaNCSSCheck
Determines complexity of methods, classes and files by counting the Non Commenting Source Statements (NCSS).class
NPathComplexityCheck
Checks the NPATH complexity against a specified limit. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.modifier
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.modifier Modifier and Type Class 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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.naming
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.naming Modifier and Type Class Description class
AbbreviationAsWordInNameCheck
The Check validate abbreviations(consecutive capital letters) length in identifier name, it also allows to enforce camel case naming.class
AbstractAccessControlNameCheck
Abstract class for checking a class member (field/method)'s name conforms to a format specified by the format property.class
AbstractClassNameCheck
Ensures that the names of abstract classes conforming to some regular expression and check thatabstract
modifier exists.class
AbstractNameCheck
Abstract class for checking that names conform to a specified format.class
CatchParameterNameCheck
Checks thatcatch
parameter names conform to a format specified by the format property.class
ClassTypeParameterNameCheck
Checks that class type parameter names conform to a format specified by the format property.class
ConstantNameCheck
Checks that constant names conform to a format specified by the format property.class
InterfaceTypeParameterNameCheck
Checks that interface type parameter names conform to a format specified by the format property.class
LambdaParameterNameCheck
Check to verify lambda parameter names.class
LocalFinalVariableNameCheck
Checks that local final variable names conform to a format specified by the format property.class
LocalVariableNameCheck
Checks that local, non-final
variable names conform to a format specified by the format property.class
MemberNameCheck
Checks that instance variable names conform to a format specified by the format property.class
MethodNameCheck
Checks that method names conform to a format specified by the format property.class
MethodTypeParameterNameCheck
Checks that method type parameter names conform to a format specified by the format property.class
PackageNameCheck
Checks that package names conform to a format specified by the format property.class
ParameterNameCheck
Checks that method parameter names conform to a format specified by the format property.class
StaticVariableNameCheck
Checks thatstatic
, non-final
variable names conform to a format specified by the format property.class
TypeNameCheck
Checks that type names for classes, interfaces, enums, and annotations conform to a format specified by the format property. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.regexp
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.regexp Modifier and Type Class Description class
RegexpCheck
A check that makes sure that a specified pattern exists, exists less than a set number of times, or does not exist in the file.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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.sizes
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.sizes Modifier and Type Class Description class
AnonInnerLengthCheck
Checks for long anonymous inner classes.class
ExecutableStatementCountCheck
Restricts the number of executable statements to a specified limit.class
FileLengthCheck
Checks for long source files.class
LineLengthCheck
Checks for long lines.class
MethodCountCheck
Checks the number of methods declared in each type declaration by access modifier or total count.class
MethodLengthCheck
Checks for long methods and constructors.class
OuterTypeNumberCheck
Checks for the number of types declared at the outer (or root) level in a file.class
ParameterNumberCheck
Checks the number of parameters of a method or constructor. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.whitespace
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.whitespace Modifier and Type Class 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
GenericWhitespaceCheck
Checks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention.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
ParenPadCheck
Checks the policy on the padding of parentheses; i.e.class
SeparatorWrapCheck
Checks line wrapping with separators.class
SingleSpaceSeparatorCheck
Checks that non-whitespace characters are separated by no more than one whitespace.class
TypecastParenPadCheck
Checks the policy on the padding of parentheses for typecasts.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. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.filefilters
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.filefilters Modifier and Type Class Description class
BeforeExecutionExclusionFileFilter
File filterBeforeExecutionExclusionFileFilter
decides which files should be excluded from being processed by the utility. -
Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.filters
Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.filters Modifier and Type Class Description class
SeverityMatchFilter
FilterSeverityMatchFilter
decides audit events according to the severity level of the event.class
SuppressionCommentFilter
FilterSuppressionCommentFilter
uses pairs of comments to suppress audit events.class
SuppressionFilter
FilterSuppressionFilter
rejects audit events for Check violations according to a suppressions XML document in a file.class
SuppressionSingleFilter
FilterSuppressionSingleFilter
suppresses audit events for Checks violations in the specified file, class, checks, message, module id, lines, and columns.class
SuppressionXpathFilter
FilterSuppressionXpathFilter
works as SuppressionFilter.class
SuppressionXpathSingleFilter
FilterSuppressionXpathSingleFilter
suppresses audit events for Checks violations in the specified file, class, checks, message, module id, and xpath.class
SuppressWarningsFilter
FilterSuppressWarningsFilter
uses annotationSuppressWarnings
to suppress audit events.class
SuppressWithNearbyCommentFilter
FilterSuppressWithNearbyCommentFilter
uses nearby comments to suppress audit events.class
SuppressWithPlainTextCommentFilter
FilterSuppressWithPlainTextCommentFilter
uses plain text to suppress audit events.
-