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 AuditListenerListener in charge of receiving events from the Checker. BeforeExecutionFileFilterAn interface for before execution file filtering events. ConfigurableA component that can be configured. ConfigurationA Configuration is used to configure a Configurable component. ContextA context to be used in subcomponents. ContextualizableA Component that needs context information from it's container(parent object) to work. DetailASTA interface of Checkstyle's AST nodes for traversing trees generated from the Java code. DetailNodeDetailNode is used to construct tree during parsing Javadoc comments. ExternalResourceHolder FileSetCheckInterface for Checking a set of files for some criteria. FilterAn interface for filtering AuditEvents. MessageDispatcherUsed by FileSetChecks to distribute AuditEvents to AuditListeners. RootModuleThe first module that is run as part of Checkstyle and controls its entire behavior and children. TextBlockA block of text from an input file that does not necessarily have any grammatical structure.
Class Summary Class Description AbstractCheckThe base class for checks. AbstractCheck.FileContextThe actual context holder. AbstractFileSetCheckProvides common functionality for many FileSetChecks. AbstractFileSetCheck.FileContextThe actual context holder. AbstractViolationReporterServes as an abstract base class for all modules that report inspection findings. AuditEventRaw event for audit. AutomaticBeanA Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes. AutomaticBean.PatternConverterA converter that converts strings to patterns. AutomaticBean.RelaxedAccessModifierArrayConverterA converter that converts strings to
AutomaticBean.RelaxedStringArrayConverterA converter that does not care whether the array elements contain String characters like '*' or '_'. AutomaticBean.ScopeConverterA converter that converts strings to scope. AutomaticBean.SeverityLevelConverterA converter that converts strings to severity level. AutomaticBean.UriConverterA converter that converts strings to uri. BeforeExecutionFileFilterSetA before execution file filter set applies filters to events. CommentRepresentation of the comment block. FileContentsRepresents the contents of a file. FileTextRepresents the text contents of a file of arbitrary plain text type. FilterSetA filter set applies filters to AuditEvents. FullIdentRepresents a full identifier, including dots, with associated position information. JavadocTokenTypesContains the constants for all the tokens contained in the Abstract Syntax Tree for the javadoc grammar. LineColumnImmutable line and column numbers. SeverityLevelCounterAn audit listener that counts how many
AuditEventsof a given severity have been generated.
TokenTypesContains the constants for all the tokens contained in the Abstract Syntax Tree. ViolationRepresents a violation that can be localised. Violation.Utf8ControlCustom ResourceBundle.Control implementation which allows explicitly read the properties files as UTF-8.
Enum Summary Enum Description AutomaticBean.OutputStreamOptionsEnum to specify behaviour regarding ignored modules. ScopeRepresents a Java visibility scope. SeverityLevelSeverity level for a check violation.
Exception Summary Exception Description CheckstyleExceptionRepresents an error condition within Checkstyle.