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.
-
ClassDescriptionA Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.Enum to specify behaviour regarding ignored modules.A converter that converts a comma-separated string into an array of patterns.A converter that converts a string to a pattern.A converter that converts strings to
AccessModifierOption.A converter that does not care whether the array elements contain String characters like '*' or '_'.A converter that converts strings to scope.A converter that converts strings to severity level.A converter that converts strings to uri.Class 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.Extending BailErrorStrategy allows us to report errors while cancelling the parsing operation.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 ofDetailAST.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.Visitor class used to build Checkstyle's Java AST from the parse tree produced byJavaLanguageParser.Used to swap and organize DetailAstImpl subtrees.Used for parsing Javadoc comment as DetailNode tree.Custom error listener for JavadocParser that prints user readable errors.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 class encapsulating the command line options and positional parameters.Helper methods to parse java source files.Custom error listener to provide detailed exception message.Enum to be used for test if comments should be used.Represents a message that can be localised.Custom ResourceBundle.Control implementation which allows explicitly read the properties files as UTF-8.Wrapper command line program for the Checker.Command line options.Log Filter used in debug mode.Enumeration over the possible output formats.Simple logger for metadata generator util.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 underlyingPropertiesobject.This class maintains a persistent(on file-system) store of the files that have checked ok(no validation events) and their associated timestamp.Class which represents external resource.Resolves properties in module configurations.Represents the custom property type used in documentation and configuration files.Simple SARIF logger.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 node.State of AST.RawTreeWalkerevent for audit.An interface for filteringTreeWalkerAuditEvent.The type of property used in documentation and configuration files for clarification of the user-friendly type.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.The registered file messages.CatchesTreeWalkerAuditEventand generates corresponding xpath query.Generates suppressions.xml file, based on violations occurred.