Alphabetical Index

A B C D E F G H I L M N O P Q R S T U V W X

A

ABSTRACT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The abstract keyword.
AbstractFileSetCheck - class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Provides common functionality for many FileSetChecks.
AbstractLoader - class com.puppycrawl.tools.checkstyle.api.AbstractLoader
Contains the common implementation of a loader, for loading a configuration from an XML file.
AbstractLoader(Map) - constructor for class com.puppycrawl.tools.checkstyle.api.AbstractLoader
Creates a new instance.
AbstractLoader(String,String) - constructor for class com.puppycrawl.tools.checkstyle.api.AbstractLoader
Creates a new instance.
AbstractViolationReporter - class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Serves as an abstract base class for all modules that report inspection findings.
accept(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.Filter
Determines whether or not a filtered AuditEvent is accepted.
accept(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
accept(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
accept(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
accept(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
accept(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
accept(Integer) - method in class com.puppycrawl.tools.checkstyle.filters.CSVFilter
Determines whether an Integer matches a CSV integer value.
accept(Integer) - method in class com.puppycrawl.tools.checkstyle.filters.IntFilter
Determines whether or not a filtered Integer is accepted.
accept(Integer) - method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilter
accept(Integer) - method in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilter
add(com.puppycrawl.tools.checkstyle.api.LocalizedMessage) - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
Logs a message to be reported.
add(String,Object) - method in class com.puppycrawl.tools.checkstyle.DefaultContext
Adds a context entry.
addAttribute(String,String) - method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Adds an attribute to this configuration.
addChild(AST) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Adds new child to AST.
Makes a configuration a child of this configuration.
addError(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that an audit error was discovered on a specific file.
addError(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.DefaultLogger
Print an Emacs compliant line on the error stream.
addError(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
addError(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.XMLLogger
Notify that an exception happened while performing audit.
addFileset(FileSet) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Adds a set of files (nested fileset attribute).
addFileSetCheck(com.puppycrawl.tools.checkstyle.api.FileSetCheck) - method in class com.puppycrawl.tools.checkstyle.Checker
Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
addFilter(com.puppycrawl.tools.checkstyle.api.Filter) - method in class com.puppycrawl.tools.checkstyle.Checker
Adds a filter to the end of the audit event filter chain.
addFilter(com.puppycrawl.tools.checkstyle.api.Filter) - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Adds a Filter to the set.
addFilter(com.puppycrawl.tools.checkstyle.filters.IntFilter) - method in class com.puppycrawl.tools.checkstyle.filters.CSVFilter
Adds a IntFilter to the set.
Add a formatter.
addListener(com.puppycrawl.tools.checkstyle.api.AuditListener) - method in class com.puppycrawl.tools.checkstyle.Checker
Add the listener that will be used to receive events from the audit.
Add an override property.
ANNOTATION - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation of a package, type, field, parameter or variable.
ANNOTATION_ARRAY_INIT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation array member initialisation.
ANNOTATION_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation declaration.
ANNOTATION_FIELD_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation field declaration.
ANNOTATION_MEMBER_VALUE_PAIR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An initialisation of an annotation member with a value.
ANNOTATIONS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A collection of annotations on a package or enum constant.
ANONINNER - static field in class com.puppycrawl.tools.checkstyle.api.Scope
anon inner scope.
ARRAY_DECLARATOR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An array declaration.
ARRAY_INIT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An array initialization.
ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
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.
AuditEvent - class com.puppycrawl.tools.checkstyle.api.AuditEvent
Raw event for audit.
AuditEvent(Object) - constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new instance.
AuditEvent(Object,String) - constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
AuditEvent(Object,String,com.puppycrawl.tools.checkstyle.api.LocalizedMessage) - constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
auditFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is finished.
auditFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.DefaultLogger
auditFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
auditFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.XMLLogger
AuditListener - interface com.puppycrawl.tools.checkstyle.api.AuditListener
Listener in charge of receiving events from the Checker.
auditStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is about to start.
auditStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.DefaultLogger
auditStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
auditStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.XMLLogger
AutomaticBean - class com.puppycrawl.tools.checkstyle.api.AutomaticBean
A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configration attributes.

B

BAND - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The & (bitwise AND) operator.
BAND_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The &= (bitwise AND assignment) operator.
baseClassname(String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST) - method in class com.puppycrawl.tools.checkstyle.api.Check
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.
BOR_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The |= (bitwise OR assignment) operator.
branchContains(int) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
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.
BSR_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >>>= (unsigned right shift assignment) operator.
BXOR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ^ (bitwise exclusive OR) operator.
BXOR_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ^= (bitwise exclusive OR assignment) operator.

C

CASE_GROUP - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A group of case clauses.
CHAR_LITERAL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A character literal.
Check - class com.puppycrawl.tools.checkstyle.api.Check
The base class for checks.
Checker - class com.puppycrawl.tools.checkstyle.Checker
This class provides the functionality to check a set of files.
Checker() - constructor for class com.puppycrawl.tools.checkstyle.Checker
Creates a new Checker instance.
CHECKSTYLE_BUNDLE - static field in class com.puppycrawl.tools.checkstyle.Defn
Name of resource bundle for Checkstyle.
CheckstyleException - class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Represents an error condition within Checkstyle.
CheckstyleException(String) - constructor for class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance.
CheckstyleException(String,Throwable) - constructor for class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance that was caused by another exception.
CheckStyleTask - class com.puppycrawl.tools.checkstyle.CheckStyleTask
An implementation of a ANT task for calling checkstyle.
CLASS_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A class declaration.
clear() - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Clears the FilterSet.
close() - method in class com.puppycrawl.tools.checkstyle.StringArrayReader
closeStreams() - method in class com.puppycrawl.tools.checkstyle.DefaultLogger
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.
Comment - class com.puppycrawl.tools.checkstyle.api.Comment
Representation of the comment block.
Comment(String[],int,int,int) - constructor for class com.puppycrawl.tools.checkstyle.api.Comment
Creates new instance.
CommentListener - interface com.puppycrawl.tools.checkstyle.grammars.CommentListener
This interface is used to be notified by parser about comments in the parsed code.
compareTo(Object) - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
compareTo(Object) - method in class com.puppycrawl.tools.checkstyle.api.Scope
compareTo(Object) - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Configurable - interface com.puppycrawl.tools.checkstyle.api.Configurable
A component that can be configured.
Configuration - interface com.puppycrawl.tools.checkstyle.api.Configuration
A Configuration is used to configure a Configurable component.
ConfigurationLoader - class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Loads a configuration from a standard configuration XML file.
configure(com.puppycrawl.tools.checkstyle.api.Configuration) - method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Implements the Configurable interface using bean introspection.
configure(com.puppycrawl.tools.checkstyle.api.Configuration) - method in class com.puppycrawl.tools.checkstyle.api.Configurable
Configures this component.
Context - interface com.puppycrawl.tools.checkstyle.api.Context
A context to be used in subcomponents.
Contextualizable - interface com.puppycrawl.tools.checkstyle.api.Contextualizable
A Component that needs context information from it's container to work.
contextualize(com.puppycrawl.tools.checkstyle.api.Context) - method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Implements the Contextualizable interface using bean introspection.
contextualize(com.puppycrawl.tools.checkstyle.api.Context) - method in class com.puppycrawl.tools.checkstyle.api.Contextualizable
Sets the context for this Component.
createClasspath() - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
createFullIdent(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Creates a new FullIdent starting from the specified node.
createFullIdentBelow(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Creates a new FullIdent starting from the child of the specified node.
createModule(String) - method in class com.puppycrawl.tools.checkstyle.ModuleFactory
Creates a new instance of a class from a given name.
createModule(String) - method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Creates a new instance of a class from a given name, or that name concatenated with "Check".
createPattern(String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Helper method to create a regular expression.
CSVFilter - class com.puppycrawl.tools.checkstyle.filters.CSVFilter
This filter accepts an integer that matches a CSV value, where each value is an integer or a range of integers.
CSVFilter(String) - constructor for class com.puppycrawl.tools.checkstyle.filters.CSVFilter
Constructs a CSVFilter from a CSV, Comma-Separated Values, string.
CTOR_CALL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A constructor call.
CTOR_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A constructor declaration.

D

DEC - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -- (prefix decrement) operator.
DefaultConfiguration - class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Default implementation of the Configuration interface.
DefaultConfiguration(String) - constructor for class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Instantiates a DefaultConfiguration.
DefaultContext - class com.puppycrawl.tools.checkstyle.DefaultContext
A default implementation of the Context interface.
DefaultLogger - class com.puppycrawl.tools.checkstyle.DefaultLogger
Simple plain logger for text output.
DefaultLogger(OutputStream,boolean) - constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
Creates a new DefaultLogger instance.
DefaultLogger(OutputStream,boolean,OutputStream,boolean) - constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
Creates a new DefaultLogger instance.
Defn - class com.puppycrawl.tools.checkstyle.Defn
Contains constant definitions common to the package.
destroy() - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
destroy() - method in class com.puppycrawl.tools.checkstyle.api.Check
Destroy the check.
destroy() - method in class com.puppycrawl.tools.checkstyle.Checker
Cleans up the object.
destroy() - method in class com.puppycrawl.tools.checkstyle.api.FileSetCheck
Cleans up the object.
destroy() - method in class com.puppycrawl.tools.checkstyle.TreeWalker
DetailAST - class com.puppycrawl.tools.checkstyle.api.DetailAST
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.
DIV_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The /= (division assignment) operator.
DO_WHILE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Literal while in do-while loop.
DOT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The . (dot) operator.

E

ELIST - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An expression list.
ELLIPSIS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A triple dot for variable-length parameters.
EMPTY_STAT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The empty statement.
encode(String) - method in class com.puppycrawl.tools.checkstyle.XMLLogger
Escape <, > & ' and " as their entities.
endElement(String,String,String) - method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
ENUM - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The enum keyword.
ENUM_CONSTANT_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An enum constant declaration.
ENUM_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An enum declaration.
EOF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The end of file token.
EQUAL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The == (equal) operator.
equals(Object) - method in class com.puppycrawl.tools.checkstyle.filters.CSVFilter
equals(Object) - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
equals(Object) - method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilter
equals(Object) - method in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilter
equals(Object) - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
equals(Object) - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
The equals method.
equals(Object) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
equals(Object) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
ERROR - static field in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: error.
error(SAXParseException) - method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
execute() - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Actually checks the files specified.
EXPR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An expression.
EXTENDS_CLAUSE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An extends clause.

F

fatalError(SAXParseException) - method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
FileContents - class com.puppycrawl.tools.checkstyle.api.FileContents
Represents the contents of a file.
FileContents(String,String[]) - constructor for class com.puppycrawl.tools.checkstyle.api.FileContents
Creates a new FileContents instance.
fileFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that audit is finished on a specific file.
fileFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.DefaultLogger
fileFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
fileFinished(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.XMLLogger
FileSetCheck - interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
Interface for Checking a set of files for some criteria.
fileStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that audit is about to start on a specific file.
fileStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.DefaultLogger
fileStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
fileStarted(com.puppycrawl.tools.checkstyle.api.AuditEvent) - method in class com.puppycrawl.tools.checkstyle.XMLLogger
Filter - interface com.puppycrawl.tools.checkstyle.api.Filter
An interface for filtering AuditEvents.
filter(File[]) - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Determines the set of files this FileSetCheck is interested in.
FilterSet - class com.puppycrawl.tools.checkstyle.api.FilterSet
A filter set applies filters to AuditEvents.
FINAL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The final keyword.
findFirstToken(int) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the first child token that makes a specified type.
finishLocalSetup() - method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Provides a hook to finish the part of this compoent's setup that was not handled by the bean introspection.
finishLocalSetup() - method in class com.puppycrawl.tools.checkstyle.Checker
finishLocalSetup() - method in class com.puppycrawl.tools.checkstyle.TreeWalker
finishTree(com.puppycrawl.tools.checkstyle.api.DetailAST) - method in class com.puppycrawl.tools.checkstyle.api.Check
Called after finished processing a tree.
fireAuditFinished() - method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the audit end
fireAuditStarted() - method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the audit start
fireErrors(String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
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.
fireFileFinished(String) - method in class com.puppycrawl.tools.checkstyle.Checker
Notify all listeners about the end of a file audit.
fireFileFinished(String) - method in class com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the end of a file audit.
fireFileStarted(String) - method in class com.puppycrawl.tools.checkstyle.Checker
Notify all listeners about the beginning of a file audit.
fireFileStarted(String) - method in class com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the beginning of a file audit.
FOR_CONDITION - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A for loop condition.
FOR_EACH_CLAUSE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A for-each clause.
FOR_INIT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A for loop initializer.
FOR_ITERATOR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A for loop iterator.
FullIdent - class com.puppycrawl.tools.checkstyle.api.FullIdent
Represents a full identifier, including dots, with associated position information.

G

GE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >= (greater than or equal) operator.
GENERIC_END - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
'>' symbol signifying the end of type arguments or type parameters.
GENERIC_START - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
'<' symbol signifying the start of type arguments or type parameters.
get(String) - method in class com.puppycrawl.tools.checkstyle.api.Context
Searches for the value with the specified attribute key in this context.
get(String) - method in class com.puppycrawl.tools.checkstyle.DefaultContext
getAcceptableTokens() - method in class com.puppycrawl.tools.checkstyle.api.Check
The configurable token set.
getAttribute(String) - method in class com.puppycrawl.tools.checkstyle.api.Configuration
The attribute value for an attribute name.
getAttribute(String) - method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
getAttributeNames() - method in class com.puppycrawl.tools.checkstyle.api.Configuration
The set of attribute names.
getAttributeNames() - method in class com.puppycrawl.tools.checkstyle.api.Context
Returns the names of all atttributes of this context.
getAttributeNames() - method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
getAttributeNames() - method in class com.puppycrawl.tools.checkstyle.DefaultContext
getBasedir() - method in class com.puppycrawl.tools.checkstyle.Checker
getCComments() - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns a map of all C style comments.
getCharset() - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
getChildCount() - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the number of child nodes one level below this node.
getChildCount(int) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the number of direct child tokens that have the specified type.
getChildren() - method in class com.puppycrawl.tools.checkstyle.api.Configuration
The set of child configurations.
getChildren() - method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
getClassLoader() - method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the class loader associated with the tree.
getColumn() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
getColumnNo() - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
getColumnNo() - method in class com.puppycrawl.tools.checkstyle.api.FullIdent
getColumnNo() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
getConfiguration() - method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Returns the configuration that was used to configure this component.
getCount() - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
Returns the number of counted events since audit started.
getCppComments() - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns a map of all the C++ style comments.
getDefaultTokens() - method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the default token a check is interested in.
getEndColNo() - method in class com.puppycrawl.tools.checkstyle.api.Comment
getEndColNo() - method in class com.puppycrawl.tools.checkstyle.api.TextBlock
The column in the inputfile where the text block ends.
getEndLineNo() - method in class com.puppycrawl.tools.checkstyle.api.Comment
getEndLineNo() - method in class com.puppycrawl.tools.checkstyle.api.TextBlock
The last line of the text block in the inputfile.
getExceptionLogger() - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Accessor for shared instance of logger which should be used to log all exceptions occured during FileSetCheck work (debug() should be used).
getFileContents() - method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the file contents associated with the tree.
getFileContents() - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
getFileName() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
getFilename() - method in class com.puppycrawl.tools.checkstyle.api.FileContents
getFilterChain() - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
Returns the loaded filter chain.
getFilters() - method in class com.puppycrawl.tools.checkstyle.filters.CSVFilter
Returns the IntFilters of the filter set.
getFilters() - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Returns the Filters of the filter set.
getId() - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Returns the identifier of the reporter.
getInstance(String) - static method in class com.puppycrawl.tools.checkstyle.api.Scope
Scope factory method.
getInstance(String) - static method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
SeverityLevel factory method.
getJavadocBefore(int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns the Javadoc comment before the specified line.
getKey() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Returns the message key to locate the translation, can also be used in IDE plugins to map error messages to corrective actions.
getLastChild() - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
getLine() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
return the line number on the source file where the event occurred.
getLineNo() - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
getLineNo() - method in class com.puppycrawl.tools.checkstyle.api.FullIdent
getLineNo() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
getLines() - method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the lines associated with the tree.
getLines() - method in class com.puppycrawl.tools.checkstyle.api.FileContents
getLines(String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Loads the contents of a file in a String array.
getLines(String,String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Loads the contents of a file in a String array using the named charset.
getListeners() - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Return the list of listeners set in this task.
getLocalizedMessage() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
getMessage() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
return the message associated to the event.
getMessage() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
getMessageBundle() - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Returns the message bundle name resourcebundle that contains the messages used by this module.
getMessageCollector() - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Returns the collector for violation messages.
getMessageDispatcher() - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
A message dispatcher is used to fire violation messages to interested audit listeners.
getMessages() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
getModuleId() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
getModuleId() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
getName() - method in class com.puppycrawl.tools.checkstyle.api.Configuration
The name of this configuration.
getName() - method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
getName() - method in class com.puppycrawl.tools.checkstyle.api.Scope
getName() - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
getParent() - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the parent token.
getPattern(String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
This is a factory method to return an Pattern object for the specified regular expression.
getPattern(String,int) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
This is a factory method to return an Pattern object for the specified regular expression and compile flags.
getPreviousSibling() - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the previous sibling or null if no such sibling exists.
getRequiredTokens() - method in class com.puppycrawl.tools.checkstyle.api.Check
The tokens that this check must be registered for.
getScopeFromMods(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns the Scope specified by the modifier set.
getSeverity() - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Get the severity level's name.
getSeverityLevel() - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Returns the severity level of the messages generated by this module.
getSeverityLevel() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
getSeverityLevel() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
getShortDescription(String) - static method in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Returns the short description of a token for a given name.
getSourceName() - method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
getSourceName() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
getStartColNo() - method in class com.puppycrawl.tools.checkstyle.api.Comment
getStartColNo() - method in class com.puppycrawl.tools.checkstyle.api.TextBlock
The column in the inputfile where the text block starts.
getStartLineNo() - method in class com.puppycrawl.tools.checkstyle.api.Comment
getStartLineNo() - method in class com.puppycrawl.tools.checkstyle.api.TextBlock
The line in the inputfile where the text block starts.
getStrippedFileName(String,String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Create a stripped down version of a filename.
getSurroundingScope(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns the scope of the surrounding "block".
getTabWidth() - method in class com.puppycrawl.tools.checkstyle.api.Check
getText() - method in class com.puppycrawl.tools.checkstyle.api.Comment
getText() - method in class com.puppycrawl.tools.checkstyle.api.FullIdent
getText() - method in class com.puppycrawl.tools.checkstyle.api.TextBlock
The text content of the text block.
getTokenId(String) - static method in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Returns the ID of a token for a given name.
getTokenName(int) - static method in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Returns the name of a token for a given ID.
getTokenNames() - method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the tokens registered for the check.
GT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The > (greater than) operator.

H

hashCode() - method in class com.puppycrawl.tools.checkstyle.filters.CSVFilter
hashCode() - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
hashCode() - method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilter
hashCode() - method in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilter
hashCode() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
hashCode() - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
The hashCode method.
hashCode() - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
hashCode() - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
hasIntersectionWithComment(int,int,int,int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Checks if the specified position intersects with a comment.

I

IDENT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An identifier.
IGNORE - static field in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: ignore.
IMPLEMENTS_CLAUSE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An implements clause.
IMPORT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An import declaration.
inAnnotationBlock(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
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.
inCodeBlock(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether the scope of a node is restricted to a code block.
INDEX_OP - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The array index operator.
inEnumBlock(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is directly contained within an enum block.
INFO - static field in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: informational.
inInterfaceBlock(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is directly contained within an interface block.
inInterfaceOrAnnotationBlock(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
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.
initialize(AST) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
initialize(Token) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
INSTANCE_INIT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An instance initializer.
INTERFACE_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An interface declaration.
intersects(int,int,int,int) - method in class com.puppycrawl.tools.checkstyle.api.Comment
intersects(int,int,int,int) - method in class com.puppycrawl.tools.checkstyle.api.TextBlock
Checks if this comment intersects with a specified part of the file.
IntFilter - interface com.puppycrawl.tools.checkstyle.filters.IntFilter
An interface for filtering Integer.
IntMatchFilter - class com.puppycrawl.tools.checkstyle.filters.IntMatchFilter
This filter accepts a matching Integer.
IntMatchFilter(int) - constructor for class com.puppycrawl.tools.checkstyle.filters.IntMatchFilter
Constructs a MatchFilter for an int.
IntRangeFilter - class com.puppycrawl.tools.checkstyle.filters.IntRangeFilter
This filter accepts an Integer in a range.
IntRangeFilter(int,int) - constructor for class com.puppycrawl.tools.checkstyle.filters.IntRangeFilter
Constructs a IntRangeFilter with a lower bound and an upper bound for the range.
isIn(com.puppycrawl.tools.checkstyle.api.Scope) - method in class com.puppycrawl.tools.checkstyle.api.Scope
Checks if this scope is a subscope of another scope.
isLocalVariableDef(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Determines whether a node is a local variable definition.
isOuterMostType(com.puppycrawl.tools.checkstyle.api.DetailAST) - static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is contained in the outer most type block.
isReference(String) - method in class com.puppycrawl.tools.checkstyle.XMLLogger

L

LABELED_STAT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A labeled statement.
LAND - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The && (conditional AND) operator.
LCURLY - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A left (curly) brace ({).
LE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The <= (less than or equal) operator.
leaveToken(com.puppycrawl.tools.checkstyle.api.DetailAST) - method in class com.puppycrawl.tools.checkstyle.api.Check
Called after all the child nodes have been process.
lengthExpandedTabs(String,int,int) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Returns the length of a String prefix with tabs expanded.
lengthMinusTrailingWhitespace(String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Returns the length of a string ignoring all trailing whitespace.
lineIsBlank(int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Checks if the specified line is blank.
lineIsComment(int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Checks if the specified line is a single-line comment without code.
LITERAL_ASSERT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The assert keyword.
LITERAL_BOOLEAN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The boolean keyword.
LITERAL_BREAK - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The break keyword.
LITERAL_BYTE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The byte keyword.
LITERAL_CASE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The case keyword.
LITERAL_CATCH - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The catch keyword.
LITERAL_CHAR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The char keyword.
LITERAL_CLASS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The class keyword.
LITERAL_CONTINUE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The continue keyword.
LITERAL_DEFAULT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The default keyword.
LITERAL_DO - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The do keyword.
LITERAL_DOUBLE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The double keyword.
LITERAL_ELSE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The else keyword.
LITERAL_FALSE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The false keyword.
LITERAL_FINALLY - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The finally keyword.
LITERAL_FLOAT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The float keyword.
LITERAL_FOR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The for keyword.
LITERAL_IF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The if keyword.
LITERAL_INSTANCEOF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The instanceof operator.
LITERAL_INT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The int keyword.
LITERAL_INTERFACE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The interface keyword.
LITERAL_LONG - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The long keyword.
LITERAL_NATIVE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The native keyword.
LITERAL_NEW - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The new keyword.
LITERAL_NULL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The null keyword.
LITERAL_PRIVATE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The private keyword.
LITERAL_PROTECTED - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The protected keyword.
LITERAL_PUBLIC - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The public keyword.
LITERAL_RETURN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The return keyword.
LITERAL_SHORT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The short keyword.
LITERAL_STATIC - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The static keyword.
LITERAL_SUPER - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The super keyword.
LITERAL_SWITCH - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The switch keyword.
LITERAL_SYNCHRONIZED - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The synchronized keyword.
LITERAL_THIS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The this keyword.
LITERAL_THROW - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The throw keyword.
LITERAL_THROWS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The throws keyword.
LITERAL_TRANSIENT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The transient keyword.
LITERAL_TRUE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The true keyword.
LITERAL_TRY - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The try keyword.
LITERAL_VOID - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The void keyword.
LITERAL_VOLATILE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The volatile keyword.
LITERAL_WHILE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The while keyword.
LNOT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ! (logical complement) operator.
Returns the module configurations from a specified input stream.
Returns the module configurations in a specified file.
Returns the module configurations in a specified file.
loadModuleFactory(ClassLoader) - static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Returns the default list of package names.
loadModuleFactory(String) - static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Returns the package names in a specified file.
loadSuppressions(String) - static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
Returns the suppression filters in a specified file.
LocalizedMessage - class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Represents a message that can be localised.
Creates a new LocalizedMessage instance.
LocalizedMessage(int,int,String,String,Object[],String,Class) - constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
Creates a new LocalizedMessage instance.
LocalizedMessage(int,String,String,Object[],String,Class) - constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessages - class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
Collection of messages.
log(com.puppycrawl.tools.checkstyle.api.DetailAST,String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
Helper method to log a LocalizedMessage.
log(int,int,String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
log(int,int,String,Object) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
log(int,int,String,Object,Object) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
log(int,int,String,Object[]) - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Adds a violation message to the message collector.
log(int,int,String,Object[]) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Log a message that has column information.
log(int,int,String,Object[]) - method in class com.puppycrawl.tools.checkstyle.api.Check
Helper method to log a LocalizedMessage.
log(int,String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Log a message.
log(int,String,aArgs[]) - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Adds a violation message to the message collector.
log(int,String,aArgs[]) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Log a message that has no column information.
log(int,String,aArgs[]) - method in class com.puppycrawl.tools.checkstyle.api.Check
Log an error message.
log(int,String,Object) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
log(int,String,Object,Object) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
LOR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The || (conditional OR) operator.
LPAREN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A left parenthesis (().
LT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The < (less than) operator.

M

Main - class com.puppycrawl.tools.checkstyle.Main
Wrapper command line program for the Checker.
main(String[]) - static method in class com.puppycrawl.tools.checkstyle.Main
Loops over the files specified checking them for errors.
MessageDispatcher - interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
METHOD_CALL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A method call.
METHOD_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A method declaration.
MINUS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The - (subtraction) operator.
MINUS_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -= (subtraction assignment) operator.
MOD - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The % (remainder) operator.
MOD_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The %= (remainder assignment) operator.
MODIFIERS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Modifiers for type, method, and field declarations.
ModuleFactory - interface com.puppycrawl.tools.checkstyle.ModuleFactory
A module factory creates Objects from a given name.

N

normalize(String) - method in class com.puppycrawl.tools.checkstyle.Checker
"normalize" the given absolute path.
NOT_EQUAL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The != (not equal) operator.
NOTHING - static field in class com.puppycrawl.tools.checkstyle.api.Scope
nothing scope.
NUM_DOUBLE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A double precision floating point literal.
NUM_FLOAT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A single precision floating point literal.
NUM_INT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An integer literal.
NUM_LONG - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A long integer literal.

O

OBJBLOCK - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An object block.

P

PACKAGE - static field in class com.puppycrawl.tools.checkstyle.api.Scope
package scope.
PACKAGE_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The package declaration.
PackageNamesLoader - class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Loads a list of package names from a package name XML file.
PackageObjectFactory - class com.puppycrawl.tools.checkstyle.PackageObjectFactory
A factory for creating objects from package names and names.
PARAMETER_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A parameter declaration.
PARAMETERS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A list of parameters to a method or constructor.
parse(com.puppycrawl.tools.checkstyle.api.FileContents) - static method in class com.puppycrawl.tools.checkstyle.TreeWalker
Static helper method to parses a Java source file.
parseInputSource(InputSource) - method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
Parses the specified input source.
PLUS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The + (addition) operator.
PLUS_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The += (addition assignment) operator.
POST_DEC - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -- (postfix decrement) operator.
POST_INC - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ++ (postfix increment) operator.
PRIVATE - static field in class com.puppycrawl.tools.checkstyle.api.Scope
private scope.
process(File[]) - method in class com.puppycrawl.tools.checkstyle.Checker
Processes a set of files with all FileSetChecks.
process(File[]) - method in class com.puppycrawl.tools.checkstyle.api.FileSetCheck
Processes a set of files and fires errors to the MessageDispatcher.
process(File[]) - method in class com.puppycrawl.tools.checkstyle.TreeWalker
PropertiesExpander - class com.puppycrawl.tools.checkstyle.PropertiesExpander
Resolves external properties from an underlying Properties object.
PropertiesExpander(Properties) - constructor for class com.puppycrawl.tools.checkstyle.PropertiesExpander
Creates a new PropertiesExpander.
PropertyCacheFile - class com.puppycrawl.tools.checkstyle.PropertyCacheFile
This class maintains a persistent store of the files that have checked ok and their associated timestamp.
PropertyResolver - interface com.puppycrawl.tools.checkstyle.PropertyResolver
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.

Q

QUESTION - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ? (conditional) operator.

R

RBRACK - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ] symbol.
RCURLY - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A right (curly) brace (}).
read() - method in class com.puppycrawl.tools.checkstyle.StringArrayReader
read(char[],int,int) - method in class com.puppycrawl.tools.checkstyle.StringArrayReader
Removes a child of this configuration.
removeFilter(com.puppycrawl.tools.checkstyle.api.Filter) - method in class com.puppycrawl.tools.checkstyle.Checker
Removes filter.
removeFilter(com.puppycrawl.tools.checkstyle.api.Filter) - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Removes filter.
removeListener(com.puppycrawl.tools.checkstyle.api.AuditListener) - method in class com.puppycrawl.tools.checkstyle.Checker
Removes a given listener.
reportBlockComment(String,int,int,int,int) - method in class com.puppycrawl.tools.checkstyle.grammars.CommentListener
Report the location of a block comment that can span multiple lines.
reportBlockComment(String,int,int,int,int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
reportCComment(int,int,int,int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Report the location of a C-style comment.
reportCppComment(int,int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
Report the location of a C++ style comment.
reportSingleLineComment(String,int,int) - method in class com.puppycrawl.tools.checkstyle.grammars.CommentListener
Report the location of a single line comment that extends from the given point to the end of the line.
reportSingleLineComment(String,int,int) - method in class com.puppycrawl.tools.checkstyle.api.FileContents
reset() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
Reset the object.
resolve(String) - method in class com.puppycrawl.tools.checkstyle.PropertiesExpander
resolve(String) - method in class com.puppycrawl.tools.checkstyle.PropertyResolver
Resolves a property name to it's value.
resolveEntity(String,String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
RPAREN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A right parenthesis ()).

S

scanFileSets() - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
returns the list of files (full path name) to process.
Scope - class com.puppycrawl.tools.checkstyle.api.Scope
Represents a Java visibility scope.
ScopeUtils - class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Contains utility methods for working on scope.
SEMI - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The statement terminator (;).
setAcceptOnMatch(boolean) - method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
Sets whether to accept or reject on matching severity level.
setBasedir(String) - method in class com.puppycrawl.tools.checkstyle.Checker
setCacheFile(String) - method in class com.puppycrawl.tools.checkstyle.TreeWalker
setCharset(String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Sets a named charset.
setCheckC(boolean) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Set whether to look in C comments.
setCheckCPP(boolean) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Set whether to look in C++ comments.
setCheckFormat(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Set the format for a check.
setChecks(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Set the check class pattern.
setClassLoader(ClassLoader) - method in class com.puppycrawl.tools.checkstyle.api.Check
Set the class loader associated with the tree.
setClassloader(ClassLoader) - method in class com.puppycrawl.tools.checkstyle.Checker
Sets the classloader that is used to contextualize filesetchecks.
setClassLoader(ClassLoader) - method in class com.puppycrawl.tools.checkstyle.TreeWalker
setClasspath(Path) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Set the class path.
setClasspathRef(Reference) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Set the class path from a reference defined elsewhere.
setColumns(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Sets the CSV values and ranges for column number filtering.
setConfig(File) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
setConfigURL(URL) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
setFailOnViolation(boolean) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
setFailureProperty(String) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Tells this task to set the named property to "true" when there is a violation.
setFile(File) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
setFile(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
Loads the suppressions for a file.
setFileContents(com.puppycrawl.tools.checkstyle.api.FileContents) - method in class com.puppycrawl.tools.checkstyle.api.Check
Set the file contents associated with the tree.
Set the FileContents for this filter.
setFileExtensions(String[]) - method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Sets the file extensions that identify the files that pass the filter of this FileSetCheck.
setFirstChild(AST) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Sets this AST's first Child.
setId(String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Sets the identifer of the reporter.
setLines(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Sets the CSV values and ranges for line number filtering.
setLocale(Locale) - static method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
setLocaleCountry(String) - method in class com.puppycrawl.tools.checkstyle.Checker
setLocaleLanguage(String) - method in class com.puppycrawl.tools.checkstyle.Checker
setMaxErrors(int) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Sets the maximum number of errors allowed.
setMaxWarnings(int) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Sets the maximum number of warings allowed.
Sets the MessageDispatcher that is used to dispatch error messages to AuditListeners during processing.
setMessageFormat(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Set the format for a message.
setMessages(com.puppycrawl.tools.checkstyle.api.LocalizedMessages) - method in class com.puppycrawl.tools.checkstyle.api.Check
Set the global object used to collect messages.
setModuleFactory(com.puppycrawl.tools.checkstyle.ModuleFactory) - method in class com.puppycrawl.tools.checkstyle.Checker
Sets the factory for creating submodules.
setModuleFactory(com.puppycrawl.tools.checkstyle.ModuleFactory) - method in class com.puppycrawl.tools.checkstyle.TreeWalker
Sets the module factory for creating child modules (Checks).
setModuleId(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Set the module id for filtering.
setNextSibling(AST) - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Sets AST's next sibling.
setOffCommentFormat(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Set the format for a comment that turns off reporting.
setOnCommentFormat(String) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Set the format for a comment that turns on reporting.
setPackageNamesFile(File) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
setProperties(File) - method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Sets a properties file for use instead of individually setting them.
setSeverity(String) - method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Sets the severity level.
setSeverity(String) - method in class com.puppycrawl.tools.checkstyle.Checker
Sets the severity level.
setSeverity(String) - method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
Sets the severity level.
setTabWidth(int) - method in class com.puppycrawl.tools.checkstyle.api.Check
Set the tab width to report errors with.
setTabWidth(int) - method in class com.puppycrawl.tools.checkstyle.TreeWalker
setTokens(String[]) - method in class com.puppycrawl.tools.checkstyle.api.Check
Adds a set of tokens the check is interested in.
setupChild(com.puppycrawl.tools.checkstyle.api.Configuration) - method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Called by configure() for every child of this component's Configuration.
setupChild(com.puppycrawl.tools.checkstyle.api.Configuration) - method in class com.puppycrawl.tools.checkstyle.Checker
Instantiates, configures and registers a child AbstractFilter or FileSetCheck that is specified in the provided configuration.
setupChild(com.puppycrawl.tools.checkstyle.api.Configuration) - method in class com.puppycrawl.tools.checkstyle.TreeWalker
Instantiates, configures and registers a Check that is specified in the provided configuration.
SeverityLevel - class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level for a check violation.
SeverityLevelCounter - class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
An audit listener that counts how many AuditEvents of a given severity have been generated.
SeverityLevelCounter(com.puppycrawl.tools.checkstyle.api.SeverityLevel) - constructor for class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
Creates a new counter.
SeverityMatchFilter - class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
This is a very simple filter based on severity matching.
size() - method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
SL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The << (shift left) operator.
SL_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
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.
SR_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >>= (signed right shift assignment) operator.
STAR - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The * (multiplication or wildcard) operator.
STAR_ASSIGN - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The *= (multiplication assignment) operator.
startElement(String,String,String,Attributes) - method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
startElement(String,String,String,Attributes) - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
*
STATIC_IMPORT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A static import declaration.
STATIC_INIT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A static initialization block.
STRICTFP - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The strictfp keyword.
STRING_LITERAL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A string literal.
StringArrayReader - class com.puppycrawl.tools.checkstyle.StringArrayReader
A Reader that reads from an underlying String array, assuming each array element corresponds to one line of text.
SUPER_CTOR_CALL - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A super constructor call.
SuppressElement - class com.puppycrawl.tools.checkstyle.filters.SuppressElement
This filter processes AuditEvent objects based on the criteria of file, check, module id, line, and column.
SuppressElement(String) - constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Constructs a SuppressElement for a file name pattern.
SuppressionCommentFilter - class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
A filter that uses comments to suppress audit events.
SuppressionCommentFilter() - constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Constructs a SuppressionCommentFilter.
SuppressionFilter - class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
This filter accepts AuditEvents according to file, check, line, and column, as specified in a suppression file.
SuppressionsLoader - class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
Loads a filter chain of suppressions.

T

TextBlock - interface com.puppycrawl.tools.checkstyle.api.TextBlock
A block of text from an inputfile that does not necessarily have any grammatical structure.
TokenTypes - class com.puppycrawl.tools.checkstyle.api.TokenTypes
Contains the constants for all the tokens contained in the Abstract Syntax Tree.
toString() - method in class com.puppycrawl.tools.checkstyle.api.Comment
toString() - method in class com.puppycrawl.tools.checkstyle.filters.CSVFilter
toString() - method in class com.puppycrawl.tools.checkstyle.api.DetailAST
toString() - method in class com.puppycrawl.tools.checkstyle.api.FilterSet
toString() - method in class com.puppycrawl.tools.checkstyle.api.FullIdent
toString() - method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilter
toString() - method in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilter
toString() - method in class com.puppycrawl.tools.checkstyle.api.Scope
toString() - method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
toString() - method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
toString() - method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
TreeWalker - class com.puppycrawl.tools.checkstyle.TreeWalker
Responsible for walking an abstract syntax tree and notifying interested checks at each each node.
TreeWalker() - constructor for class com.puppycrawl.tools.checkstyle.TreeWalker
Creates a new TreeWalker instance.
TYPE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type.
TYPE_ARGUMENT - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type arguments to a type reference or a method/ctor invocation.
TYPE_ARGUMENTS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A list of type arguments to a type reference or a method/ctor invocation.
TYPE_EXTENSION_AND - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
'&' symbol when used in a generic upper or lower bounds constrain e.g.
TYPE_LOWER_BOUNDS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A lower bounds on a wildcard type argument.
TYPE_PARAMETER - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type parameter to a class, interface or method definition.
TYPE_PARAMETERS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A list of type parameters to a class, interface or method definition.
TYPE_UPPER_BOUNDS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An upper bounds on a wildcard type argument or type parameter.
TYPECAST - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type-cast.

U

UNARY_MINUS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The + (unary plus) operator.
UNARY_PLUS - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The - (unary minus) operator.
Utils - class com.puppycrawl.tools.checkstyle.api.Utils
Contains utility methods.

V

VARIABLE_DEF - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A field or local variable declaration.
visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST) - method in class com.puppycrawl.tools.checkstyle.api.Check
Called to process a token.

W

WARNING - static field in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: warning.
warning(SAXParseException) - method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
whitespaceBefore(int,String) - static method in class com.puppycrawl.tools.checkstyle.api.Utils
Returns whether the specified string contains only whitespace up to the specified index.
WILDCARD_TYPE - static field in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The type that refers to all types.

X

XMLLogger - class com.puppycrawl.tools.checkstyle.XMLLogger
Simple XML logger.
XMLLogger(OutputStream,boolean) - constructor for class com.puppycrawl.tools.checkstyle.XMLLogger
Creates a new XMLLogger instance.