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.
AbstractFileSetCheck - Class in com.puppycrawl.tools.checkstyle.api
Provides common functionality for many FileSetChecks.
AbstractFileSetCheck() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
AbstractLoader - Class in com.puppycrawl.tools.checkstyle.api
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 in com.puppycrawl.tools.checkstyle.api
Serves as an abstract base class for all modules that report inspection findings.
AbstractViolationReporter() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
 
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(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.
addChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Makes a configuration a child of this configuration.
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.
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.
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.
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.
addFileset(FileSet) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Adds a set of files (nested fileset attribute).
addFileSetCheck(FileSetCheck) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Adds a Filter to the set.
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a filter to the end of the audit event filter chain.
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.
ANNOTATION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation of a package, type, field, parameter or variable.
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.
ANNOTATIONS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A collection of annotations on a package or enum constant.
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.
AuditEvent - Class in com.puppycrawl.tools.checkstyle.api
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.
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.
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.
AuditListener - Interface in com.puppycrawl.tools.checkstyle.api
Listener in charge of receiving events from the Checker.
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.
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.
AutomaticBean - Class in com.puppycrawl.tools.checkstyle.api
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
 

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

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.
Check - Class in com.puppycrawl.tools.checkstyle.api
The base class for checks.
Check() - Constructor for class com.puppycrawl.tools.checkstyle.api.Check
 
CheckDocsDoclet - Class in com.puppycrawl.tools.checkstyle.doclets
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
 
Checker - Class in com.puppycrawl.tools.checkstyle
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 variable in class com.puppycrawl.tools.checkstyle.Defn
Name of resource bundle for Checkstyle.
CheckstyleException - Exception in com.puppycrawl.tools.checkstyle.api
Represents an error condition within Checkstyle.
CheckstyleException(String) - Constructor for exception com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance.
CheckstyleException(String, Throwable) - Constructor for exception com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance that was caused by another exception.
CheckStyleTask - Class in com.puppycrawl.tools.checkstyle
An implementation of a ANT task for calling checkstyle.
CheckStyleTask() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
CheckStyleTask.Formatter - Class in com.puppycrawl.tools.checkstyle
Details about a formatter to be used.
CheckStyleTask.Formatter() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
 
CheckStyleTask.FormatterType - Class in com.puppycrawl.tools.checkstyle
Poor mans enumeration for the formatter types.
CheckStyleTask.FormatterType() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType
 
CheckStyleTask.Listener - Class in com.puppycrawl.tools.checkstyle
Represents a custom listener.
CheckStyleTask.Listener() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener
 
CheckStyleTask.Property - Class in com.puppycrawl.tools.checkstyle
Represents a property that consists of a key and value.
CheckStyleTask.Property() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
CLASS_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A class declaration.
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.
COLON - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The : (colon) operator.
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.
COMMA - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The , (comma) operator.
CommentListener - Interface in com.puppycrawl.tools.checkstyle.grammars
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
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.
Configurable - Interface in com.puppycrawl.tools.checkstyle.api
A component that can be configured.
Configuration - Interface in com.puppycrawl.tools.checkstyle.api
A Configuration is used to configure a Configurable component.
ConfigurationLoader - Class in com.puppycrawl.tools.checkstyle
Loads a configuration from a standard configuration XML file.
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.
Context - Interface in com.puppycrawl.tools.checkstyle.api
A context to be used in subcomponents.
Contextualizable - Interface in com.puppycrawl.tools.checkstyle.api
A Component that needs context information from it's container to work.
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.
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.

D

DEC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -- (prefix decrement) operator.
DefaultConfiguration - Class in com.puppycrawl.tools.checkstyle
Default implementation of the Configuration interface.
DefaultConfiguration(String) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Instantiates a DefaultConfiguration.
DefaultContext - Class in com.puppycrawl.tools.checkstyle
A default implementation of the Context interface.
DefaultContext() - Constructor for class com.puppycrawl.tools.checkstyle.DefaultContext
 
DefaultLogger - Class in com.puppycrawl.tools.checkstyle
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 in com.puppycrawl.tools.checkstyle
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 interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
Cleans up the object.
destroy() - Method in class com.puppycrawl.tools.checkstyle.Checker
Cleans up the object.
destroy() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
DetailAST - Class in com.puppycrawl.tools.checkstyle.api
An extension of the CommonAST that records the line and column number.
DetailAST() - Constructor for class com.puppycrawl.tools.checkstyle.api.DetailAST
 
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.
DO_WHILE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Literal while in do-while loop.
DOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The . (dot) operator.

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.
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 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.
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
ERROR - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: error.
execute() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Actually checks the files specified.
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.

F

fatalError(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractLoader
FileContents - Class in com.puppycrawl.tools.checkstyle.api
Represents the contents of a file.
FileContents(String, String[]) - Constructor for class com.puppycrawl.tools.checkstyle.api.FileContents
Creates a new FileContents instance.
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.
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.
FileSetCheck - Interface in com.puppycrawl.tools.checkstyle.api
Interface for Checking a set of files for some criteria.
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.
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.
filter(File[]) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Determines the set of files this FileSetCheck is interested in.
Filter - Interface in com.puppycrawl.tools.checkstyle.api
An interface for filtering AuditEvents.
filterFilesByExtension(File[], String[]) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
Filter a set of files by their extension.
FilterSet - Class in com.puppycrawl.tools.checkstyle.api
A filter set applies filters to AuditEvents.
FilterSet() - Constructor for class com.puppycrawl.tools.checkstyle.api.FilterSet
 
FINAL - Static variable 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
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.TreeWalker
 
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) - 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.
fireErrors(String, LocalizedMessage[]) - Method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the errors in a file.
fireFileFinished(String) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the end of a file audit.
fireFileFinished(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
Notify all listeners about the end 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.
fireFileStarted(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
Notify all listeners about the beginning of a file audit.
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.
FullIdent - Class in com.puppycrawl.tools.checkstyle.api
Represents a full identifier, including dots, with associated position information.

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.
get(String) - Method in interface 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
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 interface com.puppycrawl.tools.checkstyle.api.Configuration
The attribute value for an attribute name.
getAttribute(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
The attribute value for an attribute name.
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.
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.
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 interface com.puppycrawl.tools.checkstyle.api.Configuration
The set of child configurations.
getChildren() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
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.
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.
getKey() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
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
 
getModuleId() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getModuleId() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
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
 
getName() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
The name of this configuration.
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(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
GT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The > (greater than) operator.

H

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
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 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.
inAnnotationBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is directly contained within an annotation block.
INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ++ (prefix increment) operator.
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.
INDEX_OP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The array index operator.
inEnumBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is directly contained within an enum block.
INFO - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: informational.
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
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.
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.
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.
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.
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.
loadConfiguration(InputStream, PropertyResolver, boolean) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Returns the module configurations from a specified input stream.
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 in com.puppycrawl.tools.checkstyle.api
Represents a message that can be localised.
LocalizedMessage(int, int, String, String, Object[], SeverityLevel, String, Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
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.
LocalizedMessage(int, String, String, Object[], SeverityLevel, String, Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
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 in com.puppycrawl.tools.checkstyle.api
Collection of messages.
LocalizedMessages() - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
 
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.
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.

M

Main - Class in com.puppycrawl.tools.checkstyle
Wrapper command line program for the Checker.
Main() - Constructor for class com.puppycrawl.tools.checkstyle.Main
 
main(String[]) - Static method in class com.puppycrawl.tools.checkstyle.Main
Loops over the files specified checking them for errors.
MessageDispatcher - Interface in com.puppycrawl.tools.checkstyle.api
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
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.
MOD_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The %= (remainder assignment) operator.
MODIFIERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Modifiers for type, method, and field declarations.
ModuleFactory - Interface in com.puppycrawl.tools.checkstyle
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 variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The != (not equal) operator.
NOTHING - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
nothing scope.
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.

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.
PackageNamesLoader - Class in com.puppycrawl.tools.checkstyle
Loads a list of package names from a package name XML file.
PARAMETER_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A parameter declaration.
PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A list of parameters to a method or constructor.
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.
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.
process(File[]) - Method in interface 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.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.
PropertiesExpander - Class in com.puppycrawl.tools.checkstyle
Resolves external properties from an underlying Properties object.
PropertiesExpander(Properties) - Constructor for class com.puppycrawl.tools.checkstyle.PropertiesExpander
Creates a new PropertiesExpander.
PropertyResolver - Interface in com.puppycrawl.tools.checkstyle
Resolves properties in module configurations.
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.

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 (}).
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.api.FilterSet
Removes filter.
removeFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
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.
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.
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
RPAREN - Static variable 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 in com.puppycrawl.tools.checkstyle.api
Represents a Java visibility scope.
ScopeUtils - Class in com.puppycrawl.tools.checkstyle.api
Contains utility methods for working on scope.
SEMI - Static variable 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
 
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.
setId(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Sets the identifer of the reporter.
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).
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
 
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.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Called by configure() for every child of this component's Configuration.
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.
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
 
SeverityLevel - Class in com.puppycrawl.tools.checkstyle.api
Severity level for a check violation.
SeverityLevelCounter - Class in com.puppycrawl.tools.checkstyle.api
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 in com.puppycrawl.tools.checkstyle.filters
This is a very simple filter based on severity matching.
SeverityMatchFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
 
size() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
 
SL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The << (shift left) operator.
SL_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The <<= (left shift assignment) operator.
SLIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A list of statements.
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.
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.filters.SuppressionsLoader
startElement(String, String, String, Attributes) - Method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
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.
SuppressElement - Class in com.puppycrawl.tools.checkstyle.filters
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 in com.puppycrawl.tools.checkstyle.filters
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 in com.puppycrawl.tools.checkstyle.filters
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 in com.puppycrawl.tools.checkstyle.filters
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 in com.puppycrawl.tools.checkstyle.filters
Loads a filter chain of suppressions.

T

TextBlock - Interface in com.puppycrawl.tools.checkstyle.api
A block of text from an inputfile that does not necessarily have any grammatical structure.
TokenTypes - Class in com.puppycrawl.tools.checkstyle.api
Contains the constants for all the tokens contained in the Abstract Syntax Tree.
TokenTypesDoclet - Class in com.puppycrawl.tools.checkstyle.doclets
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
 
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
TreeWalker - Class in com.puppycrawl.tools.checkstyle
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 variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type.
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.
TYPECAST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type-cast.

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 in com.puppycrawl.tools.checkstyle.api
Contains utility methods.

V

validOptions(String[][], DocErrorReporter) - Static method in class com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet
Checks that only valid options was specified.
VARIABLE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A field or local variable declaration.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Called to process a token.

W

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

X

XMLLogger - Class in com.puppycrawl.tools.checkstyle
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