All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
| Class |
Description |
| AbbreviationAsWordInNameCheck |
The Check validate abbreviations(consecutive capital letters) length in
identifier name, it also allows to enforce camel case naming.
|
| AbstractAccessControlNameCheck |
Abstract class for checking a class member (field/method)'s name conforms to
a format specified by the format property.
|
| AbstractCheck |
The base class for checks.
|
| AbstractClassCouplingCheck |
Base class for coupling calculation.
|
| AbstractClassNameCheck |
Ensures that the names of abstract classes conforming to some regular
expression and check that abstract modifier exists.
|
| AbstractExpressionHandler |
Abstract base class for all handlers.
|
| AbstractFileSetCheck |
Provides common functionality for many FileSetChecks.
|
| AbstractHeaderCheck |
Abstract super class for header checks.
|
| AbstractJavadocCheck |
Base class for Checks that process Javadoc comments.
|
| AbstractNameCheck |
Abstract class for checking that names conform to a specified format.
|
| AbstractNode |
Represents general class for ElementNode, RootNode and AttributeNode.
|
| AbstractParenPadCheck |
Abstract class for checking the padding of parentheses.
|
| AbstractSuperCheck |
Abstract class for checking that an overriding method with no parameters
invokes the super method.
|
| AbstractTypeAwareCheck |
Deprecated.
|
| AbstractTypeAwareCheck.AbstractClassInfo |
Contains class's Token.
|
| AbstractTypeAwareCheck.Token |
Represents text element with location in the text.
|
| AbstractTypeParameterNameCheck |
Deprecated.
|
| AbstractViolationReporter |
Serves as an abstract base class for all modules that report inspection
findings.
|
| AccessModifier |
This enum represents access modifiers.
|
| AnnotationLocationCheck |
Check location of annotation on language elements.
|
| AnnotationOnSameLineCheck |
The check does verifying that annotations are located on the same line with their targets.
|
| AnnotationUseStyleCheck |
This check controls the style with the usage of annotations.
|
| AnnotationUseStyleCheck.ClosingParens |
Defines the two styles for defining
elements in an annotation.
|
| AnnotationUseStyleCheck.ElementStyle |
Defines the styles for defining elements in an annotation.
|
| AnnotationUseStyleCheck.TrailingArrayComma |
Defines the two styles for defining
elements in an annotation.
|
| AnnotationUtil |
Contains utility methods designed to work with annotations.
|
| AnonInnerLengthCheck |
Checks for long anonymous inner classes.
|
| ArrayInitHandler |
Handler for array initialization blocks.
|
| ArrayTrailingCommaCheck |
Checks if array initialization contains optional trailing comma.
|
| ArrayTypeStyleCheck |
Checks the style of array type definitions.
|
| AstTreeStringPrinter |
Class for printing AST to String.
|
| AtclauseOrderCheck |
|
| AttributeNode |
Represents attribute of the element.
|
| AuditEvent |
Raw event for audit.
|
| AuditEventDefaultFormatter |
Represents the default formatter for log message.
|
| AuditEventFormatter |
Represents the formatter interface for log message.
|
| AuditListener |
Listener in charge of receiving events from the Checker.
|
| AutomaticBean |
A Java Bean that implements the component lifecycle interfaces by
calling the bean's setters for all configuration attributes.
|
| AutomaticBean.OutputStreamOptions |
Enum to specify behaviour regarding ignored modules.
|
| AvoidEscapedUnicodeCharactersCheck |
|
| AvoidInlineConditionalsCheck |
Detects inline conditionals.
|
| AvoidNestedBlocksCheck |
Finds nested blocks.
|
| AvoidStarImportCheck |
Check that finds import statements that use the * notation.
|
| AvoidStaticImportCheck |
Check that finds static imports.
|
| BaseCellEditor |
A base class for CellEditors, providing default implementations for all
methods in the CellEditor interface and support for managing a series
of listeners.
|
| BeforeExecutionExclusionFileFilter |
File filter BeforeExecutionExclusionFileFilter decides which files should be
excluded from being processed by the utility.
|
| BeforeExecutionFileFilter |
An interface for before execution file filtering events.
|
| BeforeExecutionFileFilterSet |
A before execution file filter set applies filters to events.
|
| BlockCommentPosition |
Utility class that has methods to check javadoc comment position in java file.
|
| BlockOption |
Represents the policy for checking block statements.
|
| BlockParentHandler |
Handler for parents of blocks ('if', 'else', 'while', etc).
|
| BlockTagUtil |
Tools for parsing block tags from a Javadoc comment.
|
| BooleanExpressionComplexityCheck |
Restricts nested boolean operators (&&, ||, &, | and ^) to
a specified depth (default = 3).
|
| CaseHandler |
Handler for case statements.
|
| CatchHandler |
Handler for catch blocks.
|
| CatchParameterNameCheck |
Checks that catch parameter names conform to a format specified by the format property.
|
| Checker |
This class provides the functionality to check a set of files.
|
| CheckstyleAntTask |
An implementation of a ANT task for calling checkstyle.
|
| CheckstyleAntTask.Formatter |
Details about a formatter to be used.
|
| CheckstyleAntTask.FormatterType |
Poor mans enumeration for the formatter types.
|
| CheckstyleAntTask.Listener |
Represents a custom listener.
|
| CheckstyleAntTask.Property |
Represents a property that consists of a key and value.
|
| CheckstyleException |
Represents an error condition within Checkstyle.
|
| CheckUtil |
Contains utility methods for the checks.
|
| ClassDataAbstractionCouplingCheck |
This metric measures the number of instantiations of other classes
within the given class.
|
| ClassDefHandler |
Handler for class definitions.
|
| ClassFanOutComplexityCheck |
The number of other classes a given class relies on.
|
| ClassResolver |
Utility class to resolve a class name to an actual class.
|
| ClassTypeParameterNameCheck |
Checks that class type parameter names conform to a format specified
by the format property.
|
| CodeSelector |
Helper class to select a code.
|
| CodeSelectorPresentation |
Presentation model for CodeSelector.
|
| Comment |
Representation of the comment block.
|
| CommentListener |
This interface is used to be notified by parser about comments
in the parsed code.
|
| CommentsIndentationCheck |
This Check controls the indentation between comments and surrounding code.
|
| CommonUtil |
Contains utility methods.
|
| Configurable |
A component that can be configured.
|
| Configuration |
A Configuration is used to configure a Configurable component.
|
| ConfigurationLoader |
Loads a configuration from a standard configuration XML file.
|
| ConfigurationLoader.IgnoredModulesOptions |
Enum to specify behaviour regarding ignored modules.
|
| ConstantNameCheck |
Checks that constant names conform to a format specified
by the format property.
|
| Context |
A context to be used in subcomponents.
|
| Contextualizable |
A Component that needs context information from it's container(parent object) to work.
|
| CovariantEqualsCheck |
Checks that if a class defines a covariant method equals,
then it defines method equals(java.lang.Object).
|
| CustomImportOrderCheck |
Checks that the groups of import declarations appear in the order specified
by the user.
|
| CyclomaticComplexityCheck |
Checks cyclomatic complexity against a specified limit.
|
| DeclarationOrderCheck |
|
| DefaultComesLastCheck |
Check that the default is after all the cases
in a switch statement.
|
| DefaultConfiguration |
Default implementation of the Configuration interface.
|
| DefaultContext |
A default implementation of the Context interface.
|
| DefaultLogger |
Simple plain logger for text output.
|
| Definitions |
Contains constant definitions common to the package.
|
| DescendantTokenCheck |
Checks for restricted tokens beneath other tokens.
|
| DesignForExtensionCheck |
The check finds classes that are designed for extension (subclass creation).
|
| DetailAST |
An extension of the CommonAST that records the line and column number.
|
| DetailNode |
DetailNode is used to construct tree during parsing Javadoc comments.
|
| DetailNodeTreeStringPrinter |
Parses file as javadoc DetailNode tree and prints to system output stream.
|
| DetectorOptions |
Options for a detector.
|
| DoWhileHandler |
Handler for do...while blocks.
|
| ElementNode |
Represents element node of Xpath-tree.
|
| ElseHandler |
Handler for else blocks.
|
| EmptyBlockCheck |
Checks for empty blocks.
|
| EmptyCatchBlockCheck |
Checks for empty catch blocks.
|
| 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.
|
| 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.
|
| EmptyLineSeparatorCheck |
Checks for empty line separators after header, package, all import declarations,
fields, constructors, methods, nested classes,
static initializers and instance initializers.
|
| EmptyStatementCheck |
Detects empty statements (standalone ';').
|
| EqualsAvoidNullCheck |
Checks that any combination of String literals
is on the left side of an equals() comparison.
|
| EqualsHashCodeCheck |
Checks that classes that either override equals() or hashCode() also
overrides the other.
|
| ExecutableStatementCountCheck |
Restricts the number of executable statements to a specified limit
(default = 30).
|
| 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.
|
| ExternalResourceHolder |
The following interface should be implemented by each module (inheritor of
AbstractCheck, implementor of FileSetCheck, or Filter) which uses
external resources of any kind for its configuration. |
| 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.
|
| FileContents |
Represents the contents of a file.
|
| FileLengthCheck |
Checks for long source files.
|
| FileSetCheck |
Interface for Checking a set of files for some criteria.
|
| FileStatefulCheck |
This annotation means that the check contains file-related context and therefore
cannot be used from the others threads at the same time.
|
| FileTabCharacterCheck |
Checks to see if a file contains a tab character.
|
| FileText |
Represents the text contents of a file of arbitrary plain text type.
|
| Filter |
An interface for filtering AuditEvents.
|
| FilterSet |
A filter set applies filters to AuditEvents.
|
| FilterUtil |
Utility methods for suppression filters.
|
| FinalClassCheck |
Checks that class which has only private ctors
is declared as final.
|
| FinalLocalVariableCheck |
Ensures that local variables that never get their values changed,
must be declared final.
|
| FinallyHandler |
Handler for finally blocks.
|
| FinalParametersCheck |
Check that method/constructor/catch/foreach parameters are final.
|
| ForHandler |
Handler for for loops.
|
| FullIdent |
Represents a full identifier, including dots, with associated
position information.
|
| GeneratedJavaLexer |
|
| GeneratedJavaRecognizer |
Java 1.5 Recognizer
This grammar is in the PUBLIC DOMAIN
|
| GeneratedJavaTokenTypes |
|
| GenericWhitespaceCheck |
Checks that the whitespace around the Generic tokens (angle brackets)
"<" and ">" are correct to the typical convention.
|
| GlobalStatefulCheck |
This annotation means that the check contains global context,
which will be updated while Checkstyle processes files.
|
| HandlerFactory |
Factory for handlers.
|
| HeaderCheck |
Checks the header of the source against a fixed header file.
|
| HiddenFieldCheck |
Checks that a local variable or a parameter does not shadow
a field that is defined in the same class.
|
| HideUtilityClassConstructorCheck |
Make sure that utility classes (classes that contain only static methods)
do not have a public constructor.
|
| IfHandler |
Handler for if statements.
|
| IllegalCatchCheck |
Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException
is almost never acceptable.
|
| IllegalImportCheck |
Checks for imports from a set of illegal packages.
|
| IllegalInstantiationCheck |
Checks for illegal instantiations where a factory method is preferred.
|
| IllegalThrowsCheck |
Throwing java.lang.Error or java.lang.RuntimeException
is almost never acceptable.
|
| IllegalTokenCheck |
Checks for illegal tokens.
|
| IllegalTokenTextCheck |
Checks for illegal token text.
|
| IllegalTypeCheck |
Checks that particular classes or interfaces are never used.
|
| ImportControlCheck |
Check that controls what can be imported in each package and file.
|
| ImportHandler |
Handler for import statements.
|
| ImportOrderCheck |
Checks the ordering/grouping of imports.
|
| ImportOrderOption |
Represents the policy for checking import order statements.
|
| IndentationCheck |
Checks correct indentation of Java Code.
|
| IndentLevel |
Encapsulates representation of notion of expected indentation levels.
|
| IndexHandler |
Handler for array index operation.
|
| InlineTagUtil |
Tools for extracting inline tags from Javadoc comments.
|
| InnerAssignmentCheck |
Checks for assignments in subexpressions, such as in
String s = Integer.toString(i = 2);.
|
| InnerTypeLastCheck |
Check nested (internal) classes/interfaces are declared at the bottom of the
class after all method and field declarations.
|
| InterfaceIsTypeCheck |
Implements Bloch, Effective Java, Item 17 -
Use Interfaces only to define types.
|
| InterfaceMemberImpliedModifierCheck |
Checks for implicit modifiers on interface members and nested types.
|
| InterfaceTypeParameterNameCheck |
Checks that interface type parameter names conform to a format specified
by the format property.
|
| InvalidJavadocTag |
Value object for storing data about an invalid Javadoc validTags.
|
| JavadocDetailNodeParser |
Used for parsing Javadoc comment as DetailNode tree.
|
| JavadocDetailNodeParser.ParseErrorMessage |
Contains information about parse error message.
|
| JavadocDetailNodeParser.ParseStatus |
Contains result of parsing javadoc comment: DetailNode tree and parse
error message.
|
| JavadocLexer |
|
| JavadocMethodCheck |
Checks the Javadoc of a method or constructor.
|
| JavadocNodeImpl |
Implementation of DetailNode interface that is mutable.
|
| JavadocPackageCheck |
Checks that all packages have a package documentation.
|
| 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.
|
| JavadocParser |
|
| JavadocParser.AreaTagContext |
|
| JavadocParser.AttributeContext |
|
| JavadocParser.BasefontTagContext |
|
| JavadocParser.BaseTagContext |
|
| JavadocParser.BodyContext |
|
| JavadocParser.BodyTagEndContext |
|
| JavadocParser.BodyTagStartContext |
|
| JavadocParser.BrTagContext |
|
| JavadocParser.ColgroupContext |
|
| JavadocParser.ColgroupTagEndContext |
|
| JavadocParser.ColgroupTagStartContext |
|
| JavadocParser.ColTagContext |
|
| JavadocParser.DdContext |
|
| JavadocParser.DdTagEndContext |
|
| JavadocParser.DdTagStartContext |
|
| JavadocParser.DescriptionContext |
|
| JavadocParser.DtContext |
|
| JavadocParser.DtTagEndContext |
|
| JavadocParser.DtTagStartContext |
|
| JavadocParser.EmbedTagContext |
|
| JavadocParser.EmptyTagContext |
|
| JavadocParser.FrameTagContext |
|
| JavadocParser.HeadContext |
|
| JavadocParser.HeadTagEndContext |
|
| JavadocParser.HeadTagStartContext |
|
| JavadocParser.HrTagContext |
|
| JavadocParser.HtmlCommentContext |
|
| JavadocParser.HtmlContext |
|
| JavadocParser.HtmlElementContext |
|
| JavadocParser.HtmlElementEndContext |
|
| JavadocParser.HtmlElementStartContext |
|
| JavadocParser.HtmlTagContext |
|
| JavadocParser.HtmlTagEndContext |
|
| JavadocParser.HtmlTagStartContext |
|
| JavadocParser.ImgTagContext |
|
| JavadocParser.InputTagContext |
|
| JavadocParser.IsindexTagContext |
|
| JavadocParser.JavadocContext |
|
| JavadocParser.JavadocInlineTagContext |
|
| JavadocParser.JavadocTagContext |
|
| JavadocParser.KeygenTagContext |
|
| JavadocParser.LiContext |
|
| JavadocParser.LinkTagContext |
|
| JavadocParser.LiTagEndContext |
|
| JavadocParser.LiTagStartContext |
|
| JavadocParser.MetaTagContext |
|
| JavadocParser.OptgroupContext |
|
| JavadocParser.OptgroupTagEndContext |
|
| JavadocParser.OptgroupTagStartContext |
|
| JavadocParser.OptionContext |
|
| JavadocParser.OptionTagEndContext |
|
| JavadocParser.OptionTagStartContext |
|
| JavadocParser.ParagraphContext |
|
| JavadocParser.ParametersContext |
|
| JavadocParser.ParamTagContext |
|
| JavadocParser.PTagEndContext |
|
| JavadocParser.PTagStartContext |
|
| JavadocParser.RbContext |
|
| JavadocParser.RbTagEndContext |
|
| JavadocParser.RbTagStartContext |
|
| JavadocParser.ReferenceContext |
|
| JavadocParser.RpContext |
|
| JavadocParser.RpTagEndContext |
|
| JavadocParser.RpTagStartContext |
|
| JavadocParser.RtcContext |
|
| JavadocParser.RtContext |
|
| JavadocParser.RtcTagEndContext |
|
| JavadocParser.RtcTagStartContext |
|
| JavadocParser.RtTagEndContext |
|
| JavadocParser.RtTagStartContext |
|
| JavadocParser.SingletonElementContext |
|
| JavadocParser.SingletonTagNameContext |
|
| JavadocParser.SourceTagContext |
|
| JavadocParser.TbodyContext |
|
| JavadocParser.TbodyTagEndContext |
|
| JavadocParser.TbodyTagStartContext |
|
| JavadocParser.TdContext |
|
| JavadocParser.TdTagEndContext |
|
| JavadocParser.TdTagStartContext |
|
| JavadocParser.TextContext |
|
| JavadocParser.TfootContext |
|
| JavadocParser.TfootTagEndContext |
|
| JavadocParser.TfootTagStartContext |
|
| JavadocParser.ThContext |
|
| JavadocParser.TheadContext |
|
| JavadocParser.TheadTagEndContext |
|
| JavadocParser.TheadTagStartContext |
|
| JavadocParser.ThTagEndContext |
|
| JavadocParser.ThTagStartContext |
|
| JavadocParser.TrackTagContext |
|
| JavadocParser.TrContext |
|
| JavadocParser.TrTagEndContext |
|
| JavadocParser.TrTagStartContext |
|
| JavadocParser.WbrTagContext |
|
| JavadocParser.WrongSingletonTagContext |
|
| JavadocPropertiesGenerator |
This class is used internally in the build process to write a property file
with short descriptions (the first sentences) of TokenTypes constants.
|
| JavadocStyleCheck |
Custom Checkstyle Check to validate Javadoc.
|
| JavadocTag |
Represents a Javadoc tag.
|
| JavadocTagContinuationIndentationCheck |
Checks the indentation of the continuation lines in at-clauses.
|
| JavadocTagInfo |
This enum defines the various Javadoc tags and there properties.
|
| JavadocTagInfo.Type |
The Javadoc Type.
|
| JavadocTags |
Value object for combining the list of valid validTags with information
about invalid validTags encountered in a certain Javadoc comment.
|
| JavadocTokenTypes |
Contains the constants for all the tokens contained in the Abstract
Syntax Tree for the javadoc grammar.
|
| JavadocTypeCheck |
Checks the Javadoc of a type.
|
| JavadocUtil |
Contains utility methods for working with Javadoc.
|
| JavadocUtil.JavadocTagType |
The type of Javadoc tag we want returned.
|
| JavadocVariableCheck |
Checks that a variable has Javadoc comment.
|
| JavaNCSSCheck |
This check calculates the Non Commenting Source Statements (NCSS) metric for
java source files and methods.
|
| JavaParser |
Helper methods to parse java source files.
|
| JavaParser.Options |
Enum to be used for test if comments should be used.
|
| LabelHandler |
Handler for labels.
|
| LambdaHandler |
Handler for lambda expressions.
|
| LambdaParameterNameCheck |
Check to verify lambda parameter names.
|
| LeftCurlyCheck |
Checks the placement of left curly braces.
|
| LeftCurlyOption |
Represents the options for placing the left curly brace '{'.
|
| LineColumn |
Immutable line and column numbers.
|
| LineLengthCheck |
Checks for long lines.
|
| LineSeparatorOption |
Represents the options for line separator settings.
|
| LineSet |
Represents a set of lines.
|
| LineWrappingHandler |
This class checks line-wrapping into definitions and expressions.
|
| LineWrappingHandler.LineWrappingOptions |
Enum to be used for test if first line's indentation should be checked or not.
|
| LocalFinalVariableNameCheck |
Checks that local final variable names conform to a format specified
by the format property.
|
| LocalizedMessage |
Represents a message that can be localised.
|
| LocalizedMessage.Utf8Control |
Custom ResourceBundle.Control implementation which allows explicitly read
the properties files as UTF-8.
|
| LocalVariableNameCheck |
Checks that local, non-final variable names conform to a format specified
by the format property.
|
| MagicNumberCheck |
Checks that there are no
"magic numbers" where a magic
number is a numeric literal that is not defined as a constant. |
| Main |
Entry point for starting the checkstyle GUI.
|
| Main |
Wrapper command line program for the Checker.
|
| MainFrame |
Displays information about a parse tree.
|
| MainFrameModel |
Model for checkstyle frame.
|
| MainFrameModel.ParseMode |
Parsing modes which available in GUI.
|
| MatchSuppressor |
Represents a suppressor for matches.
|
| MemberDefHandler |
Handler for member definitions.
|
| MemberNameCheck |
Checks that instance variable names conform to a format specified
by the format property.
|
| MessageDispatcher |
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
|
| MethodCallHandler |
Handler for method calls.
|
| MethodCountCheck |
Checks the number of methods declared in each type declaration by access
modifier or total count.
|
| MethodDefHandler |
Handler for method definitions.
|
| MethodLengthCheck |
Checks for long methods.
|
| MethodNameCheck |
Checks that method names conform to a format specified
by the format property.
|
| 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.
|
| MethodTypeParameterNameCheck |
Checks that method type parameter names conform to a format specified
by the format property.
|
| MismatchStrategy |
Represents the strategy when none of the rules (allow/disallow tags) match
inside subpackage and import-control tag of ImportControlCheck config.
|
| MissingCtorCheck |
Checks that classes (except abstract one) define a ctor and don't rely
on the default one.
|
| MissingDeprecatedCheck |
This class is used to verify that both the
Deprecated annotation
and the deprecated javadoc tag are present when
either one is present.
|
| MissingOverrideCheck |
This class is used to verify that the Override
annotation is present when the inheritDoc javadoc tag is present.
|
| MissingSwitchDefaultCheck |
Checks that switch statement has "default" clause.
|
| ModifiedControlVariableCheck |
Check for ensuring that for loop control variables are not modified
inside the for block.
|
| ModifierOrderCheck |
|
| ModuleFactory |
A module factory creates Objects from a given name.
|
| ModuleReflectionUtil |
Contains utility methods for module reflection.
|
| MultipleStringLiteralsCheck |
Checks for multiple occurrences of the same string literal within a
single file.
|
| MultipleVariableDeclarationsCheck |
Checks that each variable declaration is in its own statement
and on its own line.
|
| MutableExceptionCheck |
Ensures that exceptions (classes with names conforming to some regular
expression and explicitly extending classes with names conforming to other
regular expression) are immutable.
|
| NeedBracesCheck |
Checks for braces around code blocks.
|
| NestedForDepthCheck |
Check the number of nested for -statements.
|
| NestedIfDepthCheck |
Restricts nested if-else blocks to a specified depth (default = 1).
|
| NestedTryDepthCheck |
Restricts nested try-catch-finally blocks to a specified depth (default = 1).
|
| NeverSuppress |
|
| NewHandler |
Handler for operator new.
|
| NewlineAtEndOfFileCheck |
Checks that there is a newline at the end of each file.
|
| NoCloneCheck |
Checks that the clone method is not overridden from the
Object class.
|
| NoFinalizerCheck |
Checks that no method having zero parameters is defined
using the name finalize.
|
| NoLineWrapCheck |
Checks that chosen statements are not line-wrapped.
|
| NonEmptyAtclauseDescriptionCheck |
Checks that the at-clause tag is followed by description .
|
| NoWhitespaceAfterCheck |
Checks that there is no whitespace after a token.
|
| NoWhitespaceBeforeCheck |
Checks that there is no whitespace before a token.
|
| NPathComplexityCheck |
Checks the npath complexity against a specified limit (default = 200).
|
| ObjectBlockHandler |
Handler for inner classes.
|
| OneStatementPerLineCheck |
Restricts the number of statements per line to one.
|
| OneTopLevelClassCheck |
Checks that each top-level class, interface
or enum resides in a source file of its own.
|
| OperatorWrapCheck |
Checks line wrapping for operators.
|
| OuterTypeFilenameCheck |
Checks that the outer type name and the file name match.
|
| OuterTypeNumberCheck |
Checks for the number of defined types at the "outer" level.
|
| OverloadMethodsDeclarationOrderCheck |
Checks that overload methods are grouped together.
|
| PackageAnnotationCheck |
This check makes sure that all package annotations are in the
package-info.java file.
|
| PackageDeclarationCheck |
Ensures there is a package declaration.
|
| PackageDefHandler |
Handler for package definitions.
|
| PackageNameCheck |
Checks that package names conform to a format specified
by the format property.
|
| PackageNamesLoader |
Loads a list of package names from a package name XML file.
|
| PackageObjectFactory |
A factory for creating objects from package names and names.
|
| PackageObjectFactory.ModuleLoadOption |
Enum class to define loading options.
|
| PadOption |
Represents the options for whitespace around parentheses.
|
| ParameterAssignmentCheck |
Disallow assignment of parameters.
|
| ParameterNameCheck |
Checks that method parameter names conform to a format specified
by the format property.
|
| ParameterNumberCheck |
Checks the number of parameters that a method or constructor has.
|
| ParenPadCheck |
Checks 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.
|
| ParseTreeTableModel |
The model that backs the parse tree in the GUI.
|
| ParseTreeTablePresentation |
The model that backs the parse tree in the GUI.
|
| PrimordialHandler |
A default no-op handler.
|
| PropertiesExpander |
Resolves external properties from an
underlying Properties object.
|
| PropertyResolver |
Resolves properties in module configurations.
|
| RedundantImportCheck |
Checks for imports that are redundant.
|
| 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.
|
| RegexpCheck |
A check that makes sure that a specified pattern exists (or not) in the file.
|
| RegexpHeaderCheck |
Checks the header of the source against a header file that contains a
regular expression
for each line of the source header.
|
| RegexpMultilineCheck |
Implementation of a check that looks that matches across multiple lines in
any file type.
|
| RegexpOnFilenameCheck |
Implementation of a check that looks for a file name and/or path match (or
mis-match) against specified patterns.
|
| RegexpSinglelineCheck |
Implementation of a check that looks for a single line in any file type.
|
| RegexpSinglelineJavaCheck |
Implementation of a check that looks for a single line in Java files.
|
| RequireThisCheck |
Checks that code doesn't rely on the "this" default.
|
| RequireThisCheck.CatchFrame |
A frame initiated on entering a catch block; holds local catch variable names.
|
| RequireThisCheck.ForFrame |
A frame initiated on entering a for block; holds local for variable names.
|
| ReturnCountCheck |
Restricts the number of return statements in methods, constructors and lambda expressions
(2 by default).
|
| RightCurlyCheck |
Checks the placement of right curly braces.
|
| RightCurlyOption |
Represents the options for placing the right curly brace '}'.
|
| RootModule |
The first module that is run as part of Checkstyle and controls its entire
behavior and children.
|
| RootNode |
Represents root node of Xpath-tree.
|
| Scope |
Represents a Java visibility scope.
|
| ScopeUtil |
Contains utility methods for working on scope.
|
| SeparatorWrapCheck |
Checks line wrapping with separators.
|
| SeverityLevel |
Severity level for a check violation.
|
| SeverityLevelCounter |
An audit listener that counts how many AuditEvents
of a given severity have been generated. |
| SeverityMatchFilter |
This is a very simple filter based on severity matching.
|
| SimplifyBooleanExpressionCheck |
Checks for overly complicated boolean expressions.
|
| SimplifyBooleanReturnCheck |
Checks for overly complicated boolean return statements.
|
| SingleLineJavadocCheck |
Checks that a JavaDoc block can fit on a single line and doesn't
contain at-clauses.
|
| SingleSpaceSeparatorCheck |
Checks that non-whitespace characters are separated by no more than one
whitespace.
|
| SlistHandler |
Handler for a list of statements.
|
| StatelessCheck |
This annotation means that the check does not contain mutable state and
may be safely used from others threads at the same time.
|
| StaticInitHandler |
Handler for static initialization blocks.
|
| StaticVariableNameCheck |
Checks that static, non-final variable names conform to a format specified
by the format property.
|
| StringLiteralEqualityCheck |
Checks that string literals are not used with
== or !=.
|
| SummaryJavadocCheck |
|
| SuperCloneCheck |
Checks that an overriding clone() method invokes super.clone().
|
| SuperFinalizeCheck |
Checks that an overriding finalize() method invokes super.finalize().
|
| SuppressElement |
This filter processes AuditEvent
objects based on the criteria of file, check, module id, line, and
column. |
| SuppressionCommentFilter |
A filter that uses comments to suppress audit events.
|
| SuppressionCommentFilter.Tag |
A Tag holds a suppression comment and its location, and determines
whether the suppression turns checkstyle reporting on or off.
|
| SuppressionCommentFilter.TagType |
Enum to be used for switching checkstyle reporting for tags.
|
| SuppressionFilter |
This filter accepts AuditEvents according to file, check, line, and
column, as specified in a suppression file.
|
| SuppressionsLoader |
Loads a filter chain of suppressions.
|
| SuppressionsStringPrinter |
Class for constructing xpath queries to suppress nodes
with specified line and column number.
|
| SuppressionXpathFilter |
This filter accepts TreeWalkerAuditEvents according to file, check and xpath query,
as specified in a suppression file.
|
| SuppressWarningsCheck |
This check allows you to specify what warnings that
SuppressWarnings is not
allowed to suppress.
|
| SuppressWarningsFilter |
A filter that suppresses warnings using the SuppressWarnings
annotation.
|
| SuppressWarningsHolder |
Maintains a set of check suppressions from SuppressWarnings
annotations.
|
| SuppressWithNearbyCommentFilter |
A filter that uses nearby comments to suppress audit events.
|
| SuppressWithNearbyCommentFilter.Tag |
A Tag holds a suppression comment and its location.
|
| SuppressWithPlainTextCommentFilter |
A filter that uses comments to suppress audit events.
|
| SuppressWithPlainTextCommentFilter.Suppression |
The class which represents the suppression.
|
| SwitchHandler |
Handler for switch statements.
|
| SynchronizedHandler |
Handler for synchronized statements.
|
| TagInfo |
Value object for storing data about a parsed tag.
|
| TextBlock |
A block of text from an input file that does not necessarily
have any grammatical structure.
|
| ThreadModeSettings |
Thread mode settings for the checkstyle modules.
|
| ThrowsCountCheck |
Restricts throws statements to a specified count (default = 4).
|
| TodoCommentCheck |
A check for 'TODO:' comments.
|
| TokenTypes |
Contains the constants for all the tokens contained in the Abstract
Syntax Tree.
|
| TokenUtil |
Contains utility methods for tokens.
|
| TrailingCommentCheck |
The check to ensure that comments are the only thing on a line.
|
| TranslationCheck |
The TranslationCheck class helps to ensure the correct translation of code by
checking locale-specific resource files for consistency regarding their keys.
|
| TreeTable |
This example shows how to create a simple TreeTable component,
by using a JTree as a renderer (and editor) for the cells in a
particular column in the JTable.
|
| TreeTableModelAdapter |
This is a wrapper class takes a TreeTableModel and implements
the table model interface.
|
| TreeWalker |
Responsible for walking an abstract syntax tree and notifying interested
checks at each each node.
|
| TreeWalkerAuditEvent |
Raw TreeWalker event for audit.
|
| TreeWalkerFilter |
An interface for filtering TreeWalkerAuditEvent.
|
| TryHandler |
Handler for try blocks.
|
| TypecastParenPadCheck |
Checks the padding of parentheses for typecasts.
|
| TypeNameCheck |
Checks that type names for classes, interfaces, enums, and annotations conform to a format
specified by the format property.
|
| UncommentedMainCheck |
Detects uncommented main methods.
|
| UniquePropertiesCheck |
Checks the uniqueness of property keys (left from equal sign) in the
properties file.
|
| UnnecessaryParenthesesCheck |
Checks if unnecessary parentheses are used in a statement or expression.
|
| UnusedImportsCheck |
Checks for unused import statements.
|
| UpperEllCheck |
Checks that long constants are defined with an upper ell.
|
| VariableDeclarationUsageDistanceCheck |
Checks the distance between declaration of variable and its first usage.
|
| VisibilityModifierCheck |
Checks visibility of class members.
|
| WhileHandler |
Handler for while loops.
|
| 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.
|
| WhitespaceAroundCheck |
Checks that a token is surrounded by whitespace.
|
| WrapOption |
Represents the options for wrapping on an operator.
|
| WriteTagCheck |
Outputs a JavaDoc tag as information.
|
| XmlLoader |
Contains the common implementation of a loader, for loading a configuration
from an XML file.
|
| XmlLoader.LoadExternalDtdFeatureProvider |
Used for setting specific for secure java installations features to SAXParserFactory.
|
| XMLLogger |
Simple XML logger.
|
| XpathFileGeneratorAstFilter |
Catches TreeWalkerAuditEvent and generates corresponding xpath query.
|
| XpathFileGeneratorAuditListener |
Generates suppressions.xml file, based on violations occurred.
|
| XpathFilter |
This filter processes TreeWalkerAuditEvent
objects based on the criteria of file, check, module id, xpathQuery. |
| XpathQueryGenerator |
Generates xpath queries.
|