Package com.puppycrawl.tools.checkstyle.api
Contains the core API to be used to implement checks. If you want to
implement your own check, you should be referring to this package.
-
Interface Summary Interface Description AuditListener Listener in charge of receiving events from the Checker.BeforeExecutionFileFilter An interface for before execution file filtering events.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 ofAbstractCheck
, implementor ofFileSetCheck
, orFilter
) which uses external resources of any kind for its configuration.FileSetCheck Interface for Checking a set of files for some criteria.Filter An interface for filtering 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.TextBlock A block of text from an input file that does not necessarily have any grammatical structure. -
Class Summary Class Description AbstractCheck The base class for checks.AbstractCheck.FileContext The actual context holder.AbstractFileSetCheck Provides common functionality for many FileSetChecks.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.AutomaticBean Deprecated. since 10.9.3.BeforeExecutionFileFilterSet A before execution file filter set applies filters to events.Comment Representation of the comment block.FileContents Represents the contents of a file.FileText Represents the text contents of a file of arbitrary plain text type.FilterSet A filter set applies filters to AuditEvents.FullIdent Represents a full identifier, including dots, with associated position information.JavadocTokenTypes Contains the constants for all the tokens contained in the Abstract Syntax Tree for the javadoc grammar.LineColumn Immutable line and column numbers.SeverityLevelCounter An audit listener that counts how manyAuditEvents
of a given severity have been generated.TokenTypes Contains the constants for all the tokens contained in the Abstract Syntax Tree.Violation Represents a violation that can be localised. -
Enum Summary Enum Description AutomaticBean.OutputStreamOptions Enum to specify behaviour regarding ignored modules.Scope Represents a Java visibility scope.SeverityLevel Severity level for a check violation. -
Exception Summary Exception Description CheckstyleException Represents an error condition within Checkstyle.