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 -