| 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..
|
| Java Source File Name | Type | Comment |
| AbstractFileSetCheck.java | Class | Provides common functionality for many FileSetChecks. |
| AbstractLoader.java | Class | Contains the common implementation of a loader, for loading a configuration
from an XML file. |
| AbstractViolationReporter.java | Class | Serves as an abstract base class for all modules that report inspection
findings. |
| AbstractViolationReporterTest.java | Class | Tests to ensure that default messagebundle is determined correctly. |
| AllTests.java | Class | |
| AuditEvent.java | Class | Raw event for audit.
I'm not very satisfied about the design of this event since there are
optional methods that will return null in most of the case. |
| AuditListener.java | Interface | Listener in charge of receiving events from the Checker. |
| AutomaticBean.java | Class | A Java Bean that implements the component lifecycle interfaces by
calling the bean's setters for all configration attributes. |
| AutomaticBeanTest.java | Class | |
| Check.java | Class | The base class for checks. |
| CheckstyleException.java | Class | Represents an error condition within Checkstyle. |
| Comment.java | Class | Representation of the comment block. |
| Configurable.java | Interface | A component that can be configured. |
| Configuration.java | Interface | A Configuration is used to configure a Configurable component. |
| Context.java | Interface | A context to be used in subcomponents. |
| Contextualizable.java | Interface | A Component that needs context information from it's container to work.
The container will create a Context object and pass it to this
Contextualizable. |
| DetailAST.java | Class | An extension of the CommonAST that records the line and column
number. |
| DetailASTTest.java | Class | TestCase to check DetailAST. |
| FileContents.java | Class | Represents the contents of a file. |
| FileSetCheck.java | Interface | Interface for Checking a set of files for some criteria. |
| Filter.java | Interface | An interface for filtering AuditEvents. |
| FilterSet.java | Class | A filter set applies filters to AuditEvents.
If a filter in the set rejects an AuditEvent, then the
AuditEvent is rejected. |
| FullIdent.java | Class | Represents a full identifier, including dots, with associated
position information. |
| LocalizedMessage.java | Class | Represents a message that can be localised. |
| LocalizedMessages.java | Class | Collection of messages. |
| MessageDispatcher.java | Interface | Used by FileSetChecks to distribute AuditEvents to AuditListeners. |
| Scope.java | Class | Represents a Java visibility scope. |
| ScopeTest.java | Class | |
| ScopeUtils.java | Class | Contains utility methods for working on scope. |
| SeverityLevel.java | Class | Severity level for a check violation. |
| SeverityLevelCounter.java | Class | An audit listener that counts how many
AuditEvent AuditEvents of a given severity have been generated. |
| TextBlock.java | Interface | A block of text from an inputfile that does not necessarily
have any grammatical structure. |
| TokenTypes.java | Class | Contains the constants for all the tokens contained in the Abstract
Syntax Tree. |
| TokenTypesTest.java | Class | |
| Utils.java | Class | Contains utility methods. |