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 and 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 Catches TreeWalkerAuditEvent 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 and 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 and Description
class	ArrayTypeStyleCheck Checks the style of array type definitions.
class	AvoidEscapedUnicodeCharactersCheck Restricts using Unicode escapes (such as \u221e).
class	DescendantTokenCheck Checks for restricted tokens beneath other tokens.
class	FinalParametersCheck Checks that parameters for methods, constructors, catch and for-each blocks are final.
class	NewlineAtEndOfFileCheck Checks whether files end with a line separator.
class	NoCodeInFileCheck Checks whether file contains code.
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 Checks for TODO: comments.
class	TrailingCommentCheck The check to ensure that requires that comments be the only thing on a line.
class	TranslationCheck Ensures the correct translation of code by checking property files for consistency regarding their keys.
class	UncommentedMainCheck Detects uncommented main methods.
class	UniquePropertiesCheck Detects duplicated keys in properties files.
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 and Description
class	AnnotationLocationCheck Checks location of annotation on language elements.
class	AnnotationOnSameLineCheck Checks that annotations are located on the same line with their targets.
class	AnnotationUseStyleCheck Checks the style of elements in annotations.
class	MissingDeprecatedCheck Verifies that the annotation @Deprecated and the Javadoc tag @deprecated are both present when either of them is present.
class	MissingOverrideCheck Verifies that the @Override annotation is present when the @inheritDoc javadoc tag is present.
class	PackageAnnotationCheck Checks that all package annotations are in the package-info.java file.
class	SuppressWarningsCheck Allows 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 and Description
class	AvoidNestedBlocksCheck Finds nested blocks (blocks that are used freely in the code).
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 code 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 and 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	AvoidDoubleBraceInitializationCheck Detects double brace initialization.
class	AvoidInlineConditionalsCheck Detects inline conditionals.
class	AvoidNoArgumentSuperConstructorCallCheck Checks if call to superclass constructor without arguments is present.
class	CovariantEqualsCheck Checks that classes which define a covariant equals() method also override method equals(Object).
class	DeclarationOrderCheck Checks that the parts of a class or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.
class	DefaultComesLastCheck Check that the default is after all the cases in a switch statement.
class	EmptyStatementCheck Detects empty statements (standalone ";" semicolon).
class	EqualsAvoidNullCheck Checks that any combination of String literals is on the left side of an equals() comparison.
class	EqualsHashCodeCheck Checks that classes that either override equals() or hashCode() 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 and char and false for boolean.
class	FallThroughCheck Checks for fall-through in switch 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 a catch statement.
class	IllegalInstantiationCheck Checks for illegal instantiations where a factory method is preferred.
class	IllegalThrowsCheck Checks that specified types are not declared to be thrown.
class	IllegalTokenCheck Checks for illegal tokens.
class	IllegalTokenTextCheck Checks specified tokens text for matching an illegal pattern.
class	IllegalTypeCheck Checks that particular classes or interfaces are never used.
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	ModifiedControlVariableCheck Checks 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 nested for blocks to a specified depth.
class	NestedIfDepthCheck Restricts nested if-else blocks to a specified depth.
class	NestedTryDepthCheck Restricts nested try-catch-finally blocks to a specified depth.
class	NoArrayTrailingCommaCheck Checks that array initialization do not contain a trailing comma.
class	NoCloneCheck Checks that the clone method is not overridden from the Object class.
class	NoEnumTrailingCommaCheck Checks that enum definition does not contain a trailing comma.
class	NoFinalizerCheck Checks that there is no method finalize with zero parameters.
class	OneStatementPerLineCheck Checks that there is only one statement per line.
class	OverloadMethodsDeclarationOrderCheck Checks that overloaded 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.
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	UnnecessaryParenthesesCheck Checks if unnecessary parentheses are used in a statement or expression.
class	UnnecessarySemicolonAfterOuterTypeDeclarationCheck Checks if unnecessary semicolon is used after type declaration.
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 and Description
class	DesignForExtensionCheck Checks that classes 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 Checks nested (internal) classes/interfaces are declared at the bottom of the primary (top-level) 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, enum or annotation resides in a source file of its own.
class	ThrowsCountCheck Restricts throws statements to a specified count.
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 and 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 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	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 and 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 and 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	JavadocContentLocationCheck Checks that the Javadoc content begins from the same position for all Javadoc comments in the project.
class	JavadocMethodCheck Checks the Javadoc of a method or constructor.
class	JavadocMissingWhitespaceAfterAsteriskCheck Checks that there is at least one whitespace after the leading asterisk.
class	JavadocPackageCheck Checks that each Java package has a Javadoc file used for commenting.
class	JavadocParagraphCheck Checks the Javadoc paragraph.
class	JavadocStyleCheck Validates Javadoc comments to help ensure they are well formed.
class	JavadocTagContinuationIndentationCheck Checks the indentation of the continuation lines in at-clauses.
class	JavadocTypeCheck Checks the Javadoc comments for annotation/enum/class/interface definitions.
class	JavadocVariableCheck Checks that a variable has a 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 in 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 Requires user defined Javadoc tag to be present in Javadoc comment with defined format.

Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.metrics

Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.metrics

Modifier and Type	Class and Description
class	AbstractClassCouplingCheck Base class for coupling calculation.
class	BooleanExpressionComplexityCheck Restricts the number of boolean operators (&&, ||, &, | and ^) in an expression.
class	ClassDataAbstractionCouplingCheck Measures the number of instantiations of other classes within the given class.
class	ClassFanOutComplexityCheck Checks 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 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.

Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.naming

Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.naming

Modifier and Type	Class and Description
class	AbbreviationAsWordInNameCheck Validates 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 specified pattern.
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	CatchParameterNameCheck Checks that catch parameter names conform to a specified pattern.
class	ClassTypeParameterNameCheck Checks that class type parameter names conform to a specified pattern.
class	ConstantNameCheck Checks that constant names conform to a specified pattern.
class	InterfaceTypeParameterNameCheck Checks that interface type parameter names conform to a specified pattern.
class	LambdaParameterNameCheck Checks lambda parameter names.
class	LocalFinalVariableNameCheck Checks that local final variable names conform to a specified pattern.
class	LocalVariableNameCheck Checks that local, non-final variable names conform to a specified pattern.
class	MemberNameCheck Checks that instance variable names conform to a specified pattern.
class	MethodNameCheck Checks that method names conform to a specified pattern.
class	MethodTypeParameterNameCheck Checks that method type parameter names conform to a specified pattern.
class	PackageNameCheck Checks that package names conform to a specified pattern.
class	ParameterNameCheck Checks that method parameter names conform to a specified pattern.
class	StaticVariableNameCheck Checks that static, non-final variable names conform to a specified pattern.
class	TypeNameCheck Checks that type names conform to a specified pattern.

Uses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.regexp

Subclasses of AutomaticBean in com.puppycrawl.tools.checkstyle.checks.regexp

Modifier and Type	Class and Description
class	RegexpCheck Checks that a specified pattern exists, exists less than a set number of times, or does not exist in the file.
class	RegexpMultilineCheck Checks that a specified pattern matches across multiple lines in any file type.
class	RegexpOnFilenameCheck Checks that a specified pattern matches based on file and/or folder path.
class	RegexpSinglelineCheck Checks that a specified pattern matches a single line in any file type.
class	RegexpSinglelineJavaCheck Checks that a specified pattern matches a single line 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 and 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 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 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 space is 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; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden.
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 and Description
class	BeforeExecutionExclusionFileFilter File filter BeforeExecutionExclusionFileFilter 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 and Description
class	SeverityMatchFilter Filter SeverityMatchFilter decides audit events according to the severity level of the event.
class	SuppressionCommentFilter Filter SuppressionCommentFilter uses pairs of comments to suppress audit events.
class	SuppressionFilter Filter SuppressionFilter rejects audit events for Check violations according to a suppressions XML document in a file.
class	SuppressionSingleFilter Filter SuppressionSingleFilter suppresses audit events for Checks violations in the specified file, class, checks, message, module id, lines, and columns.
class	SuppressionXpathFilter Filter SuppressionXpathFilter works as SuppressionFilter.
class	SuppressionXpathSingleFilter Filter SuppressionXpathSingleFilter suppresses audit events for Checks violations in the specified file, class, checks, message, module id, and xpath.
class	SuppressWarningsFilter Filter SuppressWarningsFilter uses annotation SuppressWarnings to suppress audit events.
class	SuppressWithNearbyCommentFilter Filter SuppressWithNearbyCommentFilter uses nearby comments to suppress audit events.
class	SuppressWithPlainTextCommentFilter Filter SuppressWithPlainTextCommentFilter uses plain text to suppress audit events.