All Classes Interface Summary Class Summary Enum Summary Exception 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.
|
| AbstractComplexityCheck |
Deprecated.
|
| AbstractDeclarationCollector |
Deprecated.
|
| AbstractDeclarationCollector.BlockFrame |
A frame initiated on entering a statement list; holds local variable
names.
|
| AbstractDeclarationCollector.ClassFrame |
A frame initiated at class definition; holds instance variable
names.
|
| AbstractDeclarationCollector.GlobalFrame |
The global frame; should hold only class names.
|
| AbstractDeclarationCollector.LexicalFrame |
A declaration frame.
|
| AbstractDeclarationCollector.MethodFrame |
A frame initiated at method definition; holds parameter names.
|
| AbstractExpressionHandler |
Abstract base class for all handlers.
|
| AbstractFileSetCheck |
Provides common functionality for many FileSetChecks.
|
| AbstractFormatCheck |
Deprecated.
|
| AbstractHeaderCheck |
Abstract super class for header checks.
|
| AbstractIllegalCheck |
Deprecated.
|
| AbstractIllegalMethodCheck |
Deprecated.
|
| AbstractImportRule |
Base class for import rules.
|
| AbstractJavadocCheck |
Base class for Checks that process Javadoc comments.
|
| AbstractLoader |
Contains the common implementation of a loader, for loading a configuration
from an XML file.
|
| AbstractNameCheck |
Abstract class for checking that names conform to a specified format.
|
| AbstractNestedDepthCheck |
Deprecated.
|
| AbstractOptionCheck<T extends java.lang.Enum<T>> |
Deprecated.
|
| 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.
|
| AbstractSuperCheck.MethodNode |
Stack node for a method definition and a record of
whether the method has a call to the super method.
|
| AbstractTypeAwareCheck |
Deprecated.
|
| AbstractTypeAwareCheck.AbstractClassInfo |
Contains class's Token.
|
| AbstractTypeAwareCheck.ClassAlias |
Represents type param which is "alias" for real type.
|
| AbstractTypeAwareCheck.RegularClass |
Represents regular classes/enums.
|
| 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.
|
| AccessResult |
Represents the result of an access check.
|
| AnnotationLocationCheck |
Check location of annotation on language elements.
|
| 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.
|
| AnnotationUtility |
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 |
|
| 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.PatternConverter |
A converter that converts strings to patterns.
|
| AutomaticBean.RelaxedAccessModifierArrayConverter |
|
| AutomaticBean.RelaxedStringArrayConverter |
A converter that does not care whether the array elements contain String
characters like '*' or '_'.
|
| AutomaticBean.ScopeConverter |
A converter that converts strings to scope.
|
| AutomaticBean.SeverityLevelConverter |
A converter that converts strings to severity level.
|
| AutomaticBean.UriConverter |
A converter that converts strings to uri.
|
| 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).
|
| 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.
|
| CheckUtils |
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.
|
| ClassImportRule |
Represents whether a class is allowed to be imported or not.
|
| 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.
|
| CommentSuppressor |
Implementation of a MatchSuppressor that suppresses based on
whether in a comment. |
| CommonUtils |
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.
|
| 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).
|
| CsvFilter |
This filter accepts an integer that matches a CSV value, where
each value is an integer or a range of integers.
|
| CustomImportOrderCheck |
Checks that the groups of import declarations appear in the order specified
by the user.
|
| CustomImportOrderCheck.ImportDetails |
Contains import attributes as line number, import full path, import
group.
|
| CustomImportOrderCheck.RuleMatchForImport |
Contains matching attributes assisting in definition of "best matching"
group for import.
|
| CyclomaticComplexityCheck |
Checks cyclomatic complexity against a specified limit.
|
| DeclarationOrderCheck |
|
| DeclarationOrderCheck.ScopeState |
Private class to encapsulate the state.
|
| 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.
|
| 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.
|
| EqualsAvoidNullCheck.FieldFrame |
Holds the names of fields of a type.
|
| 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).
|
| ExecutableStatementCountCheck.Context |
Class to encapsulate counting information about one member.
|
| 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.
|
| FileContentsHolder |
Holds the current file contents for global access when configured
as a TreeWalker sub-module.
|
| FileLengthCheck |
Checks for long source files.
|
| FileSetCheck |
Interface for Checking a set of files for some criteria.
|
| 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.
|
| FinalClassCheck |
Checks that class which has only private ctors
is declared as final.
|
| FinalClassCheck.ClassDesc |
Maintains information about class' ctors.
|
| FinalLocalVariableCheck |
Ensures that local variables that never get their values changed,
must be declared final.
|
| FinalLocalVariableCheck.FinalVariableCandidate |
Represents information about final local variable candidate.
|
| FinalLocalVariableCheck.ScopeData |
Holder for the scope data.
|
| 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.
|
| 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.
|
| HiddenFieldCheck.FieldFrame |
Holds the names of static and instance fields of a type.
|
| HideUtilityClassConstructorCheck |
Make sure that utility classes (classes that contain only static methods)
do not have a public constructor.
|
| HideUtilityClassConstructorCheck.Details |
Details of class that are required for validation.
|
| HtmlTag |
Used to keep track of a tag and the text that follows it.
|
| 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 class are never used as types in variable
declarations, return values or parameters.
|
| ImportControl |
Represents a tree of import rules for controlling whether packages or
classes are allowed to be used.
|
| ImportControlCheck |
Check that controls what packages can be imported in each package.
|
| ImportControlLoader |
Responsible for loading the contents of an import control configuration file.
|
| ImportHandler |
Handler for import statements.
|
| ImportOrderCheck |
groups imports: ensures that groups of imports come in a specific order
(e.g., java.
|
| 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.
|
| 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.
|
| InterfaceTypeParameterNameCheck |
Checks that interface type parameter names conform to a format specified
by the format property.
|
| IntFilter |
An interface for filtering Integer.
|
| IntMatchFilter |
This filter accepts a matching Integer.
|
| IntRangeFilter |
This filter accepts an Integer in a range.
|
| InvalidJavadocTag |
Value object for storing data about an invalid Javadoc validTags.
|
| JavadocDetailNodeParser |
Used for parsing Javadoc comment as DetailNode tree.
|
| JavadocDetailNodeParser.DescriptiveErrorListener |
Custom error listener for JavadocParser that prints user readable errors.
|
| 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.
|
| JavadocMethodCheck.ExceptionInfo |
Stores useful information about declared exception.
|
| 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.BodyTagCloseContext |
|
| JavadocParser.BodyTagOpenContext |
|
| JavadocParser.BrTagContext |
|
| JavadocParser.ColgroupContext |
|
| JavadocParser.ColgroupTagCloseContext |
|
| JavadocParser.ColgroupTagOpenContext |
|
| JavadocParser.ColTagContext |
|
| JavadocParser.DdContext |
|
| JavadocParser.DdTagCloseContext |
|
| JavadocParser.DdTagOpenContext |
|
| JavadocParser.DescriptionContext |
|
| JavadocParser.DtContext |
|
| JavadocParser.DtTagCloseContext |
|
| JavadocParser.DtTagOpenContext |
|
| JavadocParser.FrameTagContext |
|
| JavadocParser.HeadContext |
|
| JavadocParser.HeadTagCloseContext |
|
| JavadocParser.HeadTagOpenContext |
|
| JavadocParser.HrTagContext |
|
| JavadocParser.HtmlCommentContext |
|
| JavadocParser.HtmlContext |
|
| JavadocParser.HtmlElementCloseContext |
|
| JavadocParser.HtmlElementContext |
|
| JavadocParser.HtmlElementOpenContext |
|
| JavadocParser.HtmlTagCloseContext |
|
| JavadocParser.HtmlTagContext |
|
| JavadocParser.HtmlTagOpenContext |
|
| JavadocParser.ImgTagContext |
|
| JavadocParser.InputTagContext |
|
| JavadocParser.IsindexTagContext |
|
| JavadocParser.JavadocContext |
|
| JavadocParser.JavadocInlineTagContext |
|
| JavadocParser.JavadocTagContext |
|
| JavadocParser.LiContext |
|
| JavadocParser.LinkTagContext |
|
| JavadocParser.LiTagCloseContext |
|
| JavadocParser.LiTagOpenContext |
|
| JavadocParser.MetaTagContext |
|
| JavadocParser.OptionContext |
|
| JavadocParser.OptionTagCloseContext |
|
| JavadocParser.OptionTagOpenContext |
|
| JavadocParser.ParagraphContext |
|
| JavadocParser.ParametersContext |
|
| JavadocParser.ParamTagContext |
|
| JavadocParser.PTagCloseContext |
|
| JavadocParser.PTagOpenContext |
|
| JavadocParser.ReferenceContext |
|
| JavadocParser.SingletonElementContext |
|
| JavadocParser.SingletonTagContext |
|
| JavadocParser.SingletonTagNameContext |
|
| JavadocParser.TbodyContext |
|
| JavadocParser.TbodyTagCloseContext |
|
| JavadocParser.TbodyTagOpenContext |
|
| JavadocParser.TdContext |
|
| JavadocParser.TdTagCloseContext |
|
| JavadocParser.TdTagOpenContext |
|
| JavadocParser.TextContext |
|
| JavadocParser.TfootContext |
|
| JavadocParser.TfootTagCloseContext |
|
| JavadocParser.TfootTagOpenContext |
|
| JavadocParser.ThContext |
|
| JavadocParser.TheadContext |
|
| JavadocParser.TheadTagCloseContext |
|
| JavadocParser.TheadTagOpenContext |
|
| JavadocParser.ThTagCloseContext |
|
| JavadocParser.ThTagOpenContext |
|
| JavadocParser.TrContext |
|
| JavadocParser.TrTagCloseContext |
|
| JavadocParser.TrTagOpenContext |
|
| JavadocParser.WrongSinletonTagContext |
|
| JavadocParserBaseListener |
This class provides an empty implementation of JavadocParserListener,
which can be extended to create a listener which only needs to handle a subset
of the available methods. |
| JavadocParserBaseVisitor<T> |
This class provides an empty implementation of JavadocParserVisitor,
which can be extended to create a visitor which only needs to handle a subset
of the available methods. |
| JavadocParserListener |
This interface defines a complete listener for a parse tree produced by
JavadocParser. |
| JavadocParserVisitor<T> |
This interface defines a complete generic visitor for a parse tree produced
by JavadocParser. |
| 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.
|
| JavadocUtils |
Contains utility methods for working with Javadoc.
|
| JavadocUtils.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.
|
| JavaNCSSCheck.Counter |
Class representing a counter.
|
| LabelHandler |
Handler for labels.
|
| LambdaHandler |
Handler for lambda expressions.
|
| LeftCurlyCheck |
Checks the placement of left curly braces on types, methods and
other blocks:
LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, STATIC_INIT,
LAMBDA. |
| 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.
|
| ListToTreeSelectionModelWrapper |
ListToTreeSelectionModelWrapper extends DefaultTreeSelectionModel
to listen for changes in the ListSelectionModel it maintains.
|
| 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.
|
| LocalizedMessages |
Collection of messages.
|
| 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.
|
| Main.CliOptions |
Helper structure to clear show what is required for Checker to run.
|
| MainFrame |
Displays information about a parse tree.
|
| MainFrame.JavaFileFilter |
Filter for Java files.
|
| 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 |
Counts the methods of the type-definition and checks whether this
count is higher than the configured limit.
|
| MethodCountCheck.MethodCounter |
Marker class used to collect data about the number of methods per
class.
|
| 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 class type parameter names conform to a format specified
by the format property.
|
| MismatchStrategy |
Represents the strategy for checking rules inside ImportControl.
|
| 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.
|
| ModuleReflectionUtils |
Contains utility methods for module reflection.
|
| MultilineDetector |
A detector that matches across multiple lines.
|
| MultipleStringLiteralsCheck |
Checks for multiple occurrences of the same string literal within a
single file.
|
| MultipleStringLiteralsCheck.StringInfo |
This class contains information about where a string was found.
|
| 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).
|
| NPathComplexityCheck.TokenEnd |
Coordinates of token end.
|
| NPathComplexityCheck.Values |
Class that store range value and expression value.
|
| 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.
|
| PadOption |
Represents the options for whitespace around parentheses.
|
| ParameterAssignmentCheck |
Disallow assignment of parameters.
|
| ParameterNameCheck |
Checks that method and catch 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, with the exception that it does
not check for padding of the right parenthesis at an empty for iterator and
empty for initializer.
|
| ParseTreeTableModel |
The model that backs the parse tree in the GUI.
|
| ParseTreeTablePresentation |
The model that backs the parse tree in the GUI.
|
| PkgImportRule |
Represents whether a package is allowed to be imported or not.
|
| PrimordialHandler |
A default no-op handler.
|
| PropertiesExpander |
Resolves external properties from an
underlying Properties object.
|
| PropertyCacheFile |
This class maintains a persistent(on file-system) store of the files
that have checked ok(no validation events) and their associated
timestamp.
|
| PropertyCacheFile.ExternalResource |
Class which represents external resource.
|
| 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.AbstractFrame |
A declaration frame.
|
| RequireThisCheck.AnonymousClassFrame |
An anonymous class frame; holds instance variable names.
|
| RequireThisCheck.BlockFrame |
A frame initiated on entering a statement list; holds local variable names.
|
| RequireThisCheck.ClassFrame |
A frame initiated at class, enum or interface definition; holds instance variable names.
|
| RequireThisCheck.ConstructorFrame |
A frame initiated at constructor definition.
|
| RequireThisCheck.FrameType |
An AbstractFrame type.
|
| RequireThisCheck.MethodFrame |
A frame initiated at method definition; holds a method definition token.
|
| ReturnCountCheck |
Restricts the number of return statements in methods, constructors and lambda expressions
(2 by default).
|
| RightCurlyCheck |
Checks the placement of right curly braces.
|
| RightCurlyCheck.Details |
Structure that contains all details for validation.
|
| 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.
|
| Scope |
Represents a Java visibility scope.
|
| ScopeUtils |
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.
|
| SinglelineDetector |
A detector that matches individual lines.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| SuppressWarningsHolder.Entry |
Records a particular suppression for a region of a file.
|
| SuppressWithNearbyCommentFilter |
A filter that uses nearby comments to suppress audit events.
|
| SuppressWithNearbyCommentFilter.Tag |
A Tag holds a suppression comment and its location.
|
| SwitchHandler |
Handler for switch statements.
|
| SynchronizedHandler |
Handler for synchronized statements.
|
| TagParser |
Helper class used to parse HTML tags or generic type identifiers
from a single line of text.
|
| TagParser.Point |
Represents current position in the text.
|
| TextBlock |
A block of text from an input file that does not necessarily
have any grammatical structure.
|
| 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.
|
| TokenTypesDoclet |
Doclet which is used to write property file with short descriptions
(first sentences) of TokenTypes' constants.
|
| TokenUtils |
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.
|
| TranslationCheck.ResourceBundle |
Class which represents a resource bundle.
|
| 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.
|
| TreeTableCellRenderer |
A TreeCellRenderer that displays a JTree.
|
| 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.
|
| TreeWalker.AstState |
State of AST.
|
| TryHandler |
Handler for try blocks.
|
| TypecastParenPadCheck |
Checks the padding of parentheses for typecasts.
|
| TypeNameCheck |
Checks that type names 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.
|
| UniquePropertiesCheck.UniqueProperties |
Properties subclass to store duplicated property keys in a separate map.
|
| 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.
|
| XMLLogger |
Simple XML logger.
|