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.blocks.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.
AbstractBeanCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractBeanCheck.
Abstract class for checks that verify Bean implementation.
AbstractBeanCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractBeanCheck
 
AbstractClassNameCheck - class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.
Ensures that the names of abstract classes conforming to some regular expression.
AbstractClassNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
Creates new instance of the check.
AbstractComplexityCheck - class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck.
Base class for checks the calculate complexity based around methods.
AbstractComplexityCheck(int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Creates an instance.
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.
AbstractInterfaceCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractInterfaceCheck.
Abstract class for checking interface requirements.
AbstractInterfaceCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractInterfaceCheck
 
AbstractJ2eeCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractJ2eeCheck.
Abstract class for J2ee component checking.
AbstractJ2eeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractJ2eeCheck
 
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.naming.AbstractNameCheck.
Abstract class for checking that names conform to a specified format.
AbstractNameCheck(String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
Creates a new AbstractNameCheck instance.
AbstractNestedDepthCheck - class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck.
Abstract class which provides helpers functionality for nestedchecks.
AbstractNestedDepthCheck(int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
Creates new instance of checks.
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.
AbstractSuperCheck - class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck.
Abstract class for checking that an overriding method with no parameters invokes the super method.
AbstractSuperCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
 
AbstractTypeAwareCheck - class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.
Abstract class that endeavours to maintain type information for the Java file being checked.
AbstractTypeAwareCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
 
AbstractTypeAwareCheck.ClassInfo - class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo.
Contains class's FullIdent and Class object if we can load it.
AbstractTypeAwareCheck.ClassInfo(FullIdent, Class) - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo
Creates new instance of of class information object.
AbstractTypeAwareCheck.ClassInfo(FullIdent) - Constructor for class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo
Creates new instance of of class information object.
AbstractUsageCheck - class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck.
Performs a usage check for fields, methods, parameters, variables.
AbstractUsageCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Constructs an AbstractUsageCheck.
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
 
AnonInnerLengthCheck - class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck.
Checks for long anonymous inner classes.
AnonInnerLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
 
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.
ArrayTrailingCommaCheck - class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck.
Checks if array initialization contains optional trailing comma.
ArrayTrailingCommaCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
 
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
 
AssignHandler - class com.puppycrawl.tools.checkstyle.checks.indentation.AssignHandler.
Handler for assignements.
AssignHandler(IndentationCheck, DetailAST, ExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.AssignHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
AuditEvent - class com.puppycrawl.tools.checkstyle.api.AuditEvent.
Raw event for audit.
AuditEvent(Object) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new instance.
AuditEvent(Object, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
AuditEvent(Object, String, LocalizedMessage) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
AuditListener - interface com.puppycrawl.tools.checkstyle.api.AuditListener.
Listener in charge of receiving events from the Checker.
AutomaticBean - class com.puppycrawl.tools.checkstyle.api.AutomaticBean.
A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configration attributes.
AutomaticBean() - Constructor for class com.puppycrawl.tools.checkstyle.api.AutomaticBean
 
AvoidInlineConditionalsCheck - class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck.
Detects inline conditionals.
AvoidInlineConditionalsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
 
AvoidNestedBlocksCheck - class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck.
Finds nested blocks.
AvoidNestedBlocksCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
 
AvoidStarImportCheck - class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.
Check that finds import statements that use the * notation.
AvoidStarImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
 
accept(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.Filter
Determines whether or not a filtered AuditEvent is accepted.
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
 
accept(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
Checks if given indentation is accaptable.
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
 
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
 
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
 
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.
addAcceptedIndent(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
Adds one more acceptable indentation level.
addAcceptedIndent(IndentLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
Adds one more acceptable indentation level.
addAttribute(String, String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Adds an attribute to this configuration.
addChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Makes a configuration a child of this configuration.
addChild(AST) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Adds new child to AST.
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
Print an Emacs compliant line on the error stream.
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
addError(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that an audit error was discovered on a specific file.
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
addException(AuditEvent, Throwable) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that an exception happened while performing audit.
addFileSetCheck(FileSetCheck) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
addFileset(FileSet) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Adds a set of files (nested fileset attribute).
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a filter to the end of the audit event filter chain.
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Adds a Filter to the set.
addFormatter(CheckStyleTask.Formatter) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Add a formatter.
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.
applyTo(Set) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Applies this check to a set of nodes.
applyTo(Set) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.OneMethodPrivateFieldCheck
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
auditFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is finished.
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
auditStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is about to start.

B

BAND - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The & (bitwise AND) operator.
BAND_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The &= (bitwise AND assignment) operator.
BEAN - Static variable in class com.puppycrawl.tools.checkstyle.checks.j2ee.PersistenceOption
Represents the bean-managed persistence policy.
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.
BeanManagedMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanManagedMethodChecker.
Checks methods of entity beans with bean-managed persistence.
BeanManagedMethodChecker(EntityBeanCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanManagedMethodChecker
Constructs a BeanManagedMethodChecker.
BeanMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanMethodChecker.
Root class for bean method checks.
BeanMethodChecker(AbstractBeanCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanMethodChecker
Constructs a BeanMethodChecker for a bean check.
BlockOption - class com.puppycrawl.tools.checkstyle.checks.blocks.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.AbstractTypeAwareCheck
 
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.TodoCommentCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree.
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree.
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TabCharacterCheck
 
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.
CONTAINER - Static variable in class com.puppycrawl.tools.checkstyle.checks.j2ee.PersistenceOption
Represents the container-managed persistence policy.
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.Listener - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener.
Represents a custom listener.
CheckStyleTask.Listener() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener
 
CheckStyleTask.Property - class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property.
Represents a property that consists of a key and value.
CheckStyleTask.Property() - Constructor for class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
CheckUtils - class com.puppycrawl.tools.checkstyle.checks.CheckUtils.
Contains utility methods for the checks.
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.
ClassResolver - class com.puppycrawl.tools.checkstyle.checks.ClassResolver.
Utility class to resolve a class name to an actual class.
ClassResolver(ClassLoader, String, Set) - Constructor for class com.puppycrawl.tools.checkstyle.checks.ClassResolver
Creates a new ClassResolver instance.
CommentListener - interface com.puppycrawl.tools.checkstyle.grammars.CommentListener.
This interface is used to be notified by parser about comments in the parsed code.
Configurable - interface com.puppycrawl.tools.checkstyle.api.Configurable.
A component that can be configured.
Configuration - interface com.puppycrawl.tools.checkstyle.api.Configuration.
A Configuration is used to configure a Configurable component.
ConfigurationLoader - class com.puppycrawl.tools.checkstyle.ConfigurationLoader.
Loads a configuration from a standard configuration XML file.
ConstantNameCheck - class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.
Checks that constant names conform to a format specified by the format property.
ConstantNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck
Creates a new ConstantNameCheck instance.
ContainerManagedMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.ContainerManagedMethodChecker.
Checks methods of entity beans with container-managed persistence.
ContainerManagedMethodChecker(EntityBeanCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.ContainerManagedMethodChecker
Constructs a ContainerManagedMethodChecker for a entity bean check.
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.
CovariantEqualsCheck - class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck.
Checks that if a class defines a covariant method equals, then it defines method equals(java.lang.Object).
CovariantEqualsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
 
CyclomaticComplexityCheck - class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck.
Checks cyclomatic complexity against a specified limit.
CyclomaticComplexityCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
Create an instance.
checkBean(DetailAST, String, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractBeanCheck
Checks a bean class requirements.
checkChildren(DetailAST, int[], IndentLevel, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indent level of the children of the specified parent expression.
checkCreateMatch() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker
Checks that every ejbCreate method has a matching ejbPostCreate method.
checkCreateMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanMethodChecker
Checks whether an ejbCreate<METHOD>(...) method of a bean satisfies requirements.
checkCreateMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ContainerManagedMethodChecker
Checks whether an ejbCreate<METHOD>(...) method of an entity bean satisfies requirements.
checkCreateMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker
 
checkCreateMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.HomeInterfaceMethodChecker
Checks create<METHOD>(...) method requirements.
checkCreateMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MessageBeanMethodChecker
 
checkCreateMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.SessionBeanMethodChecker
 
checkExpressionSubtree(DetailAST, IndentLevel, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indentation level for an expression subtree.
checkHomeMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker
Checks whether an ejbHome<METHOD>(...) method of an entity bean satisfies requirements.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AssignHandler
Check the indentation of the expression we are handling.
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, IndentLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indentation of consecutive lines for the expression we are handling.
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanManagedMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ContainerManagedMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.HomeInterfaceMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalHomeInterfaceMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalInterfaceMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Checks whether a method satisfies component requirements.
checkMethod(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Checks whether a method satisfies public, non-static, and final requirements.
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteHomeInterfaceMethodChecker
 
checkMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteInterfaceMethodChecker
 
checkMethods(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.BeanManagedMethodChecker
 
checkMethods(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker
 
checkMethods(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MessageBeanMethodChecker
 
checkMethods(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Checks that the methods of a component satisfy requirements.
checkMethods(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.SessionBeanMethodChecker
 
checkModifiers() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Check the indentation level of modifiers.
checkNotThrows(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Checks that the throws clause of a method definition does no include an Exception.
checkPostCreateMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker
Checks whether an ejbPostCreate<METHOD>(...) method of an entity bean satisfies requirements.
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.
checkSelectMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ContainerManagedMethodChecker
Checks whether an ejbSelect<METHOD>(...) method of an entity bean satisfies requirements.
checkThrows(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Checks that the throws clause of a method definition includes an Exception.
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.
clear() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Clears the FilterSet.
closeStreams() - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
Flushes the output streams and closes them if needed.
com.puppycrawl.tools.checkstyle - package com.puppycrawl.tools.checkstyle
Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.api - package com.puppycrawl.tools.checkstyle.api
Contains the core API to be used to implement checks.
com.puppycrawl.tools.checkstyle.checks - package com.puppycrawl.tools.checkstyle.checks
Contains the checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.blocks - package com.puppycrawl.tools.checkstyle.checks.blocks
Contains the Block checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.coding - package com.puppycrawl.tools.checkstyle.checks.coding
Contains the Coding checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.design - package com.puppycrawl.tools.checkstyle.checks.design
Contains the Design checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.duplicates - package com.puppycrawl.tools.checkstyle.checks.duplicates
Checks that search for duplicate code.
com.puppycrawl.tools.checkstyle.checks.imports - package com.puppycrawl.tools.checkstyle.checks.imports
Contains the Import checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.indentation - package com.puppycrawl.tools.checkstyle.checks.indentation
Contains all classes required for the indentation check.
com.puppycrawl.tools.checkstyle.checks.j2ee - package com.puppycrawl.tools.checkstyle.checks.j2ee
Contains J2EE checks.
com.puppycrawl.tools.checkstyle.checks.javadoc - package com.puppycrawl.tools.checkstyle.checks.javadoc
Contains the Javadoc checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.metrics - package com.puppycrawl.tools.checkstyle.checks.metrics
Contains the Metrics checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.naming - package com.puppycrawl.tools.checkstyle.checks.naming
Contains the Naming checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.sizes - package com.puppycrawl.tools.checkstyle.checks.sizes
Contains the Size checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.usage - package com.puppycrawl.tools.checkstyle.checks.usage
Contains the Usage checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.whitespace - package com.puppycrawl.tools.checkstyle.checks.whitespace
Contains the Whitespace checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.filters - package com.puppycrawl.tools.checkstyle.filters
Contains the filters that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.grammars - package com.puppycrawl.tools.checkstyle.grammars
Contains the grammar used by the Checkstyle framework.
compareTo(Object) - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
compareTo(Object) - Method in class com.puppycrawl.tools.checkstyle.api.Scope
 
compareTo(Object) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
 
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.
constructDottedName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Builds the dotted name String representation of the object contained within an AST.
contextualize(Context) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Implements the Contextualizable interface using bean introspection.
contextualize(Context) - Method in interface com.puppycrawl.tools.checkstyle.api.Contextualizable
Sets the context for this Component.
createClasspath() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
createFullIdent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Creates a new FullIdent starting from the specified node.
createFullIdentBelow(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Creates a new FullIdent starting from the child of the specified node.
createFullType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.CheckUtils
Creates FullIdent for given type 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.
DeclarationOrderCheck - class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.
According to Code Conventions for the Java Programming Language , the parts of a class or interface declaration should appear in the following order Class (static) variables.
DeclarationOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
 
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.
DescendantTokenCheck - class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck.
Checks for restricted tokens beneath other tokens.
DescendantTokenCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
 
DesignForExtensionCheck - class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck.
Checks that classes are designed for inheritance.
DesignForExtensionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.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.coding.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.coding.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.blocks.LeftCurlyOption
Represents the policy for placing the brace at the end of line.
EOL - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.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.blocks.EmptyBlockCheck.
Checks for empty blocks.
EmptyBlockCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
Creates a new EmptyBlockCheck instance.
EmptyForIteratorPadCheck - class com.puppycrawl.tools.checkstyle.checks.whitespace.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.whitespace.EmptyForIteratorPadCheck
Sets the paren pad otion to nospace.
EmptyStatementCheck - class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck.
Check that finds empty statements.
EmptyStatementCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
 
EntityBeanCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanCheck.
Checks that an EntityBean implementation satisfies EntityBean requirements.
EntityBeanCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanCheck
Creates a new EntityBeanCheck instance.
EntityBeanMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker.
Root class for entity bean method checks.
EntityBeanMethodChecker(EntityBeanCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanMethodChecker
Constructs a EntityBeanMethodChecker for a bean check.
EqualsHashCodeCheck - class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck.
Checks that classes that override equals() also override hashCode().
EqualsHashCodeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
 
ExecutableStatementCountCheck - class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.
Restricts the number of executable statements to a specified limit (default = 30).
ExecutableStatementCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
Constructs a ExecutableStatementCountCheck.
ExplicitInitializationCheck - class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck.
Checks if any class or object member explicitly initialized to default for its type value (null for object references, zero for numeric types and char and false for boolean.
ExplicitInitializationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
 
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
 
equalTypes(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Tests whether two type AST nodes have the same type.
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
The equals method.
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
 
error(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.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.sizes.FileLengthCheck.
Checks for long source files.
FileLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
 
FileSetCheck - interface com.puppycrawl.tools.checkstyle.api.FileSetCheck.
Interface for Checking a set of files for some criteria.
Filter - interface com.puppycrawl.tools.checkstyle.api.Filter.
An interface for filtering AuditEvents.
FilterSet - class com.puppycrawl.tools.checkstyle.api.FilterSet.
A filter set applies filters to AuditEvents.
FilterSet() - Constructor for class com.puppycrawl.tools.checkstyle.api.FilterSet
 
FinalClassCheck - class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.
Checks that class which has only private ctors is declared as final.
FinalClassCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
 
FinalLocalVariableCheck - class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.
Ensures that local variables that never get their values changed, must be declared final.
FinalLocalVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
 
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
 
FinalStaticCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.FinalStaticCheck.
Checks that all static fields are declared final.
FinalStaticCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.FinalStaticCheck
 
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 class com.puppycrawl.tools.checkstyle.DefaultLogger
 
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
fileFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that audit is finished on a specific file.
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
fileStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that audit is about to start on a specific file.
filter(File[]) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Determines the set of files this FileSetCheck is interested in.
findFirstToken(int) - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the first child token that makes a specified type.
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.coding.EqualsHashCodeCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
 
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.
getASTManager() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Gets the manager for AST nodes.
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.DescendantTokenCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
Prevent user from changing tokens in the configuration.
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
Prevent user from changing tokens in the configuration.
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
 
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.indentation.ExpressionHandler
A shortcut for IndentationCheck property.
getBasicOffset() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Get the basic offset.
getBraceAdjustement() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
A shortcut for IndentationCheck property.
getBraceAdjustement() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.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.indentation.IndentationCheck
Get the case indentation level.
getCause() - Method in class com.puppycrawl.tools.checkstyle.api.CheckstyleException
 
getCheck() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Gets the client Check.
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.
getClassname() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener
 
getClazz() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo
 
getColumn() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
 
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getConfiguration() - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Returns the configuration that was used to configure this component.
getCppComments() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns a map of all the C++ style comments.
getCurrentValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
 
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.DescendantTokenCheck
 
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.ModifierOrderCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DoubleCheckedLockingCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.JUnitTestCaseCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Get the tokens that this check will handle.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractBeanCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractInterfaceCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.FinalStaticCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisParameterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisReturnCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
The default tokens this Check is used for.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.OneMethodPrivateFieldCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedLocalVariableCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedParameterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateFieldCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateMethodCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TabCharacterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
 
getEndLineNo() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
The last line of the text block in the inputfile.
getErrorKey() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Returns the key for the Checkstyle error message.
getErrorKey() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.OneMethodPrivateFieldCheck
 
getErrorKey() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedLocalVariableCheck
 
getErrorKey() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedParameterCheck
 
getErrorKey() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateFieldCheck
 
getErrorKey() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateMethodCheck
 
getExceptionLogger() - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
Accessor for shared instance of logger which should be used to log all exceptions occured during FileSetCheck work (debug() should be used).
getFileContents() - Method in class com.puppycrawl.tools.checkstyle.api.Check
Returns the file contents associated with the tree.
getFileName() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getFilename() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
 
getFilterChain() - Method in class com.puppycrawl.tools.checkstyle.SuppressionsLoader
Returns the loaded filter chain.
getFilters() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Returns the Filters of the filter set.
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.
getHeaderLines() - Method in class com.puppycrawl.tools.checkstyle.checks.HeaderCheck
Return the header lines to check against.
getIgnoreFormat() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
 
getIgnoredMethodNames() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Set the list of ignored method names.
getIllegalClassNames() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Set the list of illegal variable types.
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.indentation.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.api.AuditEvent
return the line number on the source file where the event occurred.
getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.DetailAST
 
getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
 
getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
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.api.AuditEvent
 
getMainAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Accessor for the MainAst attribute.
getMax() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
Getter for maximum allowed nesting depth.
getMax() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
Getter for max property.
getMax() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
Getter for max property.
getMax() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
 
getMax() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
Gets the maximum threshold.
getMessage() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
return the message associated to the event.
getMessage() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getMessage() - Method in class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
Getter for message property.
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.
getMessageID() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
 
getMessageID() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
getMessages() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
 
getMethodChecker() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractJ2eeCheck
Gets the method checker for this component check.
getMethodName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
Returns the name of the overriding method.
getMethodName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SuperCloneCheck
 
getMethodName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SuperFinalizeCheck
 
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
 
getName() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo
 
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.javadoc.PackageHtmlCheck
Returns the set of directories for a set of files.
getPersistenceOption() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanCheck
Returns the set PersistenceOption.
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
 
getRegexp() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
 
getRegexp() - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
 
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.RedundantModifierCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
The tokens that this check must be registered for.
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.JUnitTestCaseCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
The tokens that this check must be registered for.
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
The tokens that this check must be registered for.
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractBeanCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractInterfaceCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.FinalStaticCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisParameterCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisReturnCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
The tokens that this check must be registered for.
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
 
getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
 
getScopeFromMods(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns the Scope specified by the modifier set.
getSeverity() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Get the severity level's name.
getSeverityLevel() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Returns the severity level of the messages generated by this module.
getSeverityLevel() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getSeverityLevel() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getSourceName() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
 
getSourceName() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
getStartColumn(Integer) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Get the starting column for a given line number.
getStartLineNo() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
The line in the inputfile where the text block starts.
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.LineSeparatorOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.BlockOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.PersistenceOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapOption
 
getStrToOpt() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
 
getStrippedFileName(String, String) - Static method in class com.puppycrawl.tools.checkstyle.api.Utils
Create a stripped down version of a filename.
getSurroundingScope(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Returns the scope of the surrounding "block".
getTabWidth() - Method in class com.puppycrawl.tools.checkstyle.api.Check
 
getText() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
 
getText() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
The text content of the text block.
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
 
getVersion() - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanCheck
Determines the EJB version.
gt(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
 

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.coding.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.coding.HiddenFieldCheck
 
HideUtilityClassConstructorCheck - class com.puppycrawl.tools.checkstyle.checks.design.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.design.HideUtilityClassConstructorCheck
 
HomeInterfaceMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.HomeInterfaceMethodChecker.
Checks the methods of a home interface.
HomeInterfaceMethodChecker(AbstractInterfaceCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.HomeInterfaceMethodChecker
Constructs a method checker for a home interface check.
hasCurlys() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Determines if this block expression has curly braces.
hasExtends(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node declares an extension of a class or interface.
hasImplements(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node declares an implementation of an interface.
hasPublicConstructor(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST defines a class with a public constructor with a given number of parameters.
hasPublicMethod(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node has a definition of a public method.
hasPublicMethod(DetailAST, String, boolean) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node has a definition of a public method.
hasPublicMethod(DetailAST, String, boolean, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node has a definition of a public method.
hasThrows(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node declares a throw of an Exception.
hashCode() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
 
hashCode() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
hashCode() - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
The hashCode method.
hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
 
hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
 

I

IDENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An identifier.
IGNORE - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: ignore.
IMPLEMENTS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An implements clause.
IMPORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An import declaration.
INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ++ (prefix increment) operator.
INDEX_OP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The array index operator.
INFO - Static variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level: informational.
INSTANCE_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An instance initializer.
INTERFACE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An interface declaration.
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.
IllegalCatchCheck - class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck.
Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException is almost never acceptable.
IllegalCatchCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
Creates new instance of the check.
IllegalImportCheck - class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck.
Checks for imports from a set of illegal packages.
IllegalImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
Creates a new IllegalImportCheck instance.
IllegalInstantiationCheck - class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.
Checks for illegal instantiations where a factory method is preferred.
IllegalInstantiationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
 
IllegalTokenCheck - class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck.
Checks for illegal tokens.
IllegalTokenCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
 
IllegalTokenTextCheck - class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.
Checks for illegal token text.
IllegalTokenTextCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
 
IllegalTypeCheck - class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.
Checks that particular class are never used as types in variable declarations, return values or parameters.
IllegalTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Creates new instance of the check.
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.
ImportOrderCheck - class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.
Class to check the ordering/grouping of imports.
ImportOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Default constructor.
IndentLevel - class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel.
Encapsulates representation of notion of expected indentation levels.
IndentLevel(int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
Creates new instance with one accaptable indentation level.
IndentLevel(IndentLevel, int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
Creates new instance for nested structure.
IndentationCheck - class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.
Checks correct indentation of Java Code.
IndentationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Creates a new instance of IndentationCheck.
InnerAssignmentCheck - class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck.
Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);.
InnerAssignmentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
 
InterfaceIsTypeCheck - class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck.
Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types.
InterfaceIsTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
 
implementsEntityBean(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node is in the definition of a class that implements javax.ejb.EntityBean.
implementsSessionBean(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node is in the definition of a class that implements javax.ejb.SessionBean.
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.
incrementCurrentValue(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Increments the current value by a specified amount.
indentationLog(int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.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
 
isAbstract(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST defines an abstract element.
isElseIf(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.CheckUtils
Returns whether a token represents an ELSE as part of an ELSE / IF set.
isEmpty() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
Determines if this set of lines is empty.
isFinal(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST defines a final element.
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.
isInEJB(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node is in the definition of an EJB class.
isLoadable() - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo
 
isLoadable(String) - Method in class com.puppycrawl.tools.checkstyle.checks.ClassResolver
 
isLocalVariableDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.ScopeUtils
Determines whether a node is a local variable definition.
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.design.VisibilityModifierCheck
 
isProtectedAllowed() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
 
isPublic(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST defines a public element.
isPublicMethod(DetailAST, String, boolean, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node defines a public method.
isPublicMethod(DetailAST, String, boolean) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node defines a public method.
isPublicMethod(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST node defines a public method.
isReference(String) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
isSameType(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Return if two Strings represent the same type, inspecting the import statements if necessary
isShortName(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Calculate if one type name is a shortname for another type name.
isStatic(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST defines a static element.
isSubclass(Class, Class) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Checks if one class is subclass of another
isUnchecked(Class) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Is exception is unchecked (subclass of RuntimeException or Error
isVoid(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Determines whether an AST defines a void method.

J

JUnitTestCaseCheck - class com.puppycrawl.tools.checkstyle.checks.coding.JUnitTestCaseCheck.
Ensures that the setUp(), tearDown()methods are named correctly, have no arguments, return void and are either public or protected.
JUnitTestCaseCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.JUnitTestCaseCheck
 
JavadocMethodCheck - class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.
Checks the Javadoc of a method or constructor.
JavadocMethodCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
 
JavadocStyleCheck - class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.
Custom Checkstyle Check to validate Javadoc.
JavadocStyleCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
 
JavadocTypeCheck - class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.
Checks the Javadoc of a type.
JavadocTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
 
JavadocVariableCheck - class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.
Checks that a variable has Javadoc comment.
JavadocVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.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.blocks.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.blocks.LeftCurlyCheck
Creates a default instance and sets the policy to EOL.
LeftCurlyOption - class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption.
Represents the options for placing the left curly brace '{'.
LineLengthCheck - class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.
Checks for long lines.
LineLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.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.naming.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.naming.LocalFinalVariableNameCheck
Creates a new LocalFinalVariableNameCheck instance.
LocalHomeInterfaceCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalHomeInterfaceCheck.
Checks the local home interface requirements: every method must not throw the java.rmi.RemoteException Reference: Enterprise JavaBeansTM Specification,Version 2.0, section 9.6.2.
LocalHomeInterfaceCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalHomeInterfaceCheck
Constructs a LocalHomeInterfaceCheck.
LocalHomeInterfaceMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalHomeInterfaceMethodChecker.
Checks the local home interface requirements: every method must not throw the java.rmi.RemoteException Reference: Enterprise JavaBeansTM Specification,Version 2.0, section 9.6.2.
LocalHomeInterfaceMethodChecker(LocalHomeInterfaceCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalHomeInterfaceMethodChecker
Constructs a method checker for a local home interface check.
LocalInterfaceCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalInterfaceCheck.
Checks the methods of a local interface.
LocalInterfaceCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalInterfaceCheck
Constructs a LocalInterfaceCheck.
LocalInterfaceMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalInterfaceMethodChecker.
Checks methods of a local interface.
LocalInterfaceMethodChecker(LocalInterfaceCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalInterfaceMethodChecker
Constructs a LocalInterfaceMethodChecker for a local interface check.
LocalVariableNameCheck - class com.puppycrawl.tools.checkstyle.checks.naming.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.naming.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, Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, int, String, String, Object[], Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, String, String, Object[], SeverityLevel, Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessage(int, String, String, Object[], Class) - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
Creates a new LocalizedMessage instance.
LocalizedMessages - class com.puppycrawl.tools.checkstyle.api.LocalizedMessages.
Collection of messages.
LocalizedMessages() - Constructor for class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
 
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.UncommentedMainCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
Called after all the child nodes have been process.
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
 
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Called after all the child nodes have been process.
leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
 
leaveTokenHook(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Hook called when leaving a token.
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.
lineIsBlank(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Checks if the specified line is blank.
lineIsComment(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Checks if the specified line is a single-line comment without code.
loadConfiguration(String, PropertyResolver) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Returns the module configurations in a specified file.
loadModuleFactory(ClassLoader) - Static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Returns the default list of package names.
loadModuleFactory(String) - Static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Returns the package names in a specified file.
loadSuppressions(String) - Static method in class com.puppycrawl.tools.checkstyle.SuppressionsLoader
Returns the suppression filters in a specified file.
log(int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Adds a violation message to the message collector.
log(int, int, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Adds a violation message to the message collector.
log(int, String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Log a message.
log(int, String, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
log(int, String, Object, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
log(int, int, String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Helper method to log a LocalizedMessage.
log(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.
log(DetailAST, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractJ2eeCheck
Helper method to log a LocalizedMessage for an AST.
log(DetailAST, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Logs an error message for a method.
logError(DetailAST, String, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Log an indentation error.
logError(DetailAST, String, int, IndentLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
Log an indentation error.
logError(Exception) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Logs an exception.
logLoadError(FullIdent) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Logs error if unable to load class information.
logLoadError(FullIdent) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck
Logs error if unable to load class information.
logLoadError(FullIdent) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Logs error if unable to load class information.
logName(DetailAST, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractJ2eeCheck
Helper method to log a LocalizedMessage for an AST.
logName(DetailAST, String, Object[]) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Logs an error message for a method, including the method name.

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.
MIXED - Static variable in class com.puppycrawl.tools.checkstyle.checks.j2ee.PersistenceOption
Represents the policy that the persistence management may be bean-managed or container-managed.
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.coding.MagicNumberCheck.
Checks for magic numbers.
MagicNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.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.naming.MemberNameCheck.
Checks that instance variable names conform to a format specified by the format property.
MemberNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
Creates a new MemberNameCheck instance.
MessageBeanCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.MessageBeanCheck.
Checks that a MessageBean implementation satisfies MessageBean requirements.
MessageBeanCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.MessageBeanCheck
Constructs a MessageBeanCheck.
MessageBeanMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.MessageBeanMethodChecker.
Checks the methods of a message bean.
MessageBeanMethodChecker(MessageBeanCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.MessageBeanMethodChecker
Constructs a MessageBeanMethodChecker.
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.
MethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker.
Root class for method checks for a client Check.
MethodChecker(AbstractJ2eeCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
Constructs a MethodChecker.
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.sizes.MethodLengthCheck.
Checks for long methods.
MethodLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
 
MethodNameCheck - class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck.
Checks that method names conform to a format specified by the format property.
MethodNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
Creates a new MethodNameCheck instance.
MissingSwitchDefaultCheck - class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck.
Checks that switch statement has "default" clause.
MissingSwitchDefaultCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
Creates new instance of the check.
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.
MutableExceptionCheck - class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck.
Ensures that exceptions (defined as any class name conforming to some regular expression) are immutable.
MutableExceptionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
Creates new instance of the check.
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.naming.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.naming.ConstantNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
 
mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck
 
mustCheckReferenceCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Determines whether the reference count of an aAST is required.
mustCheckReferenceCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.OneMethodPrivateFieldCheck
 
mustCheckReferenceCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedLocalVariableCheck
 
mustCheckReferenceCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedParameterCheck
 
mustCheckReferenceCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateFieldCheck
 
mustCheckReferenceCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateMethodCheck
 

N

NL - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
Represents the policy that the brace must always be on a new line.
NL - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapOption
Require that the operator is on a new line.
NLOW - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.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.whitespace.PadOption
Represents no spacing following a left parenthesis or preceding 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.blocks.NeedBracesCheck.
Checks for braces around code blocks.
NeedBracesCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
 
NestedIfDepthCheck - class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck.
Restricts nested if-else blocks to a specified depth (default = 1).
NestedIfDepthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
Creates new check instance with default allowed nesting depth.
NestedTryDepthCheck - class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck.
Restricts nested try-catch-finally blocks to a specified depth (default = 1).
NestedTryDepthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
Creates new check instance with default allowed nesting depth.
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.whitespace.NoWhitespaceAfterCheck.
Checks that there is no whitespace after a token.
NoWhitespaceAfterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
 
NoWhitespaceBeforeCheck - class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck.
Checks that there is no whitespace before a token.
NoWhitespaceBeforeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
 
nestIn(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
Increasing current nesting depth.
nestOut() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
Decreasing current nesting depth
normalize(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
"normalize" the given absolute path.

O

OBJBLOCK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An object block.
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.
OneMethodPrivateFieldCheck - class com.puppycrawl.tools.checkstyle.checks.usage.OneMethodPrivateFieldCheck.
Checks that a private field is used in more than one method, constructor, or initializer.
OneMethodPrivateFieldCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.usage.OneMethodPrivateFieldCheck
 
OperatorWrapCheck - class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck.
Checks line wrapping for operators.
OperatorWrapCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
Sets the operator wrap option to new line.
OperatorWrapOption - class com.puppycrawl.tools.checkstyle.checks.whitespace.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.
PackageDeclarationCheck - class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck.
Ensures there is a package declaration.
PackageDeclarationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
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.javadoc.PackageHtmlCheck.
Checks that all packages have a package documentation.
PackageHtmlCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.PackageHtmlCheck
Creates a new PackageHtmlCheck instance.
PackageNameCheck - class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck.
Checks that package names conform to a format specified by the format property.
PackageNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.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.whitespace.PadOption.
Represents the options for whitespace around parentheses.
ParameterAssignmentCheck - class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck.
Disallow assignment of parameters.
ParameterAssignmentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
 
ParameterNameCheck - class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck.
Checks that parameter names conform to a format specified by the format property.
ParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
Creates a new ParameterNameCheck instance.
ParameterNumberCheck - class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck.
Checks the number of parameters that a method or constructor has.
ParameterNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
 
ParenPadCheck - class com.puppycrawl.tools.checkstyle.checks.whitespace.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.whitespace.ParenPadCheck
 
PersistenceOption - class com.puppycrawl.tools.checkstyle.checks.j2ee.PersistenceOption.
Represents the policy for checking entity bean restrictions according to whether persistence is bean-managed, container-managed, or mixed.
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.
parseFloat(String, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.CheckUtils
Returns the value represented by the specified string of the specified type.
parseInputSource(InputSource) - Method in class com.puppycrawl.tools.checkstyle.AbstractLoader
Parses the specified input source.
popValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
 
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.TranslationCheck
This method searches for property files in the specified file array and checks whether the key usage is consistent.
process(File[]) - Method in class com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck
 
process(File[]) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.PackageHtmlCheck
Checks that each java file in the fileset has a package.html sibling and fires errors for the missing files.
processAST(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Called to process an AST when visiting it.
processAST(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck
Checks exceptions declared in throws for a method or constructor.
processAST(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Checks Javadoc comments for a method or constructor.
pushValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Push the current value on the stack

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.imports.RedundantImportCheck.
Checks for imports that are redundant.
RedundantImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.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.coding.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.coding.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
 
RemoteHomeInterfaceCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteHomeInterfaceCheck.
Checks the methods of a remote home interface.
RemoteHomeInterfaceCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteHomeInterfaceCheck
Constructs a RemoteHomeInterfaceCheck.
RemoteHomeInterfaceMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteHomeInterfaceMethodChecker.
Checks methods of a remote home interface check.
RemoteHomeInterfaceMethodChecker(RemoteHomeInterfaceCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteHomeInterfaceMethodChecker
Constructs a method checker for a remote home interface check.
RemoteInterfaceCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteInterfaceCheck.
Checks the methods of a remote interface.
RemoteInterfaceCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteInterfaceCheck
Constructs a RemoteInterfaceCheck.
RemoteInterfaceMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteInterfaceMethodChecker.
Checks methods of a remote interface.
RemoteInterfaceMethodChecker(RemoteInterfaceCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteInterfaceMethodChecker
Constructs a RemoteInterfaceMethodChecker for a remote interface check.
ReturnCountCheck - class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.
Restricts return statements to a specified count (default = 2).
ReturnCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
Creates new instance of the checks.
RightCurlyCheck - class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.
Checks the placement of right curly braces.
RightCurlyCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
Sets the right curly option to same.
RightCurlyOption - class com.puppycrawl.tools.checkstyle.checks.blocks.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.
removeFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
Removes filter.
removeFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Removes filter.
removeListener(AuditListener) - Method in class com.puppycrawl.tools.checkstyle.Checker
Removes a given listener.
reportBlockComment(String, int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Report the location of a block comment that can span multiple lines. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.
reportBlockComment(String, int, int, int, int) - Method in interface com.puppycrawl.tools.checkstyle.grammars.CommentListener
Report the location of a block comment that can span multiple lines.
reportCComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Report the location of a C-style comment.
reportCppComment(int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Report the location of a C++ style comment.
reportSingleLineComment(String, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Report the location of a single line comment that extends from the given point to the end of the line. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.
reportSingleLineComment(String, int, int) - Method in interface com.puppycrawl.tools.checkstyle.grammars.CommentListener
Report the location of a single line comment that extends from the given point to the end of the line.
reset() - Method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessages
Reset the object.
resolve(String) - Method in class com.puppycrawl.tools.checkstyle.PropertiesExpander
Resolves a property through the underlying Properties object.
resolve(String) - Method in interface com.puppycrawl.tools.checkstyle.PropertyResolver
Resolves a property name to it's value.
resolve(String) - Method in class com.puppycrawl.tools.checkstyle.checks.ClassResolver
Attempts to resolve the Class for a specified name.
resolveClass(String) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Attempts to resolve the Class for a specified name.
resolveEntity(String, String) - Method in class com.puppycrawl.tools.checkstyle.AbstractLoader

S

SAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.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.whitespace.PadOption
Represents mandatory spacing following a left parenthesis and preceeing 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.blocks.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.
SessionBeanCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.SessionBeanCheck.
Checks that a SessionBean implementation satisfies SessionBean requirements.
SessionBeanCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.SessionBeanCheck
Constructs a SessionBeanCheck.
SessionBeanMethodChecker - class com.puppycrawl.tools.checkstyle.checks.j2ee.SessionBeanMethodChecker.
Checks the methods of a session bean.
SessionBeanMethodChecker(SessionBeanCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.SessionBeanMethodChecker
Creates a method checker for a session bean check.
SeverityLevel - class com.puppycrawl.tools.checkstyle.api.SeverityLevel.
Severity level for a check violation.
SeverityMatchFilter - class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter.
This is a very simple filter based on severity matching.
SeverityMatchFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
 
SimplifyBooleanExpressionCheck - class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck.
Checks for overly complicated boolean expressions.
SimplifyBooleanExpressionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
 
SimplifyBooleanReturnCheck - class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck.
Checks for overly complicated boolean return statements.
SimplifyBooleanReturnCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.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.naming.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.naming.StaticVariableNameCheck
Creates a new StaticVariableNameCheck instance.
StrictDuplicateCodeCheck - class com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck.
Checks for duplicate code.
StrictDuplicateCodeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck
Creates a new instance of this class.
StringLiteralEqualityCheck - class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck.
Checks that string literals are not used with == or !=.
StringLiteralEqualityCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
 
SuperCloneCheck - class com.puppycrawl.tools.checkstyle.checks.coding.SuperCloneCheck.
Checks that an overriding clone() method invokes super.clone().
SuperCloneCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.SuperCloneCheck
 
SuperFinalizeCheck - class com.puppycrawl.tools.checkstyle.checks.coding.SuperFinalizeCheck.
Checks that an overriding finalize() method invokes super.finalize().
SuperFinalizeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.SuperFinalizeCheck
 
SuppressElement - class com.puppycrawl.tools.checkstyle.filters.SuppressElement.
This filter accepts AuditEvents according to file, check, line, and column conditions.
SuppressElement(String, String) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Constructs a SuppressElement for a file name pattern and and a check class pattern.
SuppressionFilter - class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter.
This filter accepts AuditEvents according to file, check, line, and column, as specified in a suppression file.
SuppressionFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
 
SuppressionsLoader - class com.puppycrawl.tools.checkstyle.SuppressionsLoader.
Loads a filter chain of suppressions.
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.
safeLoad(String) - Method in class com.puppycrawl.tools.checkstyle.checks.ClassResolver
Will load a specified class is such a way that it will NOT be initialised.
sameParameters(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
Tests whether two method definition ASTs have the same parameter lists according to type.
scanFileSets() - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
returns the list of files (full path name) to process.
setAcceptOnMatch(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
Sets whether to accept or reject on matching severity level.
setAllowInSwitchCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
Setter for allowInSwitchCase property.
setAllowLineBreaks(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
Control whether whitespace is flagged at linebreaks.
setAllowLineBreaks(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
Control whether whitespace is flagged at linebreaks.
setAllowMarkerInterfaces(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
Controls whether marker interfaces like Serializable are allowed.
setAllowMissingParamTags(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.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.javadoc.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.javadoc.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.coding.RedundantThrowsCheck
Getter for allowSubclasses property.
setAllowThrowsTagsForSubclasses(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.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.coding.RedundantThrowsCheck
Getter for allowUnchecked property.
setAllowUndeclaredRTE(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.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.javadoc.JavadocTypeCheck
Set the author tag pattern.
setBasedir(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
 
setBasedir(String) - Method in class com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck
 
setBasicOffset(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Set the basic offset.
setBraceAdjustment(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.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.indentation.IndentationCheck
Set the case indentation level.
setCaseSensitive(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Sets whether strings comprision should be case sensitive or not.
setCheckFirstSentence(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Sets the flag that determines if the first sentence is checked for proper end of sentence punctuation.
setCheckHtml(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Sets the flag that determines if HTML checking is to be performed.
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.coding.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.
setClassname(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Listener
 
setClasspath(Path) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Set the class path.
setClasspathRef(Reference) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Set the class path from a reference defined elsewhere.
setClazz(Class) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo
Associates Class with an object.
setColumns(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Sets the CSV values and ranges for column number filtering.
setConfig(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
setConfigURL(URL) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
setCountEmpty(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
 
setCurrentValue(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Set the current value
setExcludedClasses(String) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Set the excluded classes pattern.
setExcludes(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
Sets the list of packages to exempt from the check.
setFailOnViolation(boolean) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
setFailureProperty(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
Tells this task to set the named property to "true" when there is a violation.
setFile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
setFile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
setFile(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
Loads the suppressions for a file.
setFileContents(FileContents) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Set the file contents associated with the tree.
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.
setGroups(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
sets the list of package groups and the order they should occur in the file.
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.
setIgnoreCatch(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.UnusedParameterCheck
Control whether unused catch clause parameters are flagged.
setIgnoreConstructorParameter(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
Set whether to ignore constructor parameters.
setIgnoreFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
Set the ignore format to the specified regular expression.
setIgnoreFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Set the ignore format to the specified regular expression.
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.coding.MagicNumberCheck
Sets the numbers to ignore in the check.
setIgnorePattern(String) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
Set the ignore pattern.
setIgnoreSetter(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
Set whether to ignore the parameter of a property setter method.
setIgnoredMethodNames(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Set the list of ignore method names.
setIllegalClassNames(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
Set the list of illegal exception classes.
setIllegalClassNames(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Set the list of illegal variable types.
setIllegalPkgs(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.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
 
setLimitedTokens(String[]) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Sets the tokens which occurance as descendant is limited.
setLineSeparator(String) - Method in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
Sets the line separator to one of 'crlf', 'lf' or 'cr'.
setLines(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
Sets the CSV values and ranges for line number filtering.
setLocale(Locale) - Static method in class com.puppycrawl.tools.checkstyle.api.LocalizedMessage
 
setLocaleCountry(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
 
setLocaleLanguage(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
Setter for maximum allowed nesting depth.
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
Setter for max property.
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
Setter for max property.
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Set the maximum threshold allowed.
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
Sets the maximum threshold.
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
 
setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
Sets the maximum number of allowed parameters.
setMaxLineLength(int) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
Sets the maximum line length used in calculating the placement of the left curly brace.
setMaximumDepth(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Sets the maximum depth for descendant counts.
setMaximumMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Sets the error message for maximum count exceeded.
setMaximumNumber(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Sets a maximum count for descendants.
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.
setMethodChecker(MethodChecker) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.AbstractJ2eeCheck
Sets the method checker for this component check.
setMin(int) - Method in class com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck
Sets the minimum number of lines that must be equivalent before the check complains.
setMinimumDepth(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Sets the mimimum depth for descendant counts.
setMinimumMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Sets the error message for minimum count not reached.
setMinimumNumber(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Sets a minimum count for descendants.
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.
setOrdered(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Sets whether or not imports should be ordered within any one group of imports.
setPackageAllowed(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Set whether package visible members are allowed.
setPackageNamesFile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask
 
setPersistence(String) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanCheck
Set the persistence option to enforce.
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.design.VisibilityModifierCheck
Set whether protected members are allowed.
setPublicMemberPattern(String) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Set the pattern for public members to ignore.
setScope(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Set the scope.
setScope(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Sets the scope to check.
setScope(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Sets the scope to check.
setScope(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
Sets the scope to check.
setSeparated(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Sets whether or not groups of imports must be separated from one another by at least one blank line.
setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
Sets the severity level.
setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Sets the severity level.
setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
Sets the severity level.
setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Set the tab width to report errors with.
setTofile(File) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
Set the file to output to.
setTokens(String[]) - Method in class com.puppycrawl.tools.checkstyle.api.Check
Adds a set of tokens the check is interested in.
setType(CheckStyleTask.FormatterType) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Formatter
Set the type of the formatter.
setValue(String) - Method in class com.puppycrawl.tools.checkstyle.CheckStyleTask.Property
 
setVersion(String) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanCheck
Sets the EJB version.
setVersionFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Set the version format pattern.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.Checker
Instantiates, configures and registers a child AbstractFilter or FileSetCheck that is specified in the provided configuration.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
Instantiates, configures and registers a Check that is specified in the provided configuration.
setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Called by configure() for every child of this component's Configuration.
shouldIncreaseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AssignHandler
 
shouldIncreaseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ExpressionHandler
 
shouldIncreaseIndent() - 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
 
startElement(String, String, String, Attributes) - Method in class com.puppycrawl.tools.checkstyle.SuppressionsLoader
 
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.AssignHandler
Indentation level suggested for a child element. Children don't have to respect this, but most do.
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.blocks.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.whitespace.TabCharacterCheck.
Reports tab characters ('\t') in the source code.
TabCharacterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.TabCharacterCheck
 
TextBlock - interface com.puppycrawl.tools.checkstyle.api.TextBlock.
A block of text from an inputfile that does not necessarily have any grammatical structure.
ThisParameterCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisParameterCheck.
Checks that 'this' is not a parameter of any method calls or constructors for a bean.
ThisParameterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisParameterCheck
 
ThisReturnCheck - class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisReturnCheck.
Checks that 'this' is not returned by a bean method.
ThisReturnCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisReturnCheck
 
ThrowsCountCheck - class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck.
Restricts throws statements to a specified count (default = 1).
ThrowsCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
Creates new instance of the check.
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.naming.TypeNameCheck.
Checks that type names conform to a format specified by the format property.
TypeNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
Creates a new TypeNameCheck instance.
TypecastParenPadCheck - class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck.
Checks the padding of parentheses for typecasts.
TypecastParenPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
 
toString() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
 
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.IndentLevel
 
toString() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineSet
 
toString() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressElement
 
toString() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
 
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.
tryLoadClass(FullIdent) - Method in class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
Tries to load class.

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.
UncommentedMainCheck - class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck.
Detects uncommented main methods.
UncommentedMainCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
 
UnusedImportsCheck - class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.
Checks for unused import statements.
UnusedImportsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
 
UnusedLocalVariableCheck - class com.puppycrawl.tools.checkstyle.checks.usage.UnusedLocalVariableCheck.
Checks that a local variable is read.
UnusedLocalVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.usage.UnusedLocalVariableCheck
 
UnusedParameterCheck - class com.puppycrawl.tools.checkstyle.checks.usage.UnusedParameterCheck.
Checks that a parameter is used.
UnusedParameterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.usage.UnusedParameterCheck
 
UnusedPrivateFieldCheck - class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateFieldCheck.
Checks that a private field is used.
UnusedPrivateFieldCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateFieldCheck
 
UnusedPrivateMethodCheck - class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateMethodCheck.
Checks that a private method is used.
UnusedPrivateMethodCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.usage.UnusedPrivateMethodCheck
 
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.
Utils - class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils.
J2EE check utility methods.
Utils() - Constructor for class com.puppycrawl.tools.checkstyle.checks.j2ee.Utils
 

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.design.VisibilityModifierCheck.
Checks visibility of class members.
VisibilityModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Create an instance.
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.AbstractTypeAwareCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ModifierOrderCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DoubleCheckedLockingCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
Called to process a token.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Called to process a token.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.JUnitTestCaseCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
Called to process a token.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Called to process a token.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.EntityBeanCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.FinalStaticCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalHomeInterfaceCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.LocalInterfaceCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.MessageBeanCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteHomeInterfaceCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.RemoteInterfaceCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.SessionBeanCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisParameterCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.j2ee.ThisReturnCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Called to process a token.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Called to process a token.
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
 
visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
 
visitTokenHook(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck
Hook called when visiting a token.
visitTokenHook(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
Hook called when visiting a token. Will not be called the method definition tokens.

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.whitespace.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.whitespace.WhitespaceAfterCheck
 
WhitespaceAroundCheck - class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.
Checks that a token is surrounded by whitespace.
WhitespaceAroundCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.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