Uses of Package
com.puppycrawl.tools.checkstyle.api

Packages that use com.puppycrawl.tools.checkstyle.api

Package	Description
com.puppycrawl.tools.checkstyle	Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.ant	Contains code related to Checkstyle Ant Task.
com.puppycrawl.tools.checkstyle.api	Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.checks	Contains the checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.annotation	Contains the Annotation checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.blocks	Contains the Block checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.coding	Contains the Coding checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.design	Contains the Class Design checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.header	File Header checks.
com.puppycrawl.tools.checkstyle.checks.imports	Contains the Imports checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.indentation	Contains all classes required for the indentation check.
com.puppycrawl.tools.checkstyle.checks.javadoc	Contains the Javadoc checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.javadoc.utils	Contains utils classes for the Javadoc checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.metrics	Contains the Metrics checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.modifier	Contains the modifier checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.naming	Contains the Naming conventions checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.regexp	Contains the regular expression checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.sizes	Contains the Size Violations checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.whitespace	Contains the Whitespace checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.filefilters	Contains the before execution file filters that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.filters	Contains the filters that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.gui	User interface classes for CheckStyle.
com.puppycrawl.tools.checkstyle.meta	Contains module metadata generation classes for checkstyle.
com.puppycrawl.tools.checkstyle.site	Contains classes for generating the Checkstyle website.
com.puppycrawl.tools.checkstyle.utils	Contains utils classes for checkstyle.
com.puppycrawl.tools.checkstyle.xpath	Contains the nodes implementations for XPATH queries and query generator.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle

Class	Description
AbstractCheck	The base class for checks.
AbstractFileSetCheck	Provides common functionality for many FileSetChecks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
AuditEvent	Raw event for audit.
AuditListener	Listener in charge of receiving events from the Checker.
AutomaticBean.OutputStreamOptions	Deprecated. Enum to specify behaviour regarding ignored modules.
BeforeExecutionFileFilter	An interface for before execution file filtering events.
BeforeExecutionFileFilterSet	A before execution file filter set applies filters to events.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Configuration	A Configuration is used to configure a Configurable component.
Context	A context to be used in subcomponents.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.
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.
FileContents	Represents the contents of a file.
FileSetCheck	Interface for Checking a set of files for some criteria.
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.
MessageDispatcher	Used by FileSetChecks to distribute AuditEvents to AuditListeners.
RootModule	The first module that is run as part of Checkstyle and controls its entire behavior and children.
SeverityLevel	Severity level for a check violation.
SeverityLevelCounter	An audit listener that counts how many AuditEvents of a given severity have been generated.
Violation	Represents a violation that can be localised.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.ant

Class	Description
AuditListener	Listener in charge of receiving events from the Checker.
RootModule	The first module that is run as part of Checkstyle and controls its entire behavior and children.
SeverityLevelCounter	An audit listener that counts how many AuditEvents of a given severity have been generated.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.api

Class	Description
AbstractCheck.FileContext	The actual context holder.
AbstractFileSetCheck.FileContext	The actual context holder.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
AuditEvent	Raw event for audit.
AuditListener	Listener in charge of receiving events from the Checker.
AutomaticBean.OutputStreamOptions	Deprecated. Enum to specify behaviour regarding ignored modules.
BeforeExecutionFileFilter	An interface for before execution file filtering events.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Configuration	A Configuration is used to configure a Configurable component.
Context	A context to be used in subcomponents.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.
FileContents	Represents the contents of a file.
FileSetCheck	Interface for Checking a set of files for some criteria.
FileText	Represents the text contents of a file of arbitrary plain text type.
Filter	An interface for filtering AuditEvents.
FullIdent	Represents a full identifier, including dots, with associated position information.
LineColumn	Immutable line and column numbers.
MessageDispatcher	Used by FileSetChecks to distribute AuditEvents to AuditListeners.
Scope	Represents a Java visibility scope.
SeverityLevel	Severity level for a check violation.
TextBlock	A block of text from an input file that does not necessarily have any grammatical structure.
Violation	Represents a violation that can be localised.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks

Class	Description
AbstractCheck	The base class for checks.
AbstractFileSetCheck	Provides common functionality for many FileSetChecks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
AuditEvent	Raw event for audit.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
FileSetCheck	Interface for Checking a set of files for some criteria.
FileText	Represents the text contents of a file of arbitrary plain text type.
FullIdent	Represents a full identifier, including dots, with associated position information.
TextBlock	A block of text from an input file that does not necessarily have any grammatical structure.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.annotation

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.blocks

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.coding

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
FullIdent	Represents a full identifier, including dots, with associated position information.
Scope	Represents a Java visibility scope.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.design

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.header

Class	Description
AbstractFileSetCheck	Provides common functionality for many FileSetChecks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
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.
FileSetCheck	Interface for Checking a set of files for some criteria.
FileText	Represents the text contents of a file of arbitrary plain text type.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.imports

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
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.
FullIdent	Represents a full identifier, including dots, with associated position information.
TextBlock	A block of text from an input file that does not necessarily have any grammatical structure.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.indentation

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.javadoc

Class	Description
AbstractCheck	The base class for checks.
AbstractFileSetCheck	Provides common functionality for many FileSetChecks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.
FileSetCheck	Interface for Checking a set of files for some criteria.
FileText	Represents the text contents of a file of arbitrary plain text type.
FullIdent	Represents a full identifier, including dots, with associated position information.
Scope	Represents a Java visibility scope.
SeverityLevel	Severity level for a check violation.
TextBlock	A block of text from an input file that does not necessarily have any grammatical structure.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.javadoc.utils

Class	Description
LineColumn	Immutable line and column numbers.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.metrics

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.modifier

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.naming

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.regexp

Class	Description
AbstractCheck	The base class for checks.
AbstractFileSetCheck	Provides common functionality for many FileSetChecks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
FileContents	Represents the contents of a file.
FileSetCheck	Interface for Checking a set of files for some criteria.
FileText	Represents the text contents of a file of arbitrary plain text type.
LineColumn	Immutable line and column numbers.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.sizes

Class	Description
AbstractCheck	The base class for checks.
AbstractFileSetCheck	Provides common functionality for many FileSetChecks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
FileSetCheck	Interface for Checking a set of files for some criteria.
FileText	Represents the text contents of a file of arbitrary plain text type.
Scope	Represents a Java visibility scope.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.checks.whitespace

Class	Description
AbstractCheck	The base class for checks.
AbstractFileSetCheck	Provides common functionality for many FileSetChecks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
FileSetCheck	Interface for Checking a set of files for some criteria.
FileText	Represents the text contents of a file of arbitrary plain text type.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.filefilters

Class	Description
BeforeExecutionFileFilter	An interface for before execution file filtering events.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.filters

Class	Description
AuditEvent	Raw event for audit.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
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.
FileContents	Represents the contents of a file.
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.
SeverityLevel	Severity level for a check violation.
TextBlock	A block of text from an input file that does not necessarily have any grammatical structure.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.gui

Class	Description
CheckstyleException	Represents an error condition within Checkstyle.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.
FileText	Represents the text contents of a file of arbitrary plain text type.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.meta

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
CheckstyleException	Represents an error condition within Checkstyle.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.site

Class	Description
AbstractCheck	The base class for checks.
AbstractViolationReporter	Serves as an abstract base class for all modules that report inspection findings.
Configurable	A component that can be configured.
Contextualizable	A Component that needs context information from its container(parent object) to work.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.utils

Class	Description
CheckstyleException	Represents an error condition within Checkstyle.
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailNode	DetailNode is used to construct tree during parsing Javadoc comments.
Scope	Represents a Java visibility scope.
TextBlock	A block of text from an input file that does not necessarily have any grammatical structure.

Classes in com.puppycrawl.tools.checkstyle.api used by com.puppycrawl.tools.checkstyle.xpath

Class	Description
DetailAST	An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
FileText	Represents the text contents of a file of arbitrary plain text type.