A B C D E F G H I J 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.
ALONE - Static variable in class com.puppycrawl.tools.checkstyle.checks.RightCurlyOption
Represents the policy that the brace must be alone on the line.
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
 
AbstractFormatCheck - class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck.
Abstract class for checks that verify strings using a regular expression.
AbstractFormatCheck(String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
Creates a new AbstractFormatCheck instance.
AbstractImportCheck - class com.puppycrawl.tools.checkstyle.checks.AbstractImportCheck.
Abstract class that provides helper functionality for determining an import name.
AbstractImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractImportCheck
 
AbstractLoader - class com.puppycrawl.tools.checkstyle.AbstractLoader.
Contains the common implementation of a loader, for loading a configuration from an XML file.
AbstractLoader(String, String) - Constructor for class com.puppycrawl.tools.checkstyle.AbstractLoader
Creates a new instance.
AbstractNameCheck - class com.puppycrawl.tools.checkstyle.checks.AbstractNameCheck.
Abstract class for checking that names conform to a specified format.
AbstractNameCheck(String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractNameCheck
Creates a new AbstractNameCheck instance.
AbstractOption - class com.puppycrawl.tools.checkstyle.checks.AbstractOption.
Abstract class that represents options.
AbstractOption(String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractOption
Creates a new AbstractOption instance.
AbstractOptionCheck - class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck.
Abstract class for checks with options.
AbstractOptionCheck(AbstractOption) - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck
Creates a new AbstractOptionCheck instance.
AbstractViolationReporter - class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter.
Serves as an abstract base class for all modules that report inspection findings.
AbstractViolationReporter() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
 
ArrayInitHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler.
Handler for array initialization blocks.
ArrayInitHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
ArrayTypeStyleCheck - class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck.
Checks the style of array type definitions.
ArrayTypeStyleCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
AuditEvent - class com.puppycrawl.tools.checkstyle.AuditEvent.
Raw event for audit.
AuditEvent(Object) - Constructor for class com.puppycrawl.tools.checkstyle.AuditEvent
Creates a new instance.
AuditEvent(Object, String) - Constructor for class com.puppycrawl.tools.checkstyle.AuditEvent
Creates a new AuditEvent instance.
AuditEvent(Object, String, LocalizedMessage) - Constructor for class com.puppycrawl.tools.checkstyle.AuditEvent
Creates a new AuditEvent instance.
AuditListener - interface com.puppycrawl.tools.checkstyle.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
 
AvoidInlineConditionalsCheck - class com.puppycrawl.tools.checkstyle.checks.AvoidInlineConditionalsCheck.
Detects inline conditionals.
AvoidInlineConditionalsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.AvoidInlineConditionalsCheck
 
AvoidNestedBlocksCheck - class com.puppycrawl.tools.checkstyle.checks.AvoidNestedBlocksCheck.
Finds nested blocks.
AvoidNestedBlocksCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.AvoidNestedBlocksCheck
 
AvoidStarImportCheck - class com.puppycrawl.tools.checkstyle.checks.AvoidStarImportCheck.
Check that finds import statements that use the * notation.
AvoidStarImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.AvoidStarImportCheck
 
add(String, Object) - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
Adds a context entry.
add(LocalizedMessage) - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
Logs a message to be reported
addAttribute(String, String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Adds an attribute to this configuration.
addChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Makes a configuration a child of this configuration.
addChild(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Adds new child to AST
addError(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener
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
 
addException(AuditEvent, Throwable) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener
notify that an exception happened while performing audit
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
addFileSetCheck(FileSetCheck) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
addFileset(FileSet) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Adds a set of files (nested fileset attribute).
addFormatter(CheckStyleTask.Formatter) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Add a formatter
addLineAndCol(Integer, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Add a line to this set of lines.
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
atLevelOrGreater(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Determines if the gieven parent expression is equal to or greater than the correct indentation level.
auditFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener
notify that the audit is finished
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
auditStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener
notify that the audit is about to start
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 

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.
BlockOption - class com.puppycrawl.tools.checkstyle.checks.BlockOption.
Represents the policy for checking block statements.
BlockParentHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler.
Handler for parents of blocks ('if', 'else', 'while', etc).
BlockParentHandler(IndentationCheck, String, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Construct an instance of this handler with the given indentation check, name, abstract syntax tree, and parent handler.
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.
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FileLengthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.LineLengthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantImportCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantThrowsCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.TabCharacterCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UnusedImportsCheck
 
branchContains(int) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Checks if this branch of the parse tree contains a token of the provided type.

C

CASE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A group of case clauses.
CHAR_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A character literal.
CHECKSTYLE_BUNDLE - Static variable in class com.puppycrawl.tools.checkstyle.Defn
name of resource bundle for Checkstyle
CLASS_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A class declaration.
COLON - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The : (colon) operator.
COMMA - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The , (comma) operator.
CR - Static variable in class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
Mac-style line separators
CRLF - Static variable in class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
Windows-style line separators
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.
CaseHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler.
Handler for case statements.
CaseHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
CatchHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.CatchHandler.
Handler for catch blocks.
CatchHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.CatchHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
Check - class com.puppycrawl.tools.checkstyle.api.Check.
The base class for checks.
Check() - Constructor for class com.puppycrawl.tools.checkstyle.api.Check
 
CheckStyleTask - class com.puppycrawl.tools.checkstyle.CheckStyleTask.
An implementation of a ANT task for calling checkstyle.
CheckStyleTask() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
CheckStyleTask.Formatter - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter.
Details about a formatter to be used.
CheckStyleTask.Formatter() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
 
CheckStyleTask.FormatterType - class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType.
Poor mans enumeration for the formatter types.
CheckStyleTask.FormatterType() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType
 
CheckStyleTask.Property - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property.
Represents a property that consists of a key and value.
CheckStyleTask.Property() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
Checker - class com.puppycrawl.tools.checkstyle.Checker.
This class provides the functionality to check a set of files.
Checker() - Constructor for class com.puppycrawl.tools.checkstyle.Checker
Creates a new Checker instance.
CheckstyleException - exception com.puppycrawl.tools.checkstyle.api.CheckstyleException.
Represents an error condition within Checkstyle.
CheckstyleException(String) - Constructor for class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance.
CheckstyleException(String, Throwable) - Constructor for class com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance that was caused by another exception.
ClassDefHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler.
Handler for class definitions.
ClassDefHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
Configurable - interface com.puppycrawl.tools.checkstyle.api.Configurable.
A component that can be configured.
Configuration - interface com.puppycrawl.tools.checkstyle.api.Configuration.
A Configuration is used to configure a Configurable component.
ConfigurationLoader - class com.puppycrawl.tools.checkstyle.ConfigurationLoader.
Loads a configuration from a standard configuration XML file.
ConstantNameCheck - class com.puppycrawl.tools.checkstyle.checks.ConstantNameCheck.
Checks that constant names conform to a format specified by the format property.
ConstantNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.ConstantNameCheck
Creates a new ConstantNameCheck instance.
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.
checkChildren(DetailAST, int[], int, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indent level of the children of the specified parent expression.
checkExpressionSubtree(DetailAST, int, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indentation level for an expression subtree.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CatchHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DoWhileHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ForHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ImportHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PackageDefHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.WhileHandler
Check the indentation of the expression we are handling.
checkLCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation of the left curly brace.
checkLParen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation of the left parenthesis.
checkLinesIndent(int, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indentation of consecutive lines for the expression we are handling.
checkModifiers() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indentation level of modifiers.
checkRCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation of the right curly brace.
checkRParen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation of the right parenthesis.
checkToplevelToken() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indent of the top level token.
checkToplevelToken() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ElseHandler
Check the indent of the top level token.
checkToplevelToken() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
Check the indentation of the top level token.
childrenMayNest() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
Determines if child elements within the expression may be nested.
childrenMayNest() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Determines if child elements within the expression may be nested.
closeStreams() - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
Flushes the output streams and closes them if needed.
com.puppycrawl.tools.checkstyle - package com.puppycrawl.tools.checkstyle
Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.api - package com.puppycrawl.tools.checkstyle.api
Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.checks - package com.puppycrawl.tools.checkstyle.checks
Contains the checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.indentation - package com.puppycrawl.tools.checkstyle.checks.indentation
Contains all of the helper classes required for the indentation check.
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.
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.
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.
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.
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.
DefaultConfiguration - class com.puppycrawl.tools.checkstyle.DefaultConfiguration.
Default implementation of the Configuration interface.
DefaultConfiguration(String) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Instantiates a DefaultConfiguration.
DefaultContext - class com.puppycrawl.tools.checkstyle.DefaultContext.
A default implementation of the Context interface.
DefaultContext() - Constructor for class com.puppycrawl.tools.checkstyle.DefaultContext
 
DefaultLogger - class com.puppycrawl.tools.checkstyle.DefaultLogger.
Simple plain logger for text output.
DefaultLogger(OutputStream, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
Creates a new DefaultLogger instance.
DefaultLogger(OutputStream, boolean, OutputStream, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
Creates a new DefaultLogger instance.
Defn - class com.puppycrawl.tools.checkstyle.Defn.
Contains constant definitions common to the package.
DesignForExtensionCheck - class com.puppycrawl.tools.checkstyle.checks.DesignForExtensionCheck.
Checks that classes are designed for inheritance.
DesignForExtensionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.DesignForExtensionCheck
 
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
 
DoWhileHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.DoWhileHandler.
Handler for do...while blocks.
DoWhileHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.DoWhileHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
DoubleCheckedLockingCheck - class com.puppycrawl.tools.checkstyle.checks.DoubleCheckedLockingCheck.
Detect the double-checked locking idiom, a technique that tries to avoid synchronization overhead but is incorrect because of subtle artifacts of the java memory model.
DoubleCheckedLockingCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.DoubleCheckedLockingCheck
 
decode(String) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractOption
Returns the option specified by a string representation.
destroy() - Method in class com.puppycrawl.tools.checkstyle.Checker
Cleans up the object
destroy() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.api.Check
Destroy the check.
destroy() - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
Cleans up the object

E

ELIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An expression list.
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.
EOL - Static variable in class com.puppycrawl.tools.checkstyle.checks.LeftCurlyOption
Represents the policy for placing the brace at the end of line.
EOL - Static variable in class com.puppycrawl.tools.checkstyle.checks.OperatorWrapOption
require that the operator is at the end of the line
EQUAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The == (equal) operator.
ERROR - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: error.
EXPR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An expression.
EXTENDS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An extends clause.
ElseHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.ElseHandler.
Handler for else blocks.
ElseHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ElseHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
EmptyBlockCheck - class com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck.
Checks for empty blocks.
EmptyBlockCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck
Creates a new EmptyBlockCheck instance.
EmptyForIteratorPadCheck - class com.puppycrawl.tools.checkstyle.checks.EmptyForIteratorPadCheck.
Checks the padding of an empty for iterator; that is whether a space is required at an empty for iterator, or such spaces are forbidden.
EmptyForIteratorPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.EmptyForIteratorPadCheck
Sets the paren pad otion to nospace.
EmptyStatementCheck - class com.puppycrawl.tools.checkstyle.checks.EmptyStatementCheck.
Check that finds empty statements.
EmptyStatementCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.EmptyStatementCheck
 
EqualsHashCodeCheck - class com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck.
Checks that classes that override equals() also override hashCode().
EqualsHashCodeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck
 
ExpressionHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler.
Abstract base class for all handlers.
ExpressionHandler(IndentationCheck, String, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Construct an instance of this handler with the given indentation check, name, abstract syntax tree, and parent handler.
encode(String) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
Escape <, > & ' and " as their entities.
endElement(String, String, String) - Method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
The equals method.
error(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.AbstractLoader
 
execute() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Actually checks the files specified.
expandedTabsColumnNo(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Get the column number for the start of a given expression, expanding tabs out into spaces in the process.

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.
FileLengthCheck - class com.puppycrawl.tools.checkstyle.checks.FileLengthCheck.
Checks for long source files.
FileLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.FileLengthCheck
 
FileSetCheck - interface com.puppycrawl.tools.checkstyle.api.FileSetCheck.
Interface for Checking a set of files for some criteria.
FinalClassCheck - class com.puppycrawl.tools.checkstyle.checks.FinalClassCheck.
Checks that class which has only private ctors is declared as final.
FinalClassCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.FinalClassCheck
 
FinalParametersCheck - class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck.
Check that method/constructor parameters are final.
FinalParametersCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
 
FinallyHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.FinallyHandler.
Handler for finally blocks.
FinallyHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.FinallyHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
ForHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.ForHandler.
Handler for for loops.
ForHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ForHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
FullIdent - class com.puppycrawl.tools.checkstyle.api.FullIdent.
Represents a full identifier, including dots, with associated position information.
fatalError(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.AbstractLoader
 
fileFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener
notify that audit is finished on a specific file
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
fileStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditListener
notify that audit is about to start on a specific file
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
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.
findSubtreeLines(LineSet, DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Find the set of lines for a given subtree.
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.Checker
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Provides a hook to finish the part of this compoent's setup that was not handled by the bean introspection.
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
Checks that required args were specified.
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Called after finished processing a tree.
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UnusedImportsCheck
 
fireAuditFinished() - Method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the audit end
fireAuditStarted() - Method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the audit start
fireErrors(String, LocalizedMessage[]) - Method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the errors in a file.
fireErrors(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Notify all listeners about the errors in a file.
fireErrors(String, LocalizedMessage[]) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the errors in a file.
fireFileFinished(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the end of a file audit
fireFileFinished(String) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the end of a file audit
fireFileStarted(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
notify all listeners about the beginning of a file audit
fireFileStarted(String) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the beginning of a file audit
firstLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Get the line number of the first line.
firstLineCol() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Get the starting column for the first line.

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.
GenericIllegalRegexpCheck - class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck.
A generic check for code problems, the user can search for any pattern.
GenericIllegalRegexpCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
Instantiates an new GenericIllegalRegexpCheck.
get(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
 
get(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Context
Searches for the value with the specified attribute key in this context.
getAbstractOption() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.api.Check
The configurable token set.
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck
Prevent user from changing tokens in the configuration.
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceBeforeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.OperatorWrapCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanExpressionCheck
Prevent user from changing tokens in the configuration.
getAttribute(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
 
getAttribute(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
The attribute value for an attribute name
getAttributeNames() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
 
getAttributeNames() - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
 
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.
getBasicOffset() - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Get the basic offset.
getBraceAdjustement() - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Get the brace adjustment amount.
getCComments() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns a map of all C style comments.
getCaseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Get the case indentation level.
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 class com.puppycrawl.tools.checkstyle.DefaultConfiguration
 
getChildren() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
The set of child configurations.
getChildrenExpectedLevel() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
 
getChildrenExpectedLevel() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
 
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.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.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidInlineConditionalsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidNestedBlocksCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidStarImportCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ConstantNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.DesignForExtensionCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.DoubleCheckedLockingCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.EmptyForIteratorPadCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.EmptyStatementCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.FileLengthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.FinalClassCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.HideUtilityClassConstructorCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Get the tokens that this check will handle.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.InnerAssignmentCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.InterfaceIsTypeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.LeftCurlyCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.LineLengthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.LocalFinalVariableNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.LocalVariableNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.MagicNumberCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.MemberNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.MethodLengthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.MethodNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.MissingSwitchDefaultCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ModifierOrderCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NeedBracesCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceAfterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceBeforeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.OperatorWrapCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.PackageNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ParameterNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ParameterNumberCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ParenPadCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantImportCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantThrowsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.RightCurlyCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanExpressionCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanReturnCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.StaticVariableNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TabCharacterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TypeNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UnusedImportsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.WhitespaceAfterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.WhitespaceAroundCheck
 
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.AuditEvent
 
getFilename() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
 
getFirstLine(int, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Get the first line for a given expression.
getFormat() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
 
getHandledTypes() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
gets list of registered handler types
getHandler(IndentationCheck, DetailAST, ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
Get the handler for an AST.
getHandlerFactory() - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Accessor for the handler factory.
getHeaderLines() - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
Return the header lines to check against.
getImportText(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractImportCheck
Return the name of the import associated with a specifed DetailAST.
getIndentCheck() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Accessor for the IndentCheck attribute.
getIndentationTabWidth() - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Get the width of a tab.
getInstance(String) - Static method in class com.puppycrawl.tools.checkstyle.api.Scope
Scope factory method.
getInstance(String) - Static method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
SeverityLevel factory method.
getJavadocBefore(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns the Javadoc comment before the specified line.
getKey() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
getKey() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Returns the message key to locate the translation, can also be used in IDE plugins to map error messages to corrective actions.
getLCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
Get the left curly brace portion of the expression we are handling.
getLCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the left curly brace portion of the expression we are handling.
getLCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
Get the left curly brace portion of the expression we are handling.
getLCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
Get the left curly brace portion of the expression we are handling.
getLCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
Get the left curly brace portion of the expression we are handling.
getLCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
Get the left curly brace portion of the expression we are handling.
getLParen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the left parenthesis portion of the expression we are handling.
getLastChild() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
getLevel() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Get the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
Compute the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
Compute the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Compute the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
Compute the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
Compute the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
Compute the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
Compute the indentation amount for this handler.
getLevelImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
Compute the indentation amount for this handler.
getLine() - Method in class com.puppycrawl.tools.checkstyle.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
 
getLineStart(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Get the start of the line for the given expression.
getLineStart(String) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Get the start of the specified line.
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.
getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
Get the child element representing the list of statements.
getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the child element representing the list of statements.
getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
Get the child element representing the list of statements.
getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
Get the child element representing the list of statements.
getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
Get the child element representing the list of statements.
getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
There is no list of statements child for this handler.
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.AuditEvent
 
getMainAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Accessor for the MainAst attribute.
getMessage() - Method in class com.puppycrawl.tools.checkstyle.AuditEvent
return the message associated to the event.
getMessage() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getMessageBundle() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Returns the message bundle name resourcebundle that contains the messages used by this module.
getMessageCollector() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Returns the collector for violation messages.
getMessageDispatcher() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
A message dispatcher is used to fire violation messages to interested audit listeners.
getMessages() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
 
getName() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
 
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
 
getNonlistChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the child element that is not a list of statements.
getNonlistChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ElseHandler
Get the child element that is not a list of statements.
getNonlistChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
Get the child element that is not a list of statements.
getNonlistChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
There is no child element that is not a list of statements.
getParent() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the parent token
getParent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Accessor for the Parent attribute.
getParentDirs(File[]) - Method in class com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck
Returns the set of directories for a set of files.
getPreviousSibling() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the previous sibling or null if no such sibling exists.
getRCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
Get the right curly brace portion of the expression we are handling.
getRCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the right curly brace portion of the expression we are handling.
getRCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
Get the right curly brace portion of the expression we are handling.
getRCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
Get the right curly brace portion of the expression we are handling.
getRCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
Get the right curly brace portion of the expression we are handling.
getRCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
Get the right curly brace portion of the expression we are handling.
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.
getRParen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the right parenthesis portion of the expression we are handling.
getRegexp() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
 
getRegexp() - Method in class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.api.Check
The tokens that this check must be registered for.
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidInlineConditionalsCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.InterfaceIsTypeCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanExpressionCheck
 
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.AuditEvent
 
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.LocalizedMessage
 
getSourceName() - Method in class com.puppycrawl.tools.checkstyle.AuditEvent
 
getSourceName() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getStartColumn(Integer) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Get the starting column for a given line number.
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractOption
Returns the map from string representations to options.
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.BlockOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.LeftCurlyOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.OperatorWrapOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.PadOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.RightCurlyOption
 
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.
getToplevelAST() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
There is no top level expression for this handler.
getToplevelAST() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the top level expression being managed by this handler.
getToplevelAST() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
There is no top level expression for this handler.
getToplevelAST() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
There is no top level expression for this handler.
getToplevelAST() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
There is no top level expression for this handler.
getToplevelAST() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
There is no top level expression for this handler.
getValue() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
getValues() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.FormatterType
 

H

HandlerFactory - class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory.
Factory for handlers.
HandlerFactory() - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
creates a HandlerFactory
HeaderCheck - class com.puppycrawl.tools.checkstyle.checks.HeaderCheck.
Checks the header of the source against a fixed header file.
HeaderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
 
HiddenFieldCheck - class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck.
Checks that a local variable or a parameter does not shadow a field that is defined in the same class.
HiddenFieldCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck
 
HideUtilityClassConstructorCheck - class com.puppycrawl.tools.checkstyle.checks.HideUtilityClassConstructorCheck.
Make sure that utility classes (classes that contain only static methods) do not have a public constructor.
HideUtilityClassConstructorCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.HideUtilityClassConstructorCheck
 
hasCurlys() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Determines if this block expression has curly braces.
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.
IfHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler.
Handler for if statements.
IfHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
IllegalImportCheck - class com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck.
Checks for imports from a set of illegal packages.
IllegalImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck
Creates a new IllegalImportCheck instance.
IllegalInstantiationCheck - class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck.
Checks for illegal instantiations where a factory method is preferred.
IllegalInstantiationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck
 
ImportHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.ImportHandler.
Handler for import statements.
ImportHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ImportHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
IndentationCheck - class com.puppycrawl.tools.checkstyle.checks.IndentationCheck.
Checks correct indentation of Java Code.
IndentationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Creates a new instance of IndentationCheck
InnerAssignmentCheck - class com.puppycrawl.tools.checkstyle.checks.InnerAssignmentCheck.
Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);.
InnerAssignmentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.InnerAssignmentCheck
 
InterfaceIsTypeCheck - class com.puppycrawl.tools.checkstyle.checks.InterfaceIsTypeCheck.
Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types.
InterfaceIsTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.InterfaceIsTypeCheck
 
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.
indentationLog(int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Log an error message
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.
initialize(Token) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
initialize(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
isEmpty() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Determines if this set of lines is empty.
isHandledType(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
returns true if this type (form TokenTypes) is handled
isIn(Scope) - Method in class com.puppycrawl.tools.checkstyle.api.Scope
Checks if this scope is a subscope of another scope.
isMatch(int) - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
Checks if a code line matches the required header line.
isMatch(int) - Method in class com.puppycrawl.tools.checkstyle.checks.RegexpHeaderCheck
 
isOuterMostType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns whether a node is contained in the outer most type block.
isPackageAllowed() - Method in class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
 
isProtectedAllowed() - Method in class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
 
isReference(String) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 

J

JavadocMethodCheck - class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck.
Checks the Javadoc of a method or constructor.
JavadocMethodCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
 
JavadocTypeCheck - class com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck.
Checks the Javadoc of a type.
JavadocTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck
 
JavadocVariableCheck - class com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck.
Checks that a variable has Javadoc comment.
JavadocVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck
 

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.
LF - Static variable in class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
Unix-style line separators
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.
LabelHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler.
Handler for labels.
LabelHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
LeftCurlyCheck - class com.puppycrawl.tools.checkstyle.checks.LeftCurlyCheck.
Checks the placement of left curly braces on types, methods and other the other blocks: LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE.
LeftCurlyCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.LeftCurlyCheck
Creates a default instance and sets the policy to EOL.
LeftCurlyOption - class com.puppycrawl.tools.checkstyle.checks.LeftCurlyOption.
Represents the options for placing the left curly brace '{'.
LineLengthCheck - class com.puppycrawl.tools.checkstyle.checks.LineLengthCheck.
Checks for long lines.
LineLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.LineLengthCheck
Creates a new LineLengthCheck instance.
LineSeparatorOption - class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption.
Represents the options for line separator settings.
LineSet - class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet.
Represents a set of lines.
LineSet() - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
 
LocalFinalVariableNameCheck - class com.puppycrawl.tools.checkstyle.checks.LocalFinalVariableNameCheck.
Checks that local final variable names conform to a format specified by the format property.
LocalFinalVariableNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.LocalFinalVariableNameCheck
Creates a new LocalFinalVariableNameCheck instance.
LocalVariableNameCheck - class com.puppycrawl.tools.checkstyle.checks.LocalVariableNameCheck.
Checks that local, non-final variable names conform to a format specified by the format property.
LocalVariableNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.LocalVariableNameCheck
Creates a new LocalVariableNameCheck instance.
LocalizedMessage - class com.puppycrawl.tools.checkstyle.api.LocalizedMessage.
Represents a message that can be localised.
LocalizedMessage(int, int, String, String, Object[], SeverityLevel, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, int, String, String, Object[]) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, int, String, String, Object[], SeverityLevel) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, String, String, Object[], SeverityLevel, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, String, String, Object[]) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, String, String, Object[], String) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, String, String, Object[], SeverityLevel) - 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
 
lastLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Get the line number of the last line.
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Called after all the child nodes have been process.
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalClassCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
 
length() - Method in class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
 
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.
loadConfiguration(String, PropertyResolver) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Returns the module configurations in a specified file.
loadModuleFactory(ClassLoader) - Static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Returns the default list of package names.
loadModuleFactory(String) - Static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Returns the package names in a specified file.
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(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.
logChildError(int, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Log child indentation error.
logError(DetailAST, String, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Log an indentation error.
logError(DetailAST, String, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Log an indentation error.

M

METHOD_CALL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A method call.
METHOD_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A method declaration.
MINUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The - (subtraction) operator.
MINUS_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -= (subtraction assignment) operator.
MOD - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The % (remainder) operator.
MODIFIERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Modifiers for type, method, and field declarations.
MOD_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The %= (remainder assignment) operator.
MagicNumberCheck - class com.puppycrawl.tools.checkstyle.checks.MagicNumberCheck.
Checks for magic numbers.
MagicNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.MagicNumberCheck
 
Main - class com.puppycrawl.tools.checkstyle.Main.
Wrapper command line program for the Checker.
Main() - Constructor for class com.puppycrawl.tools.checkstyle.Main
 
MemberNameCheck - class com.puppycrawl.tools.checkstyle.checks.MemberNameCheck.
Checks that instance variable names conform to a format specified by the format property.
MemberNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.MemberNameCheck
Creates a new MemberNameCheck instance.
MessageDispatcher - interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher.
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
MethodCallHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler.
Handler for method calls.
MethodCallHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
MethodDefHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler.
Handler for method definitions.
MethodDefHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
MethodLengthCheck - class com.puppycrawl.tools.checkstyle.checks.MethodLengthCheck.
Checks for long methods.
MethodLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.MethodLengthCheck
 
MethodNameCheck - class com.puppycrawl.tools.checkstyle.checks.MethodNameCheck.
Checks that method names conform to a format specified by the format property.
MethodNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.MethodNameCheck
Creates a new MethodNameCheck instance.
MissingSwitchDefaultCheck - class com.puppycrawl.tools.checkstyle.checks.MissingSwitchDefaultCheck.
Checks that switch statement has "default" clause.
MissingSwitchDefaultCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.MissingSwitchDefaultCheck
 
ModifierOrderCheck - class com.puppycrawl.tools.checkstyle.checks.ModifierOrderCheck.
Checks that the order of modifiers conforms to the suggestions in the Java Language specification, sections 8.1.1, 8.3.1 and 8.4.3.
ModifierOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.ModifierOrderCheck
 
ModuleFactory - interface com.puppycrawl.tools.checkstyle.ModuleFactory.
A module factory creates Objects from a given name.
main(String[]) - Static method in class com.puppycrawl.tools.checkstyle.Main
Loops over the files specified checking them for errors.
matches(byte[]) - Method in class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractNameCheck
Decides whether the name of an AST should be checked against the format regexp.
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ConstantNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.LocalFinalVariableNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.LocalVariableNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.MemberNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ParameterNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.StaticVariableNameCheck
 

N

NL - Static variable in class com.puppycrawl.tools.checkstyle.checks.LeftCurlyOption
Represents the policy that the brace must always be on a new line.
NL - Static variable in class com.puppycrawl.tools.checkstyle.checks.OperatorWrapOption
require that the operator is on a new line
NLOW - Static variable in class com.puppycrawl.tools.checkstyle.checks.LeftCurlyOption
Represents the policy that if the brace will fit on the first line of the statement, taking into account maximum line length, then apply EOL rule.
NOSPACE - Static variable in class com.puppycrawl.tools.checkstyle.checks.PadOption
Represents no spacing following a left parenthesis or preceeding a right one.
NOTHING - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
nothing scope
NOT_EQUAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The != (not equal) operator.
NUM_DOUBLE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A double precision floating point literal.
NUM_FLOAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A single precision floating point literal.
NUM_INT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An integer literal.
NUM_LONG - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A long integer literal.
NeedBracesCheck - class com.puppycrawl.tools.checkstyle.checks.NeedBracesCheck.
Checks for braces around code blocks.
NeedBracesCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.NeedBracesCheck
 
NewlineAtEndOfFileCheck - class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck.
Checks that there is a newline at the end of each file.
NewlineAtEndOfFileCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
 
NoWhitespaceAfterCheck - class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceAfterCheck.
Checks that there is no whitespace after a token.
NoWhitespaceAfterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceAfterCheck
 
NoWhitespaceBeforeCheck - class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceBeforeCheck.
Checks that there is no whitespace before a token.
NoWhitespaceBeforeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceBeforeCheck
 

O

OBJBLOCK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An object block.
ObjectBlockHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler.
Handler for inner classes.
ObjectBlockHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
OperatorWrapCheck - class com.puppycrawl.tools.checkstyle.checks.OperatorWrapCheck.
Checks line wrapping for operators.
OperatorWrapCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.OperatorWrapCheck
Sets the operator wrap option to new line.
OperatorWrapOption - class com.puppycrawl.tools.checkstyle.checks.OperatorWrapOption.
Represents the options for wrapping on an operator.

P

PACKAGE - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
package scope
PACKAGE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The package declaration.
PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A list of parameters to a method or constructor.
PARAMETER_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A parameter declaration.
PLUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The + (addition) operator.
PLUS_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The += (addition assignment) operator.
POST_DEC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -- (postfix decrement) operator.
POST_INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ++ (postfix increment) operator.
PRIVATE - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
private scope
PROTECTED - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
protected scope
PUBLIC - Static variable in class com.puppycrawl.tools.checkstyle.api.Scope
public scope
PackageDefHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.PackageDefHandler.
Handler for package definitions.
PackageDefHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.PackageDefHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
PackageHtmlCheck - class com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck.
Checks that all packages have a package documentation.
PackageHtmlCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck
Creates a new PackageHtmlCheck instance.
PackageNameCheck - class com.puppycrawl.tools.checkstyle.checks.PackageNameCheck.
Checks that package names conform to a format specified by the format property.
PackageNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.PackageNameCheck
Creates a new PackageNameCheck instance.
PackageNamesLoader - class com.puppycrawl.tools.checkstyle.PackageNamesLoader.
Loads a list of package names from a package name XML file.
PadOption - class com.puppycrawl.tools.checkstyle.checks.PadOption.
Represents the options for whitespace around parentheses.
ParameterNameCheck - class com.puppycrawl.tools.checkstyle.checks.ParameterNameCheck.
Checks that parameter names conform to a format specified by the format property.
ParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.ParameterNameCheck
Creates a new ParameterNameCheck instance.
ParameterNumberCheck - class com.puppycrawl.tools.checkstyle.checks.ParameterNumberCheck.
Checks the number of parameters that a method or constructor has.
ParameterNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.ParameterNumberCheck
 
ParenPadCheck - class com.puppycrawl.tools.checkstyle.checks.ParenPadCheck.
Checks the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden, with the exception that it does not check for padding of the right parenthesis at an empty for iterator.
ParenPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.ParenPadCheck
Sets the paren pad otion to nospace.
PrimordialHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler.
A default no-op handler.
PrimordialHandler(IndentationCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
Construct an instance of this handler with the given indentation check.
PropertiesExpander - class com.puppycrawl.tools.checkstyle.PropertiesExpander.
Resolves external properties from an underlying Properties object.
PropertiesExpander(Properties) - Constructor for class com.puppycrawl.tools.checkstyle.PropertiesExpander
Creates a new PropertiesExpander.
PropertyResolver - interface com.puppycrawl.tools.checkstyle.PropertyResolver.
Resolves properties in module configurations.
parse(FileContents) - Static method in class com.puppycrawl.tools.checkstyle.TreeWalker
Static helper method to parses a Java source file.
parseInputSource(InputSource) - Method in class com.puppycrawl.tools.checkstyle.AbstractLoader
Parses the specified input source.
process(File[]) - Method in class com.puppycrawl.tools.checkstyle.Checker
Processes a set of files with all FileSetChecks.
process(File[]) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
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.checks.NewlineAtEndOfFileCheck
 
process(File[]) - Method in class com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck
Checks that each java file in the fileset has a package.html sibling and fires errors for the missing files.
process(File[]) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
This method searches for property files in the specified file array and checks whether the key usage is consistent.

Q

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

R

RCURLY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A right (curly) brace (}).
RPAREN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A right parenthesis ()).
RedundantImportCheck - class com.puppycrawl.tools.checkstyle.checks.RedundantImportCheck.
Checks for imports that are redundant.
RedundantImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.RedundantImportCheck
 
RedundantModifierCheck - class com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck.
Checks for redundant modifiers in interface definitions.
RedundantModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck
 
RedundantThrowsCheck - class com.puppycrawl.tools.checkstyle.checks.RedundantThrowsCheck.
Checks for redundant exceptions declared in throws clause such as duplicates, unchecked exceptions or subclasses of another declared exception.
RedundantThrowsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.RedundantThrowsCheck
 
RegexpHeaderCheck - class com.puppycrawl.tools.checkstyle.checks.RegexpHeaderCheck.
Checks the header of the source against a header file that contains a regular expression for each line of the source header.
RegexpHeaderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.RegexpHeaderCheck
 
RightCurlyCheck - class com.puppycrawl.tools.checkstyle.checks.RightCurlyCheck.
Checks the placement of right curly braces.
RightCurlyCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.RightCurlyCheck
Sets the right curly option to same.
RightCurlyOption - class com.puppycrawl.tools.checkstyle.checks.RightCurlyOption.
Represents the options for placing the right curly brace '}'.
rcurlyMustStart() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
Determines if the right curly brace must be at the start of the line.
rcurlyMustStart() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Determines if the right curly brace must be at the start of the line.
readResolve() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractOption
Ensures that we don't get multiple instances of one AbstractOption during deserialization.
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.
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 through the underlying Properties object.
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.AbstractLoader

S

SAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.RightCurlyOption
Represents the policy that the brace must be on the same line as the next statement.
SEMI - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The statement terminator (;).
SL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The << (shift left) operator.
SLIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A list of statements.
SL_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The <<= (left shift assignment) operator.
SPACE - Static variable in class com.puppycrawl.tools.checkstyle.checks.PadOption
Represents mandatory spacing following a left parenthesis and preceeding a right one.
SR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >> (signed shift right) operator.
SR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >>= (signed right shift assignment) operator.
STAR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The * (multiplication or wildcard) operator.
STAR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The *= (multiplication assignment) operator.
STATIC_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A static initialization block.
STMT - Static variable in class com.puppycrawl.tools.checkstyle.checks.BlockOption
Represents the policy that there is a statement in the 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.
SYSTEM - Static variable in class com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
System default line separators
Scope - class com.puppycrawl.tools.checkstyle.api.Scope.
Represents a Java visibility scope.
ScopeUtils - class com.puppycrawl.tools.checkstyle.api.ScopeUtils.
Contains utility methods for working on scope.
SeverityLevel - class com.puppycrawl.tools.checkstyle.api.SeverityLevel.
Severity level for a check violation.
SimplifyBooleanExpressionCheck - class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanExpressionCheck.
Checks for overly complicated boolean expressions.
SimplifyBooleanExpressionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanExpressionCheck
 
SimplifyBooleanReturnCheck - class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanReturnCheck.
Checks for overly complicated boolean return statements.
SimplifyBooleanReturnCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanReturnCheck
 
SlistHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler.
Handler for a list of statements.
SlistHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
StaticInitHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.StaticInitHandler.
Handler for static initialization blocks.
StaticInitHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.StaticInitHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
StaticVariableNameCheck - class com.puppycrawl.tools.checkstyle.checks.StaticVariableNameCheck.
Checks that static, non-final variable names conform to a format specified by the format property.
StaticVariableNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.StaticVariableNameCheck
Creates a new StaticVariableNameCheck instance.
SwitchHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler.
Handler for switch statements.
SwitchHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
scanFileSets() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
returns the list of files (full path name) to process.
setAllowLineBreaks(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceAfterCheck
Control whether whitespace is flagged at linebreaks.
setAllowLineBreaks(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceBeforeCheck
Control whether whitespace is flagged at linebreaks.
setAllowMarkerInterfaces(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.InterfaceIsTypeCheck
Controls whether marker interfaces like Serializable are allowed.
setAllowMissingParamTags(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
controls whether to allow a method which has parameters to omit matching param tags in the javadoc.
setAllowMissingReturnTag(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
controls whether to allow a method which returns non-void type to omit the return tag in the javadoc.
setAllowMissingThrowsTags(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
controls whether to allow a method which declares that it throws exceptions to omit matching throws tags in the javadoc.
setAllowSubclasses(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantThrowsCheck
Getter for allowSubclasses property
setAllowThrowsTagsForSubclasses(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
controls whether to allow documented exception that are subclass of one of declared exceptions.
setAllowUnchecked(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantThrowsCheck
Getter for allowUnchecked property
setAllowUndeclaredRTE(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
controls whether to allow documented exceptions that are not declared if they are a subclass of java.lang.RuntimeException.
setAuthorFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck
Set the author tag pattern.
setBasedir(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
 
setBasicOffset(int) - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Set the basic offset.
setBraceAdjustment(int) - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Adjusts brace indentation (positive offset).
setCacheFile(String) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
setCaseIndent(int) - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
Set the case indentation level.
setClassLoader(ClassLoader) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
setClassLoader(ClassLoader) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Set the class loader associated with the tree.
setClasses(String) - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck
Sets the classes that are illegal to instantiate.
setClassloader(ClassLoader) - Method in class com.puppycrawl.tools.checkstyle.Checker
Sets the classloader that is used to contextualize filesetchecks.
setClasspath(Path) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Set the class path.
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
 
setFileContents(FileContents) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Set the file contents associated with the tree.
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
setFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
Set the format to the specified regular expression.
setHeaderFile(String) - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
Set the header file to check against.
setHeaderFile(String) - Method in class com.puppycrawl.tools.checkstyle.checks.RegexpHeaderCheck
Sets the file that contains the header to check against.
setIgnoreCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
Set whether or not the match is case sensitive.
setIgnoreLines(int[]) - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
Set the lines numbers to ignore in the header check.
setIgnoreNumbers(float[]) - Method in class com.puppycrawl.tools.checkstyle.checks.MagicNumberCheck
Sets the numbers to ignore in the check.
setIgnorePattern(String) - Method in class com.puppycrawl.tools.checkstyle.checks.LineLengthCheck
Set the ignore pattern.
setIllegalPkgs(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck
Set the list of illegal packages.
setJavaStyle(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
Controls whether to check for Java or C style.
setKey(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
setLineSeparator(String) - Method in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
Sets the line separator to one of 'crlf', 'lf' or 'cr'.
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
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.FileLengthCheck
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.LineLengthCheck
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.MethodLengthCheck
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.ParameterNumberCheck
Sets the maximum number of allowed parameters
setMaxLineLength(int) - Method in class com.puppycrawl.tools.checkstyle.checks.LeftCurlyCheck
Sets the maximum line length used in calculating the placement of the left curly brace.
setMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
Setter for message property
setMessageDispatcher(MessageDispatcher) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
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.
setMessages(LocalizedMessages) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Set the global object used to collect messages.
setModuleFactory(ModuleFactory) - Method in class com.puppycrawl.tools.checkstyle.Checker
Sets the factory for creating submodules.
setModuleFactory(ModuleFactory) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
Sets the module factory for creating child modules (Checks).
setNextSibling(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Sets AST's next sibling
setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck
Set the option to enforce.
setPackageAllowed(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
Set whether package visible members are allowed
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.
setProtectedAllowed(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
Set whether protected members are allowed.
setPublicMemberPattern(String) - Method in class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
Set the pattern for public members to ignore.
setScope(String) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
Set the scope.
setScope(String) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck
Sets the scope to check.
setScope(String) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck
Sets the scope to check.
setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
Sets the severity level.
setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Sets the severity level.
setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Set the tab width to report errors with
setTofile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
Set the file to output to.
setTokens(String[]) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Adds a set of tokens the check is interested in.
setType(CheckStyleTask.FormatterType) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
Set the type of the formatter.
setValue(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
setVersionFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck
Set the version format pattern.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.Checker
Instantiates, configures and registers a FileSetCheck that is specified in the provided configuration.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
Instantiates, configures and registers a Check that is specified in the provided configuration.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Called by configure() for every child of this component's Configuration.
shouldIncraeseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
 
shouldIncraeseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
 
size() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
 
startElement(String, String, String, Attributes) - Method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
 
startsLine(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Determines if the given expression is at the start of a line.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
Indentation level suggested for a child element.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Indentation level suggested for a child element.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ForHandler
Indentation level suggested for a child element.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
Indentation level suggested for a child element.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
Indentation level suggested for a child element.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
Indentation level suggested for a child element.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
Indentation level suggested for a child element.
suggestedChildLevel(ExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
Indentation level suggested for a child element.

T

TEXT - Static variable in class com.puppycrawl.tools.checkstyle.checks.BlockOption
Represents the policy that there is some text in the block.
TYPE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type.
TYPECAST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A type-cast.
TabCharacterCheck - class com.puppycrawl.tools.checkstyle.checks.TabCharacterCheck.
Reports tab characters ('\t') in the source code.
TabCharacterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.TabCharacterCheck
 
TodoCommentCheck - class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.
A check for TODO comments.
TodoCommentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
Creates a new TodoCommentCheck instance.
TokenTypes - class com.puppycrawl.tools.checkstyle.api.TokenTypes.
Contains the constants for all the tokens contained in the Abstract Syntax Tree.
TranslationCheck - class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.
The TranslationCheck class helps to ensure the correct translation of code by checking property files for consistency regarding their keys.
TranslationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Creates a new TranslationCheck instance.
TreeWalker - class com.puppycrawl.tools.checkstyle.TreeWalker.
Responsible for walking an abstract syntax tree and notifying interested checks at each each node.
TreeWalker() - Constructor for class com.puppycrawl.tools.checkstyle.TreeWalker
Creates a new TreeWalker instance.
TryHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler.
Handler for try blocks.
TryHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
TypeNameCheck - class com.puppycrawl.tools.checkstyle.checks.TypeNameCheck.
Checks that type names conform to a format specified by the format property.
TypeNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.TypeNameCheck
Creates a new TypeNameCheck instance.
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.checks.AbstractOption
Returns the string representation of this AbstractOption.
toString() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
 
toplevelMustStartLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Determines if the top level token must start the line.
toplevelMustStartLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CatchHandler
Determines if the top level token must start the line.
toplevelMustStartLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.FinallyHandler
Determines if the top level token must start the line.
toplevelMustStartLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.StaticInitHandler
Determines if the top level token must start the line.

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.
UnusedImportsCheck - class com.puppycrawl.tools.checkstyle.checks.UnusedImportsCheck.
Checks for unused import statements.
UnusedImportsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.UnusedImportsCheck
 
UpperEllCheck - class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck.
Checks that long constants are defined with an uppper ell.
UpperEllCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
 
Utils - class com.puppycrawl.tools.checkstyle.api.Utils.
Contains utility methods.

V

VARIABLE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A field or local variable declaration.
VisibilityModifierCheck - class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck.
Checks visibility of class members.
VisibilityModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
Constructor
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Called to process a token.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractNameCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidInlineConditionalsCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidNestedBlocksCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidStarImportCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.DesignForExtensionCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.DoubleCheckedLockingCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.EmptyForIteratorPadCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.EmptyStatementCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalClassCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.HiddenFieldCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.HideUtilityClassConstructorCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.IndentationCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.InnerAssignmentCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.InterfaceIsTypeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.LeftCurlyCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.MagicNumberCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.MethodLengthCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.MissingSwitchDefaultCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ModifierOrderCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.NeedBracesCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceAfterCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.NoWhitespaceBeforeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.OperatorWrapCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.PackageNameCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ParameterNumberCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ParenPadCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantImportCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantThrowsCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.RightCurlyCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanExpressionCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.SimplifyBooleanReturnCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UnusedImportsCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.WhitespaceAfterCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.WhitespaceAroundCheck
 

W

WARNING - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: warning
WhileHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.WhileHandler.
Handler for while loops.
WhileHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.WhileHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
WhitespaceAfterCheck - class com.puppycrawl.tools.checkstyle.checks.WhitespaceAfterCheck.
Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator.
WhitespaceAfterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.WhitespaceAfterCheck
 
WhitespaceAroundCheck - class com.puppycrawl.tools.checkstyle.checks.WhitespaceAroundCheck.
Checks that a token is surrounded by whitespace.
WhitespaceAroundCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.WhitespaceAroundCheck
 
warning(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.AbstractLoader
 
whitespaceBefore(int, String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
Returns whether the specified string contains only whitespace up to the specified index.

X

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

A B C D E F G H I J L M N O P Q R S T U V W X
Back to the Checkstyle Home Page