Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package  Class  Use  Deprecated   Index 
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ api overview ]  PREV  NEXT
A B C D E F G H I L M N O P Q R S T U V W

A

ABSTRACT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The abstract keyword.
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.
AbstractFileSetCheck - class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck.
Provides common functionality for many FileSetChecks.
AbstractFileSetCheck() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
AbstractViolationReporter - class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter.
Serves as an abstract base class for all modules that report inspection findings.
AbstractViolationReporter() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
 
AbstractViolationReporterTest - class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporterTest.
Tests to ensure that default messagebundle is determined correctly.
AbstractViolationReporterTest() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporterTest
 
AuditEvent - class com.puppycrawl.tools.checkstyle.api.AuditEvent.
Raw event for audit.
AuditEvent(Object) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new instance.
AuditEvent(Object, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
AuditEvent(Object, String, LocalizedMessage) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
AuditListener - interface com.puppycrawl.tools.checkstyle.api.AuditListener.
Listener in charge of receiving events from the Checker.
AutomaticBean - class com.puppycrawl.tools.checkstyle.api.AutomaticBean.
A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configration attributes.
AutomaticBean() - Constructor for class com.puppycrawl.tools.checkstyle.api.AutomaticBean
 
AutomaticBeanTest - class com.puppycrawl.tools.checkstyle.api.AutomaticBeanTest.
 
AutomaticBeanTest() - Constructor for class com.puppycrawl.tools.checkstyle.api.AutomaticBeanTest
 
AutomaticBeanTest.TestBean - class com.puppycrawl.tools.checkstyle.api.AutomaticBeanTest.TestBean.
 
AutomaticBeanTest.TestBean() - Constructor for class com.puppycrawl.tools.checkstyle.api.AutomaticBeanTest.TestBean
 
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
 
add(LocalizedMessage) - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
Logs a message to be reported.
addChild(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Adds new child to AST.
addError(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
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.
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Adds a Filter to the set.
append(String) - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Append the specified text.
append(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Append the specified token and also recalibrate the first line and column.
auditFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is finished.
auditStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is about to start.

B

BAND - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The & (bitwise AND) operator.
BAND_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The &= (bitwise AND assignment) operator.
BNOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ~ (bitwise complement) operator.
BOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The | (bitwise OR) operator.
BOR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The |= (bitwise OR assignment) operator.
BSR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >>> (unsigned shift right) operator.
BSR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >>>= (unsigned right shift assignment) operator.
BXOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ^ (bitwise exclusive OR) operator.
BXOR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ^= (bitwise exclusive OR assignment) operator.
baseClassname(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Called before the starting to process a tree.
branchContains(int) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Checks if this branch of the parse tree contains a token of the provided type.

C

CASE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A group of case clauses.
CHAR_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A character literal.
CLASS_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A class declaration.
COLON - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The : (colon) operator.
COMMA - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The , (comma) operator.
CREATED_RES - Static variable in class com.puppycrawl.tools.checkstyle.api.Utils
Map of all created regular expressions
CTOR_CALL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A constructor call.
CTOR_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A constructor declaration.
Check - class com.puppycrawl.tools.checkstyle.api.Check.
The base class for checks.
Check() - Constructor for class com.puppycrawl.tools.checkstyle.api.Check
 
CheckstyleException - exception com.puppycrawl.tools.checkstyle.api.CheckstyleException.
Represents an error condition within Checkstyle.
CheckstyleException(String) - Constructor for class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance.
CheckstyleException(String, Throwable) - Constructor for class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance that was caused by another exception.
Configurable - interface com.puppycrawl.tools.checkstyle.api.Configurable.
A component that can be configured.
Configuration - interface com.puppycrawl.tools.checkstyle.api.Configuration.
A Configuration is used to configure a Configurable component.
Context - interface com.puppycrawl.tools.checkstyle.api.Context.
A context to be used in subcomponents.
Contextualizable - interface com.puppycrawl.tools.checkstyle.api.Contextualizable.
A Component that needs context information from it's container to work.
clear() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Clears the FilterSet.
com.puppycrawl.tools.checkstyle.api - package com.puppycrawl.tools.checkstyle.api
 
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
 
configure(Configuration) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Implements the Configurable interface using bean introspection.
configure(Configuration) - Method in interface com.puppycrawl.tools.checkstyle.api.Configurable
Configures this component.
contextualize(Context) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Implements the Contextualizable interface using bean introspection.
contextualize(Context) - Method in interface com.puppycrawl.tools.checkstyle.api.Contextualizable
Sets the context for this Component.
convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.api.StrArrayConverter
Convert the specified input object into an output object of the specified type.
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.
createRE(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
Helper method to create a regular expression.

D

DEC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -- (prefix decrement) operator.
DEFAULT_SEVERITY - Static variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
the default severity level if one is not specified
DEFAULT_TAB_WIDTH - Static variable in class com.puppycrawl.tools.checkstyle.api.Check
default tab width for column reporting
DIV - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The / (division) operator.
DIV_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The /= (division assignment) operator.
DOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The . (dot) operator.
DetailAST - class com.puppycrawl.tools.checkstyle.api.DetailAST.
An extension of the CommonAST that records the line and column number.
DetailAST() - Constructor for class com.puppycrawl.tools.checkstyle.api.DetailAST
 
DetailASTTest - class com.puppycrawl.tools.checkstyle.api.DetailASTTest.
TestCase to check DetailAST.
DetailASTTest() - Constructor for class com.puppycrawl.tools.checkstyle.api.DetailASTTest
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.api.Check
Destroy the check.
destroy() - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
Cleans up the object.

E

ELIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An expression list.
EMPTY_OBJECT_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
resuable constant for message formating
EMPTY_STAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The empty statement.
EOF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The end of file token.
EQUAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The == (equal) operator.
ERROR - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: error.
EXCEPTION_LOG - Static variable in class com.puppycrawl.tools.checkstyle.api.Utils
Shared instance of logger for exception logging.
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.
emptyCheck - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporterTest
 
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.
extractCComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns the specified C comment as a String array.
extractFullIdent(FullIdent, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Recursively extract a FullIdent.

F

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

G

GE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >= (greater than or equal) operator.
GT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The > (greater than) operator.
get(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Context
Searches for the value with the specified attribute key in this context.
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.api.Check
The configurable token set.
getAttribute(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
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.
getBranchTokenTypes() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
getBundle(String) - Static method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Find a ResourceBundle for a given bundle name.
getCComments() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns a map of all C style comments.
getCause() - Method in class com.puppycrawl.tools.checkstyle.api.CheckstyleException
 
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.
getClassLoader() - Method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the class loader associated with the tree.
getColumn() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
 
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getConfiguration() - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Returns the configuration that was used to configure this component.
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.
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.
getFileName() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getFilename() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
 
getFilters() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Returns the Filters of the filter set.
getInstance(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Scope
Scope factory method.
getInstance(String) - Static method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
SeverityLevel factory method.
getJavadocBefore(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns the Javadoc comment before the specified line.
getKey() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Returns the message key to locate the translation, can also be used in IDE plugins to map error messages to corrective actions.
getLastChild() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
getLine() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
return the line number on the source file where the event occurred.
getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
 
getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getLines() - Method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the lines associated with the tree.
getLines() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
 
getLines(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
Loads the contents of a file in a String array.
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.
getMessageBundle(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
for unit tests, especially with a class with no package name.
getMessageCollector() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Returns the collector for violation messages.
getMessageDispatcher() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
A message dispatcher is used to fire violation messages to interested audit listeners.
getMessages() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
 
getName() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
The name of this configuration.
getName() - Method in class com.puppycrawl.tools.checkstyle.api.Scope
 
getName() - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
 
getParent() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the parent token.
getPreviousSibling() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the previous sibling or null if no such sibling exists.
getRE(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
This is a factory method to return an RE object for the specified regular expression.
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
 
getSourceName() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getSourceName() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
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
 
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.

H

HASH_MULT - Static variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
hash function multiplicand
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.

I

IDENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An identifier.
IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: ignore.
IMPLEMENTS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An implements clause.
IMPORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An import declaration.
INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ++ (prefix increment) operator.
INDEX_OP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The array index operator.
INFO - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: informational.
INSTANCE_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An instance initializer.
INTERFACE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An interface declaration.
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.
inInterfaceBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is directly contained within an interface block.
init() - Method in class com.puppycrawl.tools.checkstyle.api.Check
Initialse the check.
initCause(Throwable) - Method in class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Initializes the cause of this exception.
initConverters() - Static method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Setup the jakarta-commons-beanutils type converters so they throw a ConversionException instead of using the default value.
initialize(Token) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
initialize(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
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.
isOuterMostType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is contained in the outer most type block.

L

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

M

MATCH_SINGLELINE_COMMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.FileContents
compiled regexp to match a single-line comment line
MATCH_SINGLELINE_COMMENT_PAT - Static variable in class com.puppycrawl.tools.checkstyle.api.FileContents
the pattern to match a single line comment containing only the comment itself -- no code.
METHOD_CALL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A method call.
METHOD_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A method declaration.
MINUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The - (subtraction) operator.
MINUS_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -= (subtraction assignment) operator.
MOD - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The % (remainder) operator.
MODIFIERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Modifiers for type, method, and field declarations.
MOD_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The %= (remainder assignment) operator.
MessageDispatcher - interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher.
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
mArgs - Variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
arguments for MessageFormat
mBranchTokenTypes - Variable in class com.puppycrawl.tools.checkstyle.api.DetailAST
All token types in this branch.
mBuffer - Variable in class com.puppycrawl.tools.checkstyle.api.FullIdent
the string
mBundle - Variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
name of the resource bundle to get messages from
mCComments - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
map of the C comments indexed on the first line of the comment to a list of comments on that line
mCPlusPlusComments - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
map of the C++ comments indexed on the first line of the comment.
mCause - Variable in class com.puppycrawl.tools.checkstyle.api.CheckstyleException
the cause of this exception
mChildCount - Variable in class com.puppycrawl.tools.checkstyle.api.DetailAST
number of children
mCode - Variable in class com.puppycrawl.tools.checkstyle.api.Scope
the SCOPECODE_XYZ value of this scope.
mCode - Variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
the SEVERITYCODE_XYZ value of this severity level.
mColNo - Variable in class com.puppycrawl.tools.checkstyle.api.FullIdent
the column number
mColNo - Variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
the column number
mColumnNo - Variable in class com.puppycrawl.tools.checkstyle.api.DetailAST
the column number
mConf - Variable in class com.puppycrawl.tools.checkstyle.api.AutomaticBeanTest
 
mConfiguration - Variable in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
the configuration of this bean
mDispatcher - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
The dispatcher errors are fired to.
mFileContents - Variable in class com.puppycrawl.tools.checkstyle.api.Check
the current file contents
mFileExtensions - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
the file extensions that are accepted by this filter
mFileName - Variable in class com.puppycrawl.tools.checkstyle.api.AuditEvent
filename event associated with
mFilename - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
the file name
mFilters - Variable in class com.puppycrawl.tools.checkstyle.api.FilterSet
filter set
mJavadocComments - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
map of the Javadoc comments indexed on the last line of the comment.
mKey - Variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
key for the message format
mLineNo - Variable in class com.puppycrawl.tools.checkstyle.api.DetailAST
the line number
mLineNo - Variable in class com.puppycrawl.tools.checkstyle.api.FullIdent
the line number
mLineNo - Variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
the line number
mLines - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
the lines
mLoader - Variable in class com.puppycrawl.tools.checkstyle.api.Check
current class loader
mMessage - Variable in class com.puppycrawl.tools.checkstyle.api.AuditEvent
message associated with the event
mMessages - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
collects the error messages
mMessages - Variable in class com.puppycrawl.tools.checkstyle.api.Check
the object for collecting messages.
mMessages - Variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
contains the messages logged
mName - Variable in class com.puppycrawl.tools.checkstyle.api.AutomaticBeanTest.TestBean
 
mName - Variable in class com.puppycrawl.tools.checkstyle.api.Scope
the name of this scope.
mName - Variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
the name of this severity level.
mParent - Variable in class com.puppycrawl.tools.checkstyle.api.DetailAST
the parent token
mSeverityLevel - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
the severity level of any violations found
mSeverityLevel - Variable in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
the severity level
mSourceName - Variable in class com.puppycrawl.tools.checkstyle.api.