| 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.utils | 
 Contains utils classes for checkstyle. 
 | 
| com.puppycrawl.tools.checkstyle.xpath | 
 Contains the nodes implementations for XPATH queries and query generator. 
 | 
| Class and Description | 
|---|
| 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
 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. 
 | 
| 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 it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| 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. 
 | 
| LocalizedMessage
 Represents a message that can be localised. 
 | 
| 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. 
 | 
| Class and Description | 
|---|
| AuditListener
 Listener in charge of receiving events from the Checker. 
 | 
| Class and Description | 
|---|
| 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
 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. 
 | 
| 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 it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| 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. 
 | 
| LocalizedMessage
 Represents a message that can be localised. 
 | 
| 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. 
 | 
| Class and 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. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| FileSetCheck
 Interface for Checking a set of files for some criteria. 
 | 
| FileText
 Represents the text contents of a file of arbitrary plain text type. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and Description | 
|---|
| AbstractFileSetCheck
 Provides common functionality for many FileSetChecks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| CheckstyleException
 Represents an error condition within Checkstyle. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's 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. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| 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. | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and 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. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| CheckstyleException
 Represents an error condition within Checkstyle. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| 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. 
 | 
| Class and Description | 
|---|
| LineColumn
 Immutable line and column numbers. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and Description | 
|---|
| AbstractCheck
 The base class for checks. 
 | 
| AbstractViolationReporter
 Serves as an abstract base class for all modules that report inspection
 findings. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| Class and 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. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| CheckstyleException
 Represents an error condition within Checkstyle. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| FileSetCheck
 Interface for Checking a set of files for some criteria. 
 | 
| FileText
 Represents the text contents of a file of arbitrary plain text type. 
 | 
| Class and 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. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| FileSetCheck
 Interface for Checking a set of files for some criteria. 
 | 
| FileText
 Represents the text contents of a file of arbitrary plain text type. 
 | 
| Class and 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. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| FileSetCheck
 Interface for Checking a set of files for some criteria. 
 | 
| FileText
 Represents the text contents of a file of arbitrary plain text type. 
 | 
| Class and Description | 
|---|
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| BeforeExecutionFileFilter
 An interface for before execution file filtering events. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's container(parent object) to work. 
 | 
| Class and Description | 
|---|
| AuditEvent
 Raw event for audit. 
 | 
| AutomaticBean
 A Java Bean that implements the component lifecycle interfaces by
 calling the bean's setters for all configuration attributes. 
 | 
| CheckstyleException
 Represents an error condition within Checkstyle. 
 | 
| Configurable
 A component that can be configured. 
 | 
| Contextualizable
 A Component that needs context information from it's 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. 
 | 
| Filter
 An interface for filtering AuditEvents. 
 | 
| FilterSet
 A filter set applies filters to AuditEvents. 
 | 
| SeverityLevel
 
 Severity level for a check violation. 
 | 
| Class and Description | 
|---|
| CheckstyleException
 Represents an error condition within Checkstyle. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| DetailNode
 DetailNode is used to construct tree during parsing Javadoc comments. 
 | 
| Class and Description | 
|---|
| CheckstyleException
 Represents an error condition within Checkstyle. 
 | 
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| DetailNode
 DetailNode is used to construct tree during parsing Javadoc comments. 
 | 
| FullIdent
 Represents a full identifier, including dots, with associated
 position information. 
 | 
| Scope
 Represents a Java visibility scope. 
 | 
| TextBlock
 A block of text from an input file that does not necessarily
 have any grammatical structure. 
 | 
| Class and Description | 
|---|
| DetailAST
 An extension of the CommonAST that records the line and column number. 
 | 
| FileText
 Represents the text contents of a file of arbitrary plain text type. 
 | 
Copyright © 2001–2018. All rights reserved.