Uses of Class
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
Packages that use AbstractAutomaticBean
Package
Description
Contains the implementation of the Checkstyle framework.
Contains the core API to be used to implement checks.
Contains the checks that are bundled with the main distribution.
Contains the Annotation checks that are
bundled with the main distribution.
Contains the Block checks that are
bundled with the main distribution.
Contains the Coding checks that are
bundled with the main distribution.
Contains the Class Design checks that
are bundled with the main distribution.
File Header checks.
Contains the Imports checks that are
bundled with the main distribution.
Contains all classes required for the
indentation check.
Contains the Javadoc checks that are bundled with the main distribution.
Contains the Metrics checks that are
bundled with the main distribution.
Contains the modifier checks that are bundled with the main distribution.
Contains the Naming conventions checks
that are bundled with the main distribution.
Contains the regular expression checks that are bundled with the main
distribution.
Contains the Size Violations checks
that are bundled with the main distribution.
Contains the Whitespace checks that
are bundled with the main distribution.
Contains the before execution file filters that are bundled with the main distribution.
Contains the filters that are bundled with the main distribution.
Contains module metadata generation classes for checkstyle.
Contains classes for generating the Checkstyle website.
-
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyleModifier and TypeClassDescriptionclassThis class provides the functionality to check a set of files.classGenerates suppressions.xml file, based on violations occurred.classSimple plain logger for text output.classSimple logger for metadata generator util.classSimple SARIF logger.final classResponsible for walking an abstract syntax tree and notifying interested checks at each node.classSimple XML logger.classCatchesTreeWalkerAuditEventand generates corresponding xpath query.classGenerates suppressions.xml file, based on violations occurred. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.api
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.apiModifier and TypeClassDescriptionclassThe base class for checks.classProvides common functionality for many FileSetChecks.classServes as an abstract base class for all modules that report inspection findings.classDeprecated.since 10.9.3. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checksModifier and TypeClassDescriptionclassChecks the style of array type definitions.classRestricts using Unicode escapes (such as \u221e).classChecks for restricted tokens beneath other tokens.classChecks that parameters for methods, constructors, catch and for-each blocks are final.classChecks whether files end with a line separator.classChecks whether file contains code.classDetects if keys in properties files are in correct order.classChecks that the outer type name and the file name match.classMaintains a set of check suppressions from@SuppressWarningsannotations.classChecks forTODO:comments.classThe check to ensure that lines with code do not end with comment.classEnsures the correct translation of code by checking property files for consistency regarding their keys.classDetects uncommentedmainmethods.classDetects duplicated keys in properties files.classChecks that long constants are defined with an upper ell. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.annotation
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.annotationModifier and TypeClassDescriptionclassChecks location of annotation on language elements.classChecks that annotations are located on the same line with their targets.final classChecks the style of elements in annotations.final classVerifies that the annotation@Deprecatedand the Javadoc tag@deprecatedare both present when either of them is present.final classVerifies that the@Overrideannotation is present when the@inheritDocjavadoc tag is present.classChecks that all package annotations are in the package-info.java file.classAllows to specify what warnings that@SuppressWarningsis not allowed to suppress. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.blocks
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.blocksModifier and TypeClassDescriptionclassFinds nested blocks (blocks that are used freely in the code).classChecks for empty blocks.classChecks for empty catch blocks.classChecks for the placement of left curly braces ('{') for code blocks.classChecks for braces around code blocks.classChecks the placement of right curly braces ('}') for code blocks. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.coding
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.codingModifier and TypeClassDescriptionclassAbstract class for checking that an overriding method with no parameters invokes the super method.classChecks that array initialization contains a trailing comma.classDetects double brace initialization.classDetects inline conditionals.final classChecks if call to superclass constructor without arguments is present.classChecks that all constructors are grouped together.classChecks that classes and records which define a covariantequals()method also override methodequals(Object).classChecks that the parts of a class, record, or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.classCheck that thedefaultis after all the cases in aswitchstatement.classDetects empty statements (standalone";"semicolon).classChecks that any combination of String literals is on the left side of anequals()comparison.classChecks that classes that either overrideequals()orhashCode()also overrides the other.classChecks if any class or object member is explicitly initialized to default for its type value (nullfor object references, zero for numeric types andcharandfalseforboolean.classChecks for fall-through inswitchstatements.classChecks that local variables that never have their values changed are declared final.classChecks that a local variable or a parameter does not shadow a field that is defined in the same class.final classChecks that certain exception types do not appear in acatchstatement.classChecks for illegal instantiations where a factory method is preferred.final classChecks that specified types are not declared to be thrown.classChecks for illegal tokens.classChecks specified tokens text for matching an illegal pattern.final classChecks that particular classes or interfaces are never used.classChecks for assignments in subexpressions, such as inString s = Integer.toString(i = 2);.classChecks that there are no "magic numbers" where a magic number is a numeric literal that is not defined as a constant.classEvaluates Xpath query and report violation on all matching AST nodes.classChecks that classes (except abstract ones) define a constructor and don't rely on the default one.classChecks that a given switch statement or expression that use a reference type in its selector expression has anullcase label.classChecks that switch statement has adefaultclause.final classChecks that for loop control variables are not modified inside the for block.classChecks for multiple occurrences of the same string literal within a single file.classChecks that each variable declaration is in its own statement and on its own line.final classRestricts nestedforblocks to a specified depth.final classRestricts nested if-else blocks to a specified depth.final classRestricts nested try-catch-finally blocks to a specified depth.classChecks that array initialization do not contain a trailing comma.classChecks that the clone method is not overridden from the Object class.classChecks that enum definition does not contain a trailing comma.classChecks that there is no methodfinalizewith zero parameters.final classChecks that there is only one statement per line.classChecks that overloaded methods are grouped together.final classEnsures that a class has a package declaration, and (optionally) whether the package name matches the directory name for the source file.final classDisallows assignment of parameters.classChecks for assignment of pattern variables.classChecks 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.final classRestricts the number of return statements in methods, constructors and lambda expressions.classChecks for over-complicated boolean expressions.classChecks for over-complicated boolean return or yield statements.classChecks that string literals are not used with==or!=.classChecks that an overridingclone()method invokessuper.clone().classChecks that an overridingfinalize()method invokessuper.finalize().classChecks for redundant null checks with the instanceof operator.classChecks if unnecessary parentheses are used in a statement or expression.final classChecks if unnecessary semicolon is used after type declaration.final classChecks if unnecessary semicolon is used after type member declaration.final classChecks if unnecessary semicolon is in enum definitions.final classChecks if unnecessary semicolon is used in last resource declaration.classEnsures that catch parameters that are not used are declared as an unnamed variable.classEnsures that lambda parameters that are not used are declared as an unnamed variable.classChecks that a local variable is declared and/or assigned, but not used.classChecks the distance between declaration of variable and its first usage.classEnsures thatwhenis used instead of a singleifstatement inside a case block. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.design
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.designModifier and TypeClassDescriptionclassChecks that classes are designed for extension (subclass creation).classEnsures that identifies classes that can be effectively declared as final are explicitly marked as final.classMakes sure that utility classes (classes that contain only static methods or fields in their API) do not have a public constructor.classChecks nested (internal) classes/interfaces are declared at the bottom of the primary (top-level) class after all init and static init blocks, method, constructor and field declarations.final classImplements Joshua Bloch, Effective Java, Item 17 - Use Interfaces only to define types.final classEnsures that exception classes (classes with names conforming to some pattern and explicitly extending classes with names conforming to other pattern) are immutable, that is, that they have only final fields.classChecks that each top-level class, interface, enum or annotation resides in a source file of its own.classChecks that sealed classes and interfaces have a permits list.final classRestricts throws statements to a specified count.classChecks visibility of class members. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.header
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.headerModifier and TypeClassDescriptionclassAbstract super class for header checks.classChecks that a source file begins with a specified header.classChecks the header of a source file against multiple header files that contain a pattern for each line of the source header.classChecks the header of a source file against a header that contains a pattern for each line of the source header. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.imports
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.importsModifier and TypeClassDescriptionclassChecks that there are no import statements that use the*notation.classChecks that there are no static import statements.classChecks that the groups of import declarations appear in the order specified by the user.classChecks for imports from a set of illegal packages.classControls what can be imported in each package and file.classChecks the ordering/grouping of imports.classChecks for redundant import statements.classChecks for unused import statements. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.indentation
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.indentationModifier and TypeClassDescriptionclassControls the indentation between comments and surrounding code.classChecks correct indentation of Java code. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.javadoc
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.javadocModifier and TypeClassDescriptionclassBase class for Checks that process Javadoc comments.classChecks the order of javadoc block-tags or javadoc tags.classChecks that Javadocs are located at the correct position.classChecks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space.classChecks that the Javadoc content begins from the same position for all Javadoc comments in the project.classChecks the alignment of leading asterisks in a Javadoc comment.classChecks the Javadoc of a method or constructor.classChecks if the javadoc has leading asterisks on each line.classChecks that there is at least one whitespace after the leading asterisk.classChecks that each Java package has a Javadoc file used for commenting.classChecks the Javadoc paragraph.classValidates Javadoc comments to help ensure they are well formed.classChecks the indentation of the continuation lines in block tags.classChecks the Javadoc comments for type definitions.classChecks that a variable has a Javadoc comment.classChecks for missing Javadoc comments for a method or constructor.classChecks for missing package definition Javadoc comments in package-info.java files.classChecks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.classChecks that the block tag is followed by description.classChecks that one blank line before the block tag if it is present in Javadoc.classChecks that a Javadoc block can fit in a single-line and doesn't contain block tags.classChecks that Javadoc summary sentence does not contain phrases that are not recommended to use.classRequires user defined Javadoc tag to be present in Javadoc comment with defined format. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.metrics
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.metricsModifier and TypeClassDescriptionclassBase class for coupling calculation.final classRestricts the number of boolean operators (&&,||,&,|and^) in an expression.final classMeasures the number of distinct classes that are instantiated within the given class or record.final classChecks the number of other types a given class/record/interface/enum/annotation relies on.classChecks cyclomatic complexity against a specified limit.classDetermines complexity of methods, classes and files by counting the Non Commenting Source Statements (NCSS).final classChecks the NPATH complexity against a specified limit. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.modifier
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.modifierModifier and TypeClassDescriptionclassChecks for implicit modifiers on nested types in classes and records.classChecks for implicit modifiers on interface members and nested types.classChecks 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.classChecks for redundant modifiers. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.naming
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.namingModifier and TypeClassDescriptionclassValidates abbreviations (consecutive capital letters) length in identifier name, it also allows to enforce camel case naming.classAbstract class for checking a class member (field/method)'s name conforms to a specified pattern.final classEnsures that the names of abstract classes conforming to some pattern and check thatabstractmodifier exists.classAbstract class for checking that names conform to a specified format.classChecks thatcatchparameter names conform to a specified pattern.classChecks that class type parameter names conform to a specified pattern.classChecks that constant names conform to a specified pattern.classChecks identifiers against a regular expression pattern to detect illegal names.classChecks that interface type parameter names conform to a specified pattern.classChecks lambda parameter names.classChecks that local final variable names conform to a specified pattern.classChecks that local, non-finalvariable names conform to a specified pattern.classChecks that instance variable names conform to a specified pattern.classChecks that method names conform to a specified pattern.classChecks that method type parameter names conform to a specified pattern.classChecks that package names conform to a specified pattern.classChecks that method parameter names conform to a specified pattern.classChecks that pattern variable names conform to a specified pattern.classChecks that record component names conform to a specified pattern.classChecks that record type parameter names conform to a specified pattern.classChecks thatstatic, non-finalvariable names conform to a specified pattern.classChecks that type names conform to a specified pattern. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.regexp
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.regexpModifier and TypeClassDescriptionclassChecks that a specified pattern exists, exists less than a set number of times, or does not exist in the file.classChecks that a specified pattern matches across multiple lines in any file type.classChecks that a specified pattern matches based on file and/or folder path.classChecks that a specified pattern matches a single-line in any file type.classChecks that a specified pattern matches a single-line in Java files. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.sizes
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.sizesModifier and TypeClassDescriptionclassChecks for long anonymous inner classes.final classRestricts the number of executable statements to a specified limit.classChecks for long source files.classChecks lambda body length.classChecks for long lines.final classChecks the number of methods declared in each type declaration by access modifier or total count.classChecks for long methods and constructors.classChecks for the number of types declared at the outer (or root) level in a file.classChecks the number of parameters of a method or constructor.classChecks the number of record components in the header of a record definition. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.whitespace
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.checks.whitespaceModifier and TypeClassDescriptionclassAbstract class for checking the padding of parentheses.classChecks 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.classChecks 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.classChecks for empty line separators before package, all import declarations, fields, constructors, methods, nested classes, static initializers and instance initializers.classChecks that there are no tab characters ('\t') in the source code.classChecks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention.classChecks the padding between the identifier of a method definition, constructor definition, method call, constructor invocation, record, or record pattern; and the left parenthesis of the parameter list.classChecks that chosen statements are not line-wrapped.classChecks that there is no whitespace after a token.classChecks that there is no whitespace before the colon in a switch block.classChecks that there is no whitespace before a token.classChecks the policy on how to wrap lines on operators.classChecks 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.classChecks line wrapping with separators.classChecks that non-whitespace characters are separated by no more than one whitespace.classChecks the policy on the padding of parentheses for typecasts.classChecks 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.classChecks that a token is surrounded by whitespace. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.filefilters
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.filefiltersModifier and TypeClassDescriptionfinal classFile filterBeforeExecutionExclusionFileFilterdecides which files should be excluded from being processed by the utility. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.filters
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.filtersModifier and TypeClassDescriptionclassFilterSeverityMatchFilterdecides audit events according to the severity level of the event.classFilterSuppressionCommentFilteruses pairs of comments to suppress audit events.classFilterSuppressionFilterrejects audit events for Check violations according to a suppressions XML document in a file.classFilterSuppressionSingleFiltersuppresses audit events for Checks violations in the specified file, class, checks, message, module id, lines, and columns.classFilterSuppressionXpathFilterworks as SuppressionFilter.classFilterSuppressionXpathSingleFiltersuppresses audit events for Checks violations in the specified file, class, checks, message, module id, and xpath.classFilterSuppressWarningsFilteruses annotation@SuppressWarningsto suppress audit events.classFilterSuppressWithNearbyCommentFilteruses nearby comments to suppress audit events.classFilterSuppressWithNearbyTextFilteruses plain text to suppress nearby audit events.classFilterSuppressWithPlainTextCommentFilteruses plain text to suppress audit events. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.meta
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.metaModifier and TypeClassDescriptionclassClass for scraping module metadata from the corresponding class' class-level javadoc. -
Uses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.site
Subclasses of AbstractAutomaticBean in com.puppycrawl.tools.checkstyle.siteModifier and TypeClassDescriptionclassClass for scraping class javadoc and all property setter javadocs from the given checkstyle module.