Package com.puppycrawl.tools.checkstyle
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.
-
ClassDescriptionClass for printing AST to String.Represents the default formatter for log message.Represents the formatter interface for log message.This class provides the functionality to check a set of files.Loads a configuration from a standard configuration XML file.Enum to specify behaviour regarding ignored modules.Default implementation of the Configuration interface.A default implementation of the Context interface.Simple plain logger for text output.Contains constant definitions common to the package.The implementation of
DetailAST
.Parses file as javadoc DetailNode tree and prints to system output stream.This annotation means that the check contains file-related context and therefore cannot be used from the others threads at the same time.This annotation means that the check contains global context, which will be updated while Checkstyle processes files.Used for parsing Javadoc comment as DetailNode tree.Contains information about parse error message.Contains result of parsing javadoc comment: DetailNode tree and parse error message.This class is used internally in the build process to write a property file with short descriptions (the first sentences) of TokenTypes constants.Helper methods to parse java source files.Enum to be used for test if comments should be used.Wrapper command line program for the Checker.A module factory creates Objects from a given name.Loads a list of package names from a package name XML file.A factory for creating objects from package names and names.Enum class to define loading options.Resolves external properties from an underlyingProperties
object.This class maintains a persistent(on file-system) store of the files that have checked ok(no validation events) and their associated timestamp.Resolves properties in module configurations.This annotation means that the check does not contain mutable state and may be safely used from others threads at the same time.Class for constructing xpath queries to suppress nodes with specified line and column number.Thread mode settings for the checkstyle modules.Responsible for walking an abstract syntax tree and notifying interested checks at each each node.RawTreeWalker
event for audit.An interface for filteringTreeWalkerAuditEvent
.Contains the common implementation of a loader, for loading a configuration from an XML file.Used for setting specific for secure java installations features to SAXParserFactory.Simple XML logger.CatchesTreeWalkerAuditEvent
and generates corresponding xpath query.Generates suppressions.xml file, based on violations occurred.