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 variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `abstract` keyword.
ANNOTATION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An annotation of a package, type, field, parameter or variable.
ANNOTATIONS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A collection of annotations on a package or enum constant.
ANNOTATION_ARRAY_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An annotation array member initialisation.
ANNOTATION_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An annotation declaration.
ANNOTATION_FIELD_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An annotation field declaration.
ANNOTATION_MEMBER_VALUE_PAIR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An initialisation of an annotation member with a value.
ANONINNER - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
  anon inner scope.
ARRAY_DECLARATOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An array declaration.
ARRAY_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An array initialization.
ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `=` (assignment) operator.
AT - Static variable 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.
AbstractFileSetCheck - class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck.
  Provides common functionality for many FileSetChecks.
AbstractFileSetCheck() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
AbstractLoader - class com.puppycrawl.tools.checkstyle.api.AbstractLoader.
  Contains the common implementation of a loader, for loading a configuration from an XML file.
AbstractLoader(String, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractLoader
  Creates a new instance.
AbstractLoader(Map) - 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.
AbstractViolationReporter() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
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, LocalizedMessage) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
  Creates a new `AuditEvent` instance.
AuditListener - interface com.puppycrawl.tools.checkstyle.api.AuditListener.
  Listener in charge of receiving events from the Checker.
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.
AutomaticBean() - Constructor for class com.puppycrawl.tools.checkstyle.api.AutomaticBean
accept(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.Filter
  Determines whether or not a filtered AuditEvent is accepted.
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
  Determines whether or not a filtered AuditEvent is accepted.
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
  Determines whether or not a filtered AuditEvent is accepted.
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
  Determines whether or not a filtered AuditEvent is accepted.
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
  Determines whether or not a filtered AuditEvent is accepted.
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
  Determines whether or not a filtered AuditEvent is accepted.
add(String, Object) - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
  Adds a context entry.
add(LocalizedMessage) - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
  Logs a message to be reported.
addAttribute(String, String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
  Adds an attribute to this configuration.
addChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
  Makes a configuration a child of this configuration.
addChild(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
  Adds new child to AST.
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
  Print an Emacs compliant line on the error stream.
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
  Notify that an audit error was discovered on a specific file.
addError(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
  Notify that an audit error was discovered on a specific file.
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
  Notify that an audit error was discovered on a specific file.
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
  Notify that an exception happened while performing audit.
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
  Notify that an exception happened while performing audit.
addException(AuditEvent, Throwable) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
  Notify that an exception happened while performing audit.
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
  Notify that an exception happened while performing audit.
addFileSetCheck(FileSetCheck) - Method in class com.puppycrawl.tools.checkstyle.Checker
  Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
addFileset(FileSet) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
  Adds a set of files (nested fileset attribute).
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
  Adds a filter to the end of the audit event filter chain.
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
  Adds a Filter to the set.
addFormatter(CheckStyleTask.Formatter) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
  Add a formatter.
addListener(AuditListener) - Method in class com.puppycrawl.tools.checkstyle.Checker
  Add the listener that will be used to receive events from the audit.
addProperty(CheckStyleTask.Property) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
  Add an override property.
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
  Notify that the audit is finished.
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
  Notify that the audit is finished.
auditFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
  Notify that the audit is finished.
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
  Notify that the audit is finished.
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
  Notify that the audit is about to start.
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
  Notify that the audit is about to start.
auditStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
  Notify that the audit is about to start.
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
  Notify that the audit is about to start.

## B

BAND - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `&` (bitwise AND) operator.
BAND_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `&=` (bitwise AND assignment) operator.
BNOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `~` (bitwise complement) operator.
BOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `|` (bitwise OR) operator.
BOR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `|=` (bitwise OR assignment) operator.
BSR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `>>>` (unsigned shift right) operator.
BSR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `>>>=` (unsigned right shift assignment) operator.
BXOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `^` (bitwise exclusive OR) operator.
BXOR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `^=` (bitwise exclusive OR assignment) operator.
baseClassname(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Called before the starting to process a tree.
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.

## C

CASE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A group of case clauses.
CHAR_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A character literal.
CHECKSTYLE_BUNDLE - Static variable in class com.puppycrawl.tools.checkstyle.Defn
  Name of resource bundle for Checkstyle.
CLASS_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A class declaration.
COLON - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `:` (colon) operator.
COMMA - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `,` (comma) operator.
CTOR_CALL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A constructor call.
CTOR_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A constructor declaration.
Check - class com.puppycrawl.tools.checkstyle.api.Check.
  The base class for checks.
Check() - Constructor for class com.puppycrawl.tools.checkstyle.api.Check
CheckDocsDoclet - class com.puppycrawl.tools.checkstyle.doclets.CheckDocsDoclet.
  Doclet which is used to extract Anakia input files from the Javadoc of Check implementations, so the Check's docs are autogenerated.
CheckDocsDoclet() - Constructor for class com.puppycrawl.tools.checkstyle.doclets.CheckDocsDoclet
CheckStyleTask - class com.puppycrawl.tools.checkstyle.CheckStyleTask.
  An implementation of a ANT task for calling checkstyle.
CheckStyleTask() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask
CheckStyleTask.Formatter - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter.
  Details about a formatter to be used.
CheckStyleTask.Formatter() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
CheckStyleTask.FormatterType - class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType.
  Poor mans enumeration for the formatter types.
CheckStyleTask.FormatterType() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType
CheckStyleTask.Listener - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener.
  Represents a custom listener.
CheckStyleTask.Listener() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener
CheckStyleTask.Property - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property.
  Represents a property that consists of a key and value.
CheckStyleTask.Property() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
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.
CheckstyleException - exception 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.
CommentListener - interface com.puppycrawl.tools.checkstyle.grammars.CommentListener.
  This interface is used to be notified by parser about comments in the parsed code.
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.
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.
clear() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
  Clears the FilterSet.
closeStreams() - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
  Flushes the output streams and closes them if needed.
com.puppycrawl.tools.checkstyle - package com.puppycrawl.tools.checkstyle
  Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.api - package com.puppycrawl.tools.checkstyle.api
  Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.doclets - package com.puppycrawl.tools.checkstyle.doclets
  Contains the doclets used during the build of Checktyle.
com.puppycrawl.tools.checkstyle.filters - package com.puppycrawl.tools.checkstyle.filters
  Contains the filters that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.grammars - package com.puppycrawl.tools.checkstyle.grammars
  Contains the grammar used by the Checkstyle framework.
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
compareTo(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
  Compares the position of this tag in the file with the position of another tag.
configure(Configuration) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
  Implements the Configurable interface using bean introspection.
configure(Configuration) - Method in interface com.puppycrawl.tools.checkstyle.api.Configurable
  Configures this component.
contextualize(Context) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
  Implements the Contextualizable interface using bean introspection.
contextualize(Context) - Method in interface com.puppycrawl.tools.checkstyle.api.Contextualizable
  Sets the context for this Component.
createClasspath() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
createFullIdent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
  Creates a new FullIdent starting from the specified node.
createFullIdentBelow(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
  Creates a new FullIdent starting from the child of the specified node.
createListener(Task) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
  Creates a listener for the formatter.
createModule(String) - Method in interface com.puppycrawl.tools.checkstyle.ModuleFactory
  Creates a new instance of a class from a given name.
createPattern(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
  Helper method to create a regular expression.

## D

DEC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `--` (prefix decrement) operator.
DIV - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `/` (division) operator.
DIV_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `/=` (division assignment) operator.
DOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `.` (dot) operator.
DO_WHILE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  Literal `while` in do-while loop.
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.
DefaultContext() - Constructor for class com.puppycrawl.tools.checkstyle.DefaultContext
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.
DetailAST - class com.puppycrawl.tools.checkstyle.api.DetailAST.
  An extension of the CommonAST that records the line and column number.
DetailAST() - Constructor for class com.puppycrawl.tools.checkstyle.api.DetailAST
destroy() - Method in class com.puppycrawl.tools.checkstyle.Checker
  Cleans up the object.
destroy() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
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 interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
  Cleans up the object.

## E

ELIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An expression list.
ELLIPSIS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A triple dot for variable-length parameters.
EMPTY_STAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The empty statement.
ENUM - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `enum` keyword.
ENUM_CONSTANT_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An enum constant declaration.
ENUM_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An enum declaration.
EOF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The end of file token.
EQUAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `==` (equal) operator.
ERROR - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
  Severity level: error.
EXPR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An expression.
EXTENDS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An extends clause.
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
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
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(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
execute() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
  Actually checks the files specified.

## F

FINAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `final` keyword.
FOR_CONDITION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A for loop condition.
FOR_EACH_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A for-each clause.
FOR_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A for loop initializer.
FOR_ITERATOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A for loop iterator.
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.
FileSetCheck - interface com.puppycrawl.tools.checkstyle.api.FileSetCheck.
  Interface for Checking a set of files for some criteria.
Filter - interface com.puppycrawl.tools.checkstyle.api.Filter.
  An interface for filtering AuditEvents.
FilterSet - class com.puppycrawl.tools.checkstyle.api.FilterSet.
  A filter set applies filters to AuditEvents.
FilterSet() - Constructor for class com.puppycrawl.tools.checkstyle.api.FilterSet
FullIdent - class com.puppycrawl.tools.checkstyle.api.FullIdent.
  Represents a full identifier, including dots, with associated position information.
fatalError(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
  Notify that audit is finished on a specific file.
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
  Notify that audit is finished on a specific file.
fileFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
  Notify that audit is finished on a specific file.
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
  Notify that audit is finished on a specific file.
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
  Notify that audit is about to start on a specific file.
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
  Notify that audit is about to start on a specific file.
fileStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
  Notify that audit is about to start on a specific file.
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
  Notify that audit is about to start on a specific file.
filter(File[]) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
  Determines the set of files this FileSetCheck is interested in.
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.Checker
  Provides a hook to finish the part of this compoent's setup that was not handled by the bean introspection.

  The default implementation does nothing.

finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
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.
finishTree(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, LocalizedMessage[]) - Method in class com.puppycrawl.tools.checkstyle.Checker
  notify all listeners about the errors in a file.
fireErrors(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
  Notify all listeners about the errors in a file.
fireErrors(String, LocalizedMessage[]) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
  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 interface 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 interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
  Notify all listeners about the beginning of a file audit.

## G

GE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `>=` (greater than or equal) operator.
GENERIC_END - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  '>' symbol signifying the end of type arguments or type parameters.
GENERIC_START - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  '<' symbol signifying the start of type arguments or type parameters.
GT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `>` (greater than) operator.
get(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
  Searches for the value with the specified attribute key in this context.
get(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Context
  Searches for the value with the specified attribute key in this context.
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.api.Check
  The configurable token set.
getAttribute(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
  The attribute value for an attribute name.
getAttribute(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
  The attribute value for an attribute name.
getAttributeNames() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
  The set of attribute names.
getAttributeNames() - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
  Returns the names of all atttributes of this context.
getAttributeNames() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
  The set of attribute names.
getAttributeNames() - Method in interface com.puppycrawl.tools.checkstyle.api.Context
  Returns the names of all atttributes of this context.
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.DefaultConfiguration
  The set of child configurations.
getChildren() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
  The set of child configurations.
getClassLoader() - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Returns the class loader associated with the tree.
getClassname() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener
getColumn() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
getColumn() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
  Determines the column number of the tag in the source file.
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.
getDestDir(String[][]) - Static method in class com.puppycrawl.tools.checkstyle.doclets.CheckDocsDoclet
  Return the destination directory for this Javadoc run.
getEndColNo() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
  The column in the inputfile where the text block ends.
getEndLineNo() - Method in interface 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.api.FilterSet
  Returns the Filters of the filter set.
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.CheckStyleTask.Property
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.
getLine() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
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
getName() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
  The name of this configuration.
getName() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
  The name of this configuration.
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.
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(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 interface com.puppycrawl.tools.checkstyle.api.TextBlock
  The column in the inputfile where the text block starts.
getStartLineNo() - Method in interface 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(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.FullIdent
getText() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
  The text content of the text block.
getText() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
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.
getValue() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
getValues() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType

## H

hasIntersectionWithComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
  Checks if the specified position intersects with a comment.
hashCode() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
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

## I

IDENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An identifier.
IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
  Severity level: ignore.
IMPLEMENTS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An implements clause.
IMPORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An import declaration.
INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `++` (prefix increment) operator.
INDEX_OP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The array index operator.
INFO - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
  Severity level: informational.
INSTANCE_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An instance initializer.
INTERFACE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An interface declaration.
inAnnotationBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
  Returns whether a node is directly contained within an annotation block.
inCodeBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
  Returns whether the scope of a node is restricted to a code block.
inEnumBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
  Returns whether a node is directly contained within an enum block.
inInterfaceBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
  Returns whether a node is directly contained within an interface block.
inInterfaceOrAnnotationBlock(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(Token) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
initialize(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
intersects(int, int, int, int) - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
  Checks if this comment intersects with a specified part of the file.
isIn(Scope) - Method in class com.puppycrawl.tools.checkstyle.api.Scope
  Checks if this scope is a subscope of another scope.
isLocalVariableDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
  Determines whether a node is a local variable definition.
isMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
  Determines whether the source of an audit event matches the text of this tag.
isOn() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
  Determines whether the suppression turns checkstyle reporting on or off.
isOuterMostType(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 variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A labeled statement.
LAND - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `&&` (conditional AND) operator.
LCURLY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A left (curly) brace (`{`).
LE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `<=` (less than or equal) operator.
LITERAL_ASSERT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `assert` keyword.
LITERAL_BOOLEAN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `boolean` keyword.
LITERAL_BREAK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `break` keyword.
LITERAL_BYTE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `byte` keyword.
LITERAL_CASE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `case` keyword.
LITERAL_CATCH - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `catch` keyword.
LITERAL_CHAR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `char` keyword.
LITERAL_CLASS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `class` keyword.
LITERAL_CONTINUE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `continue` keyword.
LITERAL_DEFAULT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `default` keyword.
LITERAL_DO - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `do` keyword.
LITERAL_DOUBLE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `double` keyword.
LITERAL_ELSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `else` keyword.
LITERAL_FALSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `false` keyword.
LITERAL_FINALLY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `finally` keyword.
LITERAL_FLOAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `float` keyword.
LITERAL_FOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `for` keyword.
LITERAL_IF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `if` keyword.
LITERAL_INSTANCEOF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `instanceof` operator.
LITERAL_INT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `int` keyword.
LITERAL_INTERFACE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `interface` keyword.
LITERAL_LONG - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `long` keyword.
LITERAL_NATIVE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `native` keyword.
LITERAL_NEW - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `new` keyword.
LITERAL_NULL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `null` keyword.
LITERAL_PRIVATE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `private` keyword.
LITERAL_PROTECTED - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `protected` keyword.
LITERAL_PUBLIC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `public` keyword.
LITERAL_RETURN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `return` keyword.
LITERAL_SHORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `short` keyword.
LITERAL_STATIC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `static` keyword.
LITERAL_SUPER - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `super` keyword.
LITERAL_SWITCH - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `switch` keyword.
LITERAL_SYNCHRONIZED - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `synchronized` keyword.
LITERAL_THIS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `this` keyword.
LITERAL_THROW - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `throw` keyword.
LITERAL_THROWS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `throws` keyword.
LITERAL_TRANSIENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `transient` keyword.
LITERAL_TRUE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `true` keyword.
LITERAL_TRY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `try` keyword.
LITERAL_VOID - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `void` keyword.
LITERAL_VOLATILE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `volatile` keyword.
LITERAL_WHILE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `while` keyword.
LNOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `!` (logical complement) operator.
LOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `||` (conditional OR) operator.
LPAREN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A left parenthesis (`(`).
LT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `<` (less than) operator.
LocalizedMessage - class com.puppycrawl.tools.checkstyle.api.LocalizedMessage.
  Represents a message that can be localised.
LocalizedMessage(int, int, String, String, Object[], SeverityLevel, Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
  Creates a new `LocalizedMessage` instance.
LocalizedMessage(int, int, String, String, Object[], Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
  Creates a new `LocalizedMessage` instance.
LocalizedMessage(int, String, String, Object[], SeverityLevel, Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
  Creates a new `LocalizedMessage` instance.
LocalizedMessage(int, String, String, Object[], 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.
LocalizedMessages() - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
leaveToken(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.
loadConfiguration(String, PropertyResolver) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
  Returns the module configurations in a specified file.
loadConfiguration(String, PropertyResolver, boolean) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
  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.
log(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.AbstractFileSetCheck
  Adds a violation message to the `message collector`.
log(int, String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  Log a 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.
log(int, int, String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  Helper method to log a LocalizedMessage.
log(DetailAST, 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(DetailAST, 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(DetailAST, String, Object, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  Helper method to log a LocalizedMessage.
log(int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  Log a message that has no column information.
log(int, int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  Log a message that has column information.
log(int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Log an error message.
log(int, int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Helper method to log a LocalizedMessage.

## M

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

## N

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

## O

OBJBLOCK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An object block.
optionLength(String) - Static method in class com.puppycrawl.tools.checkstyle.doclets.CheckDocsDoclet
  Returns option length (how many parts are in option).
optionLength(String) - Static method in class com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet
  Returns option length (how many parts are in option).

## P

PACKAGE - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
  package scope.
PACKAGE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The package declaration.
PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A list of parameters to a method or constructor.
PARAMETER_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A parameter declaration.
PLUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `+` (addition) operator.
PLUS_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `+=` (addition assignment) operator.
POST_DEC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `--` (postfix decrement) operator.
POST_INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `++` (postfix increment) operator.
PRIVATE - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
  private scope.
PROTECTED - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
  protected scope.
PUBLIC - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
  public scope.
PackageNamesLoader - class com.puppycrawl.tools.checkstyle.PackageNamesLoader.
  Loads a list of package names from a package name XML file.
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.
PropertyResolver - interface com.puppycrawl.tools.checkstyle.PropertyResolver.
  Resolves properties in module configurations.
parse(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.
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.TreeWalker
  Processes a set of files and fires errors to the MessageDispatcher. The file set to process might contain files that are not interesting to the FileSetCheck. Such files should be ignored, no error message should be fired for them. For example a FileSetCheck that checks java files should ignore html or properties files. Once processiong is done, it is highly recommended to call for the destroy method to close and remove the listeners.
process(File[]) - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
  Processes a set of files and fires errors to the MessageDispatcher.

## Q

QUESTION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `?` (conditional) operator.

## R

RBRACK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `]` symbol.
RCURLY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A right (curly) brace (`}`).
RPAREN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A right parenthesis (`)`).
removeChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
  Removes a child of this configuration.
removeFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
  Removes filter.
removeFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
  Removes filter.
removeListener(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.api.FileContents
  Report the location of a block comment that can span multiple lines. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.
reportBlockComment(String, int, int, int, int) - Method in interface com.puppycrawl.tools.checkstyle.grammars.CommentListener
  Report the location of a block comment that can span multiple lines.
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.api.FileContents
  Report the location of a single line comment that extends from the given point to the end of the line. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.
reportSingleLineComment(String, int, int) - Method in interface 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.
reset() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
  Reset the object.
resolve(String) - Method in class com.puppycrawl.tools.checkstyle.PropertiesExpander
  Resolves a property name to it's value.
resolve(String) - Method in interface 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

## S

SEMI - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The statement terminator (`;`).
SL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `<<` (shift left) operator.
SLIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A list of statements.
SL_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `<<=` (left shift assignment) operator.
SR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `>>` (signed shift right) operator.
SR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `>>=` (signed right shift assignment) operator.
STAR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `*` (multiplication or wildcard) operator.
STAR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `*=` (multiplication assignment) operator.
STATIC_IMPORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A static import declaration.
STATIC_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A static initialization block.
STRICTFP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `strictfp` keyword.
STRING_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A string literal.
SUPER_CTOR_CALL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A super constructor call.
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.
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(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.
SeverityMatchFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
SuppressElement - class com.puppycrawl.tools.checkstyle.filters.SuppressElement.
  This filter accepts AuditEvents according to file, check, line, and column conditions.
SuppressElement(String, String) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressElement
  Constructs a `SuppressElement` for a file name pattern and and a check class 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.
SuppressionCommentFilter.Tag - class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag.
  A Tag holds a suppression comment and its location, and determines whether the supression turns checkstyle reporting on or off.
SuppressionCommentFilter.Tag(int, int, String, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
  Constructs a tag.
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.
SuppressionFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
SuppressionsLoader - class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader.
  Loads a filter chain of suppressions.
scanFileSets() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
  returns the list of files (full path name) to process.
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.
setClassLoader(ClassLoader) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
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.
setClassname(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener
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.Property
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(FileContents) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Set the file contents associated with the tree.
setFileContents(FileContents) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
  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.
setKey(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
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.
setMessageDispatcher(MessageDispatcher) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
  Sets the MessageDispatcher that is used to dispatch error messages to AuditListeners during processing.
setMessageDispatcher(MessageDispatcher) - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
  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(LocalizedMessages) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Set the global object used to collect messages.
setModuleFactory(ModuleFactory) - Method in class com.puppycrawl.tools.checkstyle.Checker
  Sets the factory for creating submodules.
setModuleFactory(ModuleFactory) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
  Sets the module factory for creating child modules (Checks).
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.Checker
  Sets the severity level.
setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  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.TreeWalker
setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Set the tab width to report errors with.
setTofile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
  Set the file to output to.
setTokens(String[]) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Adds a set of tokens the check is interested in.
setType(CheckStyleTask.FormatterType) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
  Set the type of the formatter.
setUseFile(boolean) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
  Sets whether or not we write to a file if it is provided.
setValue(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
setupChild(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(Configuration) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
  Instantiates, configures and registers a Check that is specified in the provided configuration.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
  Called by configure() for every child of this component's Configuration.
size() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
start(RootDoc) - Static method in class com.puppycrawl.tools.checkstyle.doclets.CheckDocsDoclet
  Doclet entry point.
start(RootDoc) - Static method in class com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet
  The doclet's starter method.
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

## T

TYPE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A type.
TYPECAST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A type-cast.
TYPE_ARGUMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A type arguments to a type reference or a method/ctor invocation.
TYPE_ARGUMENTS - Static variable 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 variable 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 variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A lower bounds on a wildcard type argument.
TYPE_PARAMETER - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A type parameter to a class, interface or method definition.
TYPE_PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A list of type parameters to a class, interface or method definition.
TYPE_UPPER_BOUNDS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  An upper bounds on a wildcard type argument or type parameter.
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.
TokenTypesDoclet - class com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet.
  Doclet which is used to write property file with short descriptions (first sentences) of TokenTypes' constants.
TokenTypesDoclet() - Constructor for class com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet
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.
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.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.SuppressionCommentFilter.Tag
toString() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter

## U

UNARY_MINUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The `+` (unary plus) operator.
UNARY_PLUS - Static variable 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 variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  A field or local variable declaration.
validOptions(String[][], DocErrorReporter) - Static method in class com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet
  Checks that only valid options was specified.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.Check
  Called to process a token.

## W

WARNING - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
  Severity level: warning.
WILDCARD_TYPE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
  The type that refers to all types.
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.

## 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.

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

Back to the Checkstyle Home Page