Package com.puppycrawl.tools.checkstyle

Contains the implementation of the Checkstyle framework. Developers of plug-ins for Checkstyle should refer to this package to configure and run it.

You should not be referring to this package if you are implementing your own check.

Interface Summary

Interface	Description
AuditEventFormatter	Represents the formatter interface for log message.
ModuleFactory	A module factory creates Objects from a given name.
PropertyResolver	Resolves properties in module configurations.
TreeWalkerFilter	An interface for filtering TreeWalkerAuditEvent.

Class Summary

Class	Description
AbstractAutomaticBean	A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.
AbstractAutomaticBean.PatternArrayConverter	A converter that converts a comma-separated string into an array of patterns.
AbstractAutomaticBean.PatternConverter	A converter that converts a string to a pattern.
AbstractAutomaticBean.RelaxedAccessModifierArrayConverter	A converter that converts strings to AccessModifierOption.
AbstractAutomaticBean.RelaxedStringArrayConverter	A converter that does not care whether the array elements contain String characters like '*' or '_'.
AbstractAutomaticBean.ScopeConverter	A converter that converts strings to scope.
AbstractAutomaticBean.SeverityLevelConverter	A converter that converts strings to severity level.
AbstractAutomaticBean.UriConverter	A converter that converts strings to uri.
AstTreeStringPrinter	Class for printing AST to String.
AuditEventDefaultFormatter	Represents the default formatter for log message.
Checker	This class provides the functionality to check a set of files.
CheckstyleParserErrorStrategy	Extending BailErrorStrategy allows us to report errors while cancelling the parsing operation.
ConfigurationLoader	Loads a configuration from a standard configuration XML file.
DefaultConfiguration	Default implementation of the Configuration interface.
DefaultContext	A default implementation of the Context interface.
DefaultLogger	Simple plain logger for text output.
Definitions	Contains constant definitions common to the package.
DetailAstImpl	The implementation of DetailAST.
DetailNodeTreeStringPrinter	Parses file as javadoc DetailNode tree and prints to system output stream.
JavaAstVisitor	Visitor class used to build Checkstyle's Java AST from the parse tree produced by JavaLanguageParser.
JavaAstVisitor.DetailAstPair	Used to swap and organize DetailAstImpl subtrees.
JavadocDetailNodeParser	Used for parsing Javadoc comment as DetailNode tree.
JavadocDetailNodeParser.DescriptiveErrorListener	Custom error listener for JavadocParser that prints user readable errors.
JavadocDetailNodeParser.ParseErrorMessage	Contains information about parse error message.
JavadocDetailNodeParser.ParseStatus	Contains result of parsing javadoc comment: DetailNode tree and parse error message.
JavadocPropertiesGenerator	This class is used internally in the build process to write a property file with short descriptions (the first sentences) of TokenTypes constants.
JavadocPropertiesGenerator.CliOptions	Helper class encapsulating the command line options and positional parameters.
JavaParser	Helper methods to parse java source files.
JavaParser.CheckstyleErrorListener	Custom error listener to provide detailed exception message.
LocalizedMessage	Represents a message that can be localised.
LocalizedMessage.Utf8Control	Custom ResourceBundle.Control implementation which allows explicitly read the properties files as UTF-8.
Main	Wrapper command line program for the Checker.
Main.CliOptions	Command line options.
Main.OnlyCheckstyleLoggersFilter	Log Filter used in debug mode.
MetadataGeneratorLogger	Simple logger for metadata generator util.
PackageNamesLoader	Loads a list of package names from a package name XML file.
PackageObjectFactory	A factory for creating objects from package names and names.
PropertiesExpander	Resolves external properties from an underlying Properties object.
PropertyCacheFile	This class maintains a persistent(on file-system) store of the files that have checked ok(no validation events) and their associated timestamp.
PropertyCacheFile.ExternalResource	Class which represents external resource.
SarifLogger	Simple SARIF logger.
SuppressionsStringPrinter	Class for constructing xpath queries to suppress nodes with specified line and column number.
ThreadModeSettings	Thread mode settings for the checkstyle modules.
TreeWalker	Responsible for walking an abstract syntax tree and notifying interested checks at each node.
TreeWalkerAuditEvent	Raw TreeWalker event for audit.
XmlLoader	Contains the common implementation of a loader, for loading a configuration from an XML file.
XmlLoader.LoadExternalDtdFeatureProvider	Used for setting specific for secure java installations features to SAXParserFactory.
XMLLogger	Simple XML logger.
XMLLogger.FileMessages	The registered file messages.
XpathFileGeneratorAstFilter	Catches TreeWalkerAuditEvent and generates corresponding xpath query.
XpathFileGeneratorAuditListener	Generates suppressions.xml file, based on violations occurred.

Enum Summary

Enum	Description
AbstractAutomaticBean.OutputStreamOptions	Enum to specify behaviour regarding ignored modules.
ConfigurationLoader.IgnoredModulesOptions	Enum to specify behaviour regarding ignored modules.
JavaParser.Options	Enum to be used for test if comments should be used.
Main.OutputFormat	Enumeration over the possible output formats.
PackageObjectFactory.ModuleLoadOption	Enum class to define loading options.
PropertyType	Represents the custom property type used in documentation and configuration files.
TreeWalker.AstState	State of AST.

Annotation Types Summary

Annotation Type	Description
FileStatefulCheck	This annotation means that the check contains file-related context and therefore cannot be used from the others threads at the same time.
GlobalStatefulCheck	This annotation means that the check contains global context, which will be updated while Checkstyle processes files.
StatelessCheck	This annotation means that the check does not contain mutable state and may be safely used from others threads at the same time.
XdocsPropertyType	The type of property used in documentation and configuration files for clarification of the user-friendly type.