Provides common functionality for many FileSetChecks.
Contains the common implementation of a loader, for loading a configuration
from an XML file.
Serves as an abstract base class for all modules that report inspection
findings.
Determines whether or not a filtered AuditEvent is accepted.
Determines whether an Integer matches a CSV integer value.
Determines whether or not a filtered Integer is accepted.
Logs a message to be reported.
Adds an attribute to this configuration.
Makes a configuration a child of this configuration.
Notify that an audit error was discovered on a specific file.
Print an Emacs compliant line on the error stream.
Notify that an exception happened while performing audit.
Adds a set of files (nested fileset attribute).
Adds a FileSetCheck to the list of FileSetChecks
that is executed in process().
Adds a filter to the end of the audit event filter chain.
Adds a Filter to the set.
Adds a IntFilter to the set.
Add the listener that will be used to receive events from the audit.
Add an override property.
An annotation of a package, type, field, parameter or variable.
An annotation array member initialisation.
An annotation declaration.
An annotation field declaration.
An initialisation of an annotation member with a value.
A collection of annotations on a package or enum constant.
ANONINNER - static field in class com.puppycrawl.tools.checkstyle.api.
Scope anon inner scope.
The =
(assignment) operator.
AT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes An 'at' symbol - signifying an annotation instance or the prefix
to the interface literal signifying the definition of an annotation
declaration.
Creates a new AuditEvent
instance.
Creates a new AuditEvent
instance.
Notify that the audit is finished.
Listener in charge of receiving events from the Checker.
Notify that the audit is about to start.
A Java Bean that implements the component lifecycle interfaces by
calling the bean's setters for all configration attributes.
BAND - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The &
(bitwise AND) operator.
The &=
(bitwise AND assignment) operator.
Called before the starting to process a tree.
BNOT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ~
(bitwise complement) operator.
BOR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The |
(bitwise OR) operator.
The |=
(bitwise OR assignment) operator.
Checks if this branch of the parse tree contains a token
of the provided type.
BSR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The >>>
(unsigned shift right) operator.
The >>>=
(unsigned right shift assignment)
operator.
BXOR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ^
(bitwise exclusive OR) operator.
The ^=
(bitwise exclusive OR assignment) operator.
Check - class com.puppycrawl.tools.checkstyle.api.
Check The base class for checks.
Doclet which is used to extract Anakia input files from the
Javadoc of Check implementations, so the Check's docs are
autogenerated.
This class provides the functionality to check a set of files.
Creates a new Checker
instance.
Name of resource bundle for Checkstyle.
Represents an error condition within Checkstyle.
Creates a new CheckstyleException
instance.
Creates a new CheckstyleException
instance
that was caused by another exception.
An implementation of a ANT task for calling checkstyle.
Flushes the output streams and closes them if needed.
COLON - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The :
(colon) operator.
COMMA - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ,
(comma) operator.
Representation of the comment block.
This interface is used to be notified by parser about comments
in the parsed code.
A component that can be configured.
A Configuration is used to configure a Configurable component.
Loads a configuration from a standard configuration XML file.
Implements the Configurable interface using bean introspection.
Configures this component.
A context to be used in subcomponents.
A Component that needs context information from it's container to work.
Implements the Contextualizable interface using bean introspection.
Sets the context for this Component.
Creates a new FullIdent starting from the specified node.
Creates a new FullIdent starting from the child of the specified node.
Creates a new instance of a class from a given name.
Creates a new instance of a class from a given name, or that name
concatenated with "Check".
Helper method to create a regular expression.
This filter accepts an integer that matches a CSV value, where
each value is an integer or a range of integers.
Constructs a CSVFilter
from a CSV, Comma-Separated Values,
string.
A constructor declaration.
DEC - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The --
(prefix decrement) operator.
Default implementation of the Configuration interface.
Instantiates a DefaultConfiguration.
A default implementation of the Context interface.
Simple plain logger for text output.
Creates a new DefaultLogger
instance.
Creates a new DefaultLogger
instance.
Defn - class com.puppycrawl.tools.checkstyle.
Defn Contains constant definitions common to the package.
An extension of the CommonAST that records the line and column
number.
DIV - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The /
(division) operator.
The /=
(division assignment) operator.
Literal while
in do-while loop.
DOT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The .
(dot) operator.
Represents the contents of a file.
Creates a new FileContents
instance.
Notify that audit is finished on a specific file.
Interface for Checking a set of files for some criteria.
Notify that audit is about to start on a specific file.
Filter - interface com.puppycrawl.tools.checkstyle.api.
Filter An interface for filtering AuditEvents.
Determines the set of files this FileSetCheck is interested in.
A filter set applies filters to AuditEvents.
FINAL - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The final
keyword.
Returns the first child token that makes a specified type.
Provides a hook to finish the part of this compoent's setup that
was not handled by the bean introspection.
Called after finished processing a tree.
notify all listeners about the audit end
notify all listeners about the audit start
Notify all listeners about the errors in a file.
notify all listeners about the errors in a file.
Notify all listeners about the errors in a file.
Notify all listeners about the end of a file audit.
Notify all listeners about the end of a file audit.
Notify all listeners about the beginning of a file audit.
Notify all listeners about the beginning of a file audit.
Represents a full identifier, including dots, with associated
position information.
GE - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The >=
(greater than or equal) operator.
'>' symbol signifying the end of type arguments or type parameters.
'<' symbol signifying the start of type arguments or type parameters.
Searches for the value with the specified attribute key in this context.
The configurable token set.
The attribute value for an attribute name.
The set of attribute names.
Returns the names of all atttributes of this context.
Returns a map of all C style comments.
Returns the number of child nodes one level below this node.
Returns the number of direct child tokens that have the specified type.
The set of child configurations.
Returns the class loader associated with the tree.
Returns the configuration that was used to configure this component.
Returns the number of counted events since audit started.
Returns a map of all the C++ style comments.
Returns the default token a check is interested in.
Return the destination directory for this Javadoc run.
The column in the inputfile where the text block ends.
The last line of the text block in the inputfile.
Accessor for shared instance of logger which should be
used to log all exceptions occured during FileSetCheck
work (debug()
should be used).
Returns the file contents associated with the tree.
Returns the loaded filter chain.
Returns the IntFilters of the filter set.
Returns the Filters of the filter set.
SeverityLevel factory method.
Returns the Javadoc comment before the specified line.
Returns the message key to locate the translation, can also be used
in IDE plugins to map error messages to corrective actions.
return the line number on the source file where the event occurred.
Returns the lines associated with the tree.
Loads the contents of a file in a String array.
Loads the contents of a file in a String array using
the named charset.
Return the list of listeners set in this task.
return the message associated to the event.
Returns the message bundle name resourcebundle that contains the messages
used by this module.
Returns the collector for violation messages.
A message dispatcher is used to fire violation messages to
interested audit listeners.
The name of this configuration.
Returns the parent token.
This is a factory method to return an Pattern object for the specified
regular expression.
Returns the previous sibling or null if no such sibling exists.
The tokens that this check must be registered for.
Returns the Scope specified by the modifier set.
Get the severity level's name.
Returns the severity level of the messages generated by this module.
Returns the short description of a token for a given name.
The column in the inputfile where the text block starts.
The line in the inputfile where the text block starts.
Create a stripped down version of a filename.
Returns the scope of the surrounding "block".
The text content of the text block.
Returns the ID of a token for a given name.
Returns the name of a token for a given ID.
Returns the tokens registered for the check.
GT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The >
(greater than) operator.
IDENT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes An identifier.
Returns whether a node is directly contained within an annotation block.
INC - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ++
(prefix increment) operator.
Returns whether the scope of a node is restricted to a code block.
The array index operator.
Returns whether a node is directly contained within an enum block.
Severity level: informational.
Returns whether a node is directly contained within an interface block.
Returns whether a node is directly contained within an interface or
annotation block.
init() - method in class com.puppycrawl.tools.checkstyle.api.
Check Initialse the check.
An interface declaration.
Checks if this comment intersects with a specified
part of the file.
An interface for filtering Integer.
This filter accepts a matching Integer.
Constructs a MatchFilter for an int.
This filter accepts an Integer in a range.
Constructs a IntRangeFilter
with a
lower bound and an upper bound for the range.
Checks if this scope is a subscope of another scope.
Determines whether a node is a local variable definition.
Returns whether a node is contained in the outer most type block.
LAND - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The &&
(conditional AND) operator.
A left (curly) brace ({
).
LE - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The <=
(less than or equal) operator.
Called after all the child nodes have been process.
Returns the length of a String prefix with tabs expanded.
Returns the length of a string ignoring all trailing whitespace.
Checks if the specified line is blank.
Checks if the specified line is a single-line comment without code.
The synchronized
keyword.
LNOT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The !
(logical complement) operator.
Returns the module configurations in a specified file.
Returns the module configurations in a specified file.
Returns the default list of package names.
Returns the package names in a specified file.
Returns the suppression filters in a specified file.
Represents a message that can be localised.
Creates a new LocalizedMessage
instance.
Creates a new LocalizedMessage
instance.
Creates a new LocalizedMessage
instance.
Creates a new LocalizedMessage
instance.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Log a message that has column information.
Helper method to log a LocalizedMessage.
Log a message that has no column information.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
LOR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The ||
(conditional OR) operator.
LT - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The <
(less than) operator.
Main - class com.puppycrawl.tools.checkstyle.
Main Wrapper command line program for the Checker.
Loops over the files specified checking them for errors.
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
MINUS - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The -
(subtraction) operator.
The -=
(subtraction assignment) operator.
MOD - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The %
(remainder) operator.
The %=
(remainder assignment) operator.
Modifiers for type, method, and field declarations.
A module factory creates Objects from a given name.
PACKAGE - static field in class com.puppycrawl.tools.checkstyle.api.
Scope package scope.
Loads a list of package names from a package name XML file.
A factory for creating objects from package names and names.
A list of parameters to a method or constructor.
Static helper method to parses a Java source file.
Parses the specified input source.
PLUS - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The +
(addition) operator.
The +=
(addition assignment) operator.
The --
(postfix decrement) operator.
The ++
(postfix increment) operator.
PRIVATE - static field in class com.puppycrawl.tools.checkstyle.api.
Scope private scope.
Processes a set of files with all FileSetChecks.
Processes a set of files and fires errors to the MessageDispatcher.
Resolves external properties from an
underlying Properties
object.
Creates a new PropertiesExpander.
This class maintains a persistent store of the files that have
checked ok and their associated timestamp.
Resolves properties in module configurations.
PROTECTED - static field in class com.puppycrawl.tools.checkstyle.api.
Scope protected scope.
PUBLIC - static field in class com.puppycrawl.tools.checkstyle.api.
Scope public scope.
returns the list of files (full path name) to process.
Scope - class com.puppycrawl.tools.checkstyle.api.
Scope Represents a Java visibility scope.
Contains utility methods for working on scope.
SEMI - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The statement terminator (;
).
Sets whether to accept or reject on matching severity level.
Set whether to look in C comments.
Set whether to look in C++ comments.
Set the format for a check.
Set the class loader associated with the tree.
Sets the classloader that is used to contextualize filesetchecks.
Set the class path from a reference defined elsewhere.
Sets the CSV values and ranges for column number filtering.
Tells this task to set the named property to "true" when there
is a violation.
Loads the suppressions for a file.
Set the file contents associated with the tree.
Set the FileContents for this filter.
Sets the file extensions that identify the files that pass the
filter of this FileSetCheck.
Sets this AST's first Child.
Sets the CSV values and ranges for line number filtering.
Sets the maximum number of errors allowed.
Sets the maximum number of warings allowed.
Sets the MessageDispatcher that is used to dispatch error
messages to AuditListeners during processing.
Set the format for a message.
Set the global object used to collect messages.
Sets the factory for creating submodules.
Sets the module factory for creating child modules (Checks).
Set the format for a comment that turns off reporting.
Set the format for a comment that turns on reporting.
Sets a properties file for use instead
of individually setting them.
Set the tab width to report errors with.
Adds a set of tokens the check is interested in.
Called by configure() for every child of this component's Configuration.
Instantiates, configures and registers a child AbstractFilter
or FileSetCheck
that is specified in the provided configuration.
Instantiates, configures and registers a Check that is specified
in the provided configuration.
Severity level for a check violation.
An audit listener that counts how many
AuditEvents
of a given severity have been generated.
This is a very simple filter based on severity matching.
SL - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The <<
(shift left) operator.
The <<=
(left shift assignment) operator.
SLIST - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes A list of statements.
SR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The >>
(signed shift right) operator.
The >>=
(signed right shift assignment)
operator.
STAR - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes The *
(multiplication or wildcard) operator.
The *=
(multiplication assignment) operator.
The doclet's starter method.
A static import declaration.
A static initialization block.
A Reader that reads from an underlying String array, assuming each
array element corresponds to one line of text.
A super constructor call.
This filter accepts AuditEvents according to file, check, line, and
column conditions.
Constructs a SuppressElement
for a
file name pattern and and a check class pattern.
A filter that uses comments to suppress audit events.
Constructs a SuppressionCommentFilter.
This filter accepts AuditEvents according to file, check, line, and
column, as specified in a suppression file.
Loads a filter chain of suppressions.
A block of text from an inputfile that does not necessarily
have any grammatical structure.
Contains the constants for all the tokens contained in the Abstract
Syntax Tree.
Doclet which is used to write property file with short descriptions
(first sentences) of TokenTypes' constants.
Responsible for walking an abstract syntax tree and notifying interested
checks at each each node.
Creates a new TreeWalker
instance.
TYPE - static field in class com.puppycrawl.tools.checkstyle.api.
TokenTypes A type.
A type arguments to a type reference or a method/ctor invocation.
A list of type arguments to a type reference or
a method/ctor invocation.
'&' symbol when used in a generic upper or lower bounds constrain
e.g.
A lower bounds on a wildcard type argument.
A type parameter to a class, interface or method definition.
A list of type parameters to a class, interface or
method definition.
An upper bounds on a wildcard type argument or type parameter.