A B C D E F G H I J K L M N O P Q R S T U V W X Y 
All Classes All Packages

A

AbbreviationAsWordInNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
Validates abbreviations (consecutive capital letters) length in identifier name, it also allows to enforce camel case naming.
AbbreviationAsWordInNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
 
ABOVE - com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
Represents the policy that static imports are above the local group.
ABSTRACT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The abstract keyword.
ABSTRACT_KEYWORD - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
Name for 'abstract' keyword.
AbstractAccessControlNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
Abstract class for checking a class member (field/method)'s name conforms to a specified pattern.
AbstractAccessControlNameCheck(String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
Creates a new AbstractAccessControlNameCheck instance.
AbstractCheck - Class in com.puppycrawl.tools.checkstyle.api
The base class for checks.
AbstractCheck() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractCheck
 
AbstractCheck.FileContext - Class in com.puppycrawl.tools.checkstyle.api
The actual context holder.
AbstractClassCouplingCheck - Class in com.puppycrawl.tools.checkstyle.checks.metrics
Base class for coupling calculation.
AbstractClassCouplingCheck(int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Creates new instance of the check.
AbstractClassCouplingCheck.ClassContext - Class in com.puppycrawl.tools.checkstyle.checks.metrics
Encapsulates information about class coupling.
AbstractClassNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
Ensures that the names of abstract classes conforming to some pattern and check that abstract modifier exists.
AbstractClassNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
 
AbstractExpressionHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Abstract base class for all handlers.
AbstractExpressionHandler(IndentationCheck, String, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Construct an instance of this handler with the given indentation check, name, abstract syntax tree, and parent handler.
AbstractFileSetCheck - Class in com.puppycrawl.tools.checkstyle.api
Provides common functionality for many FileSetChecks.
AbstractFileSetCheck() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
AbstractFileSetCheck.FileContext - Class in com.puppycrawl.tools.checkstyle.api
The actual context holder.
AbstractFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
Constructor -- invocable only via super() from subclasses.
AbstractHeaderCheck - Class in com.puppycrawl.tools.checkstyle.checks.header
Abstract super class for header checks.
AbstractHeaderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
 
AbstractImportControl - Class in com.puppycrawl.tools.checkstyle.checks.imports
Represents a tree of import rules for controlling whether packages or classes are allowed to be used.
AbstractImportControl(AbstractImportControl, MismatchStrategy) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
Construct a child node.
AbstractImportRule - Class in com.puppycrawl.tools.checkstyle.checks.imports
Base class for import rules.
AbstractImportRule(boolean, boolean, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
Constructs an instance.
AbstractJavadocCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
Base class for Checks that process Javadoc comments.
AbstractJavadocCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
 
AbstractJavadocCheck.FileContext - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
The file context holder.
AbstractNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
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.
AbstractNode - Class in com.puppycrawl.tools.checkstyle.xpath
Represents general class for ElementNode, RootNode and AttributeNode.
AbstractNode(TreeInfo) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Constructor of the abstract class AbstractNode.
AbstractParenPadCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
Abstract class for checking the padding of parentheses.
AbstractParenPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
 
AbstractSuperCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
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
 
AbstractSuperCheck.MethodNode - Class in com.puppycrawl.tools.checkstyle.checks.coding
Stack node for a method definition and a record of whether the method has a call to the super method.
AbstractViolationReporter - Class in com.puppycrawl.tools.checkstyle.api
Serves as an abstract base class for all modules that report inspection findings.
AbstractViolationReporter() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
 
accept(int) - Method in class com.puppycrawl.tools.checkstyle.filters.CsvFilterElement
Determines whether an Integer matches a CSV integer value.
accept(int) - Method in interface com.puppycrawl.tools.checkstyle.filters.IntFilterElement
Determines whether or not a filtered Integer is accepted.
accept(int) - Method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilterElement
 
accept(int) - Method in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilterElement
 
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(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
 
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
 
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
 
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
 
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWarningsFilter
 
accept(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
 
accept(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
 
accept(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
 
accept(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
 
accept(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
 
accept(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
 
accept(TreeWalkerAuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.TreeWalkerFilter
Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
accept(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
 
accept(File) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame.JavaFileFilter
 
accept(String) - Method in interface com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilter
Determines whether or not a before execution file filtered event is accepted.
accept(String) - Method in class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
 
accept(String) - Method in class com.puppycrawl.tools.checkstyle.filefilters.BeforeExecutionExclusionFileFilter
 
acceptableTokens - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
Tokens that this check handles.
acceptFileStarted(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
Check if all before execution file filters accept starting the file.
acceptJavadocWithNonTightHtml() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
This method determines if a check should process javadoc containing non-tight html tags.
acceptOnMatch - Variable in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
Control whether the filter accepts an audit event if and only if there is a match between the event's severity level and property severity.
AccessModifierOption - Enum in com.puppycrawl.tools.checkstyle.checks.naming
This enum represents access modifiers.
AccessModifierOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
 
accessModifiers - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Specify the access modifiers where Javadoc comments are checked.
accessModifiers - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
Access modifiers of methods where parameters are checked.
accessModifiers - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
Access modifiers of record definitions where the number of record components should be checked.
AccessResult - Enum in com.puppycrawl.tools.checkstyle.checks.imports
Represents the result of an access check.
AccessResult() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.imports.AccessResult
 
actionPerformed(ActionEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame.ExpandCollapseAction
 
actionPerformed(ActionEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame.FileSelectionAction
 
actionPerformed(ActionEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame.FindNodeByXpathAction
 
actionPerformed(ActionEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame.ReloadAction
 
add(HtmlTag) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
Performs lazy initialization on the internal tags List and adds the tag.
add(String, Object) - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
Adds a context entry.
ADD_EXCEPTION_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
A key pointing to the add exception message in the "messages.properties" file.
addAcceptable(IndentLevel, int...) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
Adds one or more acceptable indentation level.
addAcceptable(IndentLevel, IndentLevel) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
Combines 2 acceptable indentation level classes.
addAst(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
Add ast to the set of ast.
addAstChild(JavaAstVisitor.DetailAstPair, DetailAstImpl) - Static method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor.DetailAstPair
Adds a child (or new root) to the given DetailAstPair.
addAttribute(String, String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Deprecated.
This shall be removed in future releases. Please use addProperty(String propertyName, String value) instead.
addBeforeExecutionFileFilter(BeforeExecutionFileFilter) - Method in class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
Adds a Filter to the set.
addBeforeExecutionFileFilter(BeforeExecutionFileFilter) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a before execution file filter to the end of the event chain.
addCellEditorListener(CellEditorListener) - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
 
addChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Makes a configuration a child of this configuration.
addChild(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Adds a new child to the current AST.
addChild(EqualsAvoidNullCheck.FieldFrame) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Add child frame to this frame.
addChild(AbstractImportControl) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
Adds new child import control.
addCount(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.Context
Increase count.
addDeclaredType(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
Adds new inner type.
addError(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that an audit error was discovered on a specific file.
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
 
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.MetadataGeneratorLogger
 
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.SarifLogger
 
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger.FileMessages
Adds the given error event to the messages.
addError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
 
addException(AuditEvent, Throwable) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that an exception happened while performing audit.
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
 
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
 
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.SarifLogger
 
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
addException(AuditEvent, Throwable) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
 
addException(Throwable) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger.FileMessages
Adds the given exception to the messages.
addField(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Add field to this FieldFrame.
addFile(File) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
Adds a file into resource bundle.
addFileset(FileSet) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Adds set of files (nested fileset attribute).
addFileSetCheck(FileSetCheck) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a FileSetCheck to the list of FileSetChecks that is executed in process().
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Adds a Filter to the set.
addFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
Adds a filter to the end of the audit event filter chain.
addFilter(IntFilterElement) - Method in class com.puppycrawl.tools.checkstyle.filters.CsvFilterElement
Adds a IntFilterElement to the set.
addFormatter(CheckstyleAntTask.Formatter) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Add a formatter.
addIdent(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
Add a name to the frame.
addImportRule(AbstractImportRule) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
Adds an AbstractImportRule to the node.
addInstanceField(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
Adds an instance field to this FieldFrame.
addInstanceMember(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
Adds instance member's ident.
addInstanceMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
Adds instance method's name.
addInstanceOrClassVar(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Add instance variables and class variables to the UnusedLocalVariableCheck.TypeDeclDesc.instanceAndClassVarStack.
addInstOrClassVar(UnusedLocalVariableCheck.VariableDesc) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
Add an instance variable or class variable to the stack.
addLastSibling(DetailAstImpl, DetailAstImpl) - Static method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Add new sibling to the end of existing siblings.
addLineWithAst(int, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
Map ast with their line number.
addListener(AuditListener) - Method in interface com.puppycrawl.tools.checkstyle.api.RootModule
Add the listener that will be used to receive events from the audit.
addListener(AuditListener) - Method in class com.puppycrawl.tools.checkstyle.Checker
 
addLocalVariables(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Add local variables to the variablesStack stack.
addMessage(String, String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Adds a custom message to this configuration.
addMethodCall(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Add method call to this frame.
addNextSibling(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Add next sibling, pushes other siblings back.
addPath(Path) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Adds a path.
addPreviousSibling(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Add previous sibling.
addProperty(CheckstyleAntTask.Property) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Add an override property.
addProperty(String, String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Adds n property to this configuration.
addReferencedClassName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
Adds new referenced class.
addReferencedClassName(String) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
Adds new referenced class.
addReferencedType(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
Adds new type reference to the current frame.
addReferencedTypes(Collection<String>) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
Adds new inner types.
addRulesToList(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Parses ordering rule and adds it to the list with rules.
addStaticField(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
Adds a static field to this FieldFrame.
addStaticMember(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
Adds static member's ident.
addStaticMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
Adds static method's name.
addSuppressions(List<String>, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Method to populate list of suppression entries.
addTag(String, int) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Adds a comment suppression Tag to the list of all tags.
addTag(String, int, int, SuppressionCommentFilter.TagType) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Adds a Tag to the list of all tags.
addToProperties(ModulePropertyDetails) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
Add a single module property to the module's property list and map both.
addToProperties(List<ModulePropertyDetails>) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
Add a list of properties to the module's property list and map both.
addToViolationMessages(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
Add a key to the violation message key list of the module.
addToViolationMessages(List<String>) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
Add a list of keys to the violation message key list of the module.
addTreeModelListener(TreeModelListener) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
 
addViolations(SortedSet<Violation>) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Adds the sorted set of Violation to the message collector.
adjustFirstLineToJavadocIndent(DetailNode, int) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Adjust first line nodes to javadoc indent.
adjustParens(DetailAST, UnaryOperator<DetailAST>) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
Finds matching parentheses among siblings.
advanceChildToEnd() - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor.DetailAstPair
Moves child reference to the last child.
afterValues - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
Stack of belongs to range values for question operator.
ALL - com.puppycrawl.tools.checkstyle.utils.JavadocUtil.JavadocTagType
All validTags.
ALL_ESCAPED_CHARS - Static variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
Regular expression for all escaped chars.
ALL_NEW_LINES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
Compiled pattern for all system newlines.
ALL_NEW_LINES - Static variable in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Compiled pattern for all system newlines.
ALL_WARNING_MATCHING_ID - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Special warning id for matching all the warnings.
allChainedPropertiesAreResolved(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.ChainedPropertyUtil
Checks if all chained properties have been resolved.
ALLOW_ELEMENT_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
Qualified name for element 'allow'.
allowByTailComment - Variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
Allow use escapes if trail comment is present.
allowClassImports - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
Control whether to allow starred class imports like import java.util.*;.
allowClassName - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
Controls whether to allow a method name to have the same name as the residing class name.
allowed - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
Indicates whether to allow access or not.
ALLOWED - com.puppycrawl.tools.checkstyle.checks.imports.AccessResult
Represents that access is allowed.
ALLOWED - com.puppycrawl.tools.checkstyle.checks.imports.MismatchStrategy
In a case if matching allow/disallow rule was not found, import will be allowed by default.
ALLOWED_ASSIGNMENT_CONTEXT - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
Allowed AST types from an assignment AST node towards the root.
ALLOWED_ASSIGNMENT_IN_COMPARISON_CONTEXT - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
Allowed AST types from a comparison node (above an assignment) towards the root.
ALLOWED_TAGS - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
HTML tags that are allowed in java docs.
ALLOWED_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
Set of allowed Tokens tags in summary java doc.
allowedAbbreviationLength - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
Indicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ...
allowedAbbreviations - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
Specify abbreviations that must be skipped for checking.
allowedAnnotations - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Specify annotations that allow missed documentation.
allowedAnnotations - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Specify annotations that allow missed documentation.
allowedAnnotations - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
Configure annotations that allow missed documentation.
allowedDistance - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
Specify distance between declaration of variable and its first usage.
allowedDuplicates - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
Specify the maximum number of occurrences to allow without generating a warning.
allowEmptyCatches - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
Allow empty catch bodies.
allowEmptyConstructors - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
Allow empty constructor bodies.
allowEmptyLambdas - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
Allow empty lambda bodies.
allowEmptyLoopBody - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
Allow loops with empty bodies.
allowEmptyLoops - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
Allow empty loop bodies.
allowEmptyMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
Allow empty method bodies.
allowEmptyTypes - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
Allow empty class, interface and enum bodies.
allowEscapesForControlCharacters - Variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
Allow use escapes for non-printable, control characters.
allowIfAllCharactersEscaped - Variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
Allow if all characters in literal are escaped.
allowInSwitchCase - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
Allow nested blocks if they are the only child of a switch case.
allowLegacy - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
Allow legacy package.html file to be used.
allowLineBreaks - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
Allow a line break between the identifier and left parenthesis.
allowLineBreaks - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
Control whether whitespace is allowed if the token is at a linebreak.
allowLineBreaks - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
Control whether whitespace is allowed if the token is at a linebreak.
allowMarkerInterfaces - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
Control whether marker interfaces like Serializable are allowed.
allowMissingParamTags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Control whether to ignore violations when a method has parameters but does not have matching param tags in the javadoc.
allowMissingParamTags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc.
allowMissingPropertyJavadoc - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
Control whether to allow missing Javadoc on accessor methods for properties (setters and getters).
allowMissingReturnTag - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Control whether to ignore violations when a method returns non-void type and does not have a return tag in the javadoc.
allowMultipleEmptyLines - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Allow multiple empty lines between class members.
allowMultipleEmptyLinesInsideClassMembers - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Allow multiple empty lines inside class members.
allowNewlineParagraph - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
Control whether the <p> tag should be placed immediately before the first word.
allowNoEmptyLineBetweenFields - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Allow no empty line between fields.
allowNonPrintableEscapes - Variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
Allow use escapes for non-printable, whitespace characters.
allowOneCharVarInForLoop - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
Allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp.
allowPublicFinalFields - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Allow final fields to be declared as public.
allowPublicImmutableFields - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Allow immutable fields to be declared as public if defined in final class.
allowSamelineMultipleAnnotations - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
Allow annotation(s) to be located on the same line as target element.
allowSamelineParameterizedAnnotation - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
Allow one and only parameterized annotation to be located on the same line as target element.
allowSamelineSingleParameterlessAnnotation - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
Allow single parameterless annotation to be located on the same line as target element.
allowSingleLineStatement - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
Allow single-line statements without braces.
allowStaticMemberImports - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
Control whether to allow starred static member imports like import static org.junit.Assert.*;.
allowUnknownTags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Control whether to ignore violations when a Javadoc tag is not recognised.
allowWhenNoBraceAfterSemicolon - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
Allow unnecessary semicolon if closing paren is not on the same line.
ALONE - com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
Represents the policy that the brace must be alone on the line.
ALONE_OR_SINGLELINE - com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
Represents the policy that the brace must be alone on the line, yet allows single-line format of block.
alreadyAssigned - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.FinalVariableCandidate
Whether the variable is already assigned.
ALWAYS - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ClosingParensOption
With parens example
ALWAYS - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.TrailingArrayCommaOption
With comma example
alwaysDemandTrailingComma - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
Control whether to always check for a trailing comma, even when an array is inline.
AMBIGUOUS_MODULE_NAME_EXCEPTION_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Exception message when there is ambiguous module name in config file.
ancestorEnum - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.FollowingIterator
Ancestor axis iterator.
ancestorEnum - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.PrecedingIterator
Ancestor axis iterator.
ANNOTATION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation of a package, type, field, parameter or variable.
ANNOTATION_ARRAY_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation array member initialization.
ANNOTATION_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation declaration.
ANNOTATION_ELEMENT_SINGLE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
The element name used to receive special linguistic support for annotation use.
ANNOTATION_FIELD_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An annotation field declaration.
ANNOTATION_MEMBER_VALUE_PAIR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An initialization of an annotation member with a value.
AnnotationArrayInitHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for annotation array initialization blocks.
AnnotationArrayInitHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
AnnotationLocationCheck - Class in com.puppycrawl.tools.checkstyle.checks.annotation
Checks location of annotation on language elements.
AnnotationLocationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
 
AnnotationOnSameLineCheck - Class in com.puppycrawl.tools.checkstyle.checks.annotation
Checks that annotations are located on the same line with their targets.
AnnotationOnSameLineCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
 
ANNOTATIONS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A collection of annotations on a package or enum constant.
AnnotationUseStyleCheck - Class in com.puppycrawl.tools.checkstyle.checks.annotation
Checks the style of elements in annotations.
AnnotationUseStyleCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
 
AnnotationUseStyleCheck.ClosingParensOption - Enum in com.puppycrawl.tools.checkstyle.checks.annotation
Defines the two styles for defining elements in an annotation.
AnnotationUseStyleCheck.ElementStyleOption - Enum in com.puppycrawl.tools.checkstyle.checks.annotation
Defines the styles for defining elements in an annotation.
AnnotationUseStyleCheck.TrailingArrayCommaOption - Enum in com.puppycrawl.tools.checkstyle.checks.annotation
Defines the two styles for defining elements in an annotation.
AnnotationUtil - Class in com.puppycrawl.tools.checkstyle.utils
Contains utility methods designed to work with annotations.
AnnotationUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Private utility constructor.
ANONINNER - com.puppycrawl.tools.checkstyle.api.Scope
Anonymous inner scope.
anonInnerAstToTypeDeclDesc - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Maps local anonymous inner class to the TypeDeclDesc object containing it.
anonInnerClassHolders - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
anonInnerClassToOuterTypeDecl - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
Maps anonymous inner class's TokenTypes.LITERAL_NEW node to the outer type declaration's fully qualified name.
AnonInnerLengthCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
Checks for long anonymous inner classes.
AnonInnerLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
 
AnonymousClassFrame(RequireThisCheck.AbstractFrame, String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AnonymousClassFrame
Creates anonymous class frame.
append(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Append the specified token and also recalibrate the first line and column.
append(String) - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Append the specified text.
appendBrackets(FullIdent, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Appends the brackets of an array type to a FullIdent.
appendHiddenCommentNodes(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.JavaParser
Appends comment nodes to existing AST.
applyToPackage - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
If true, applies the check be "package" members.
applyToPrivate - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
If true, applies the check be private members.
applyToProtected - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
If true, applies the check be protected members.
applyToPublic - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
If true, applies the check be public members.
AREA_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Area tag name.
AREA_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Area html tag.
areExternalResourcesChanged(Set<PropertyCacheFile.ExternalResource>) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Checks whether the contents of external configuration resources were changed.
areImmutableTypeArguments(List<String>) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Checks whether all generic type arguments are immutable.
areInSameMethodCallWithSameIndent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
Checks if the comment is inside a method call with same indentation of first expression.
areMethodsChained(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
Checks if ast2 is a chained method call that starts on the same level as ast1 ends.
areOnSameLine(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
Determines if two ASTs are on the same line.
areSameLevelIndented(DetailAST, DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
Checks if comment and next code statement (or previous code stmt like case in switch block) are indented at the same level, e.g.:
areStringsConcatenated(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
Checks whether string literal or text block literals are concatenated.
args - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
Arguments for MessageFormat.
args - Variable in class com.puppycrawl.tools.checkstyle.DefaultLogger.LocalizedMessage
Arguments for MessageFormat.
ARGUMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
ARGUMENT_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
Regex to match argument names.
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.
ArrayInitHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for array initialization blocks.
ArrayInitHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
arrayInitIndent - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Specify how far an array initialisation should be indented when on next line.
ArrayTrailingCommaCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks that array initialization contains a trailing comma.
ArrayTrailingCommaCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
 
ArrayTypeStyleCheck - Class in com.puppycrawl.tools.checkstyle.checks
Checks the style of array type definitions.
ArrayTypeStyleCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
asBitSet(int...) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
Creates a new BitSet from array of tokens.
asBitSet(String...) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
Creates a new BitSet from array of tokens.
ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The = (assignment) operator.
ASSIGN_OPERATOR_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
Assign operator types.
ASSIGN_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Set of all assign tokens.
assignDepth - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
Depth of nested assignments.
assigned - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.FinalVariableCandidate
Whether the variable is assigned.
ASSIGNMENTS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
Token types for assignment operations.
ast - Variable in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
Class ast.
ast - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
AST node representing this exception.
ast - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.Context
Member AST node.
astLines - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
Maps line numbers to their ast.
AstState() - Constructor for enum com.puppycrawl.tools.checkstyle.TreeWalker.AstState
 
AstTreeStringPrinter - Class in com.puppycrawl.tools.checkstyle
Class for printing AST to String.
AstTreeStringPrinter() - Constructor for class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
Prevent instances.
astTypeIsClassOrEnumOrRecordDef(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
Verify that a token is either CLASS_DEF, RECORD_DEF, or ENUM_DEF.
AT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An @ symbol - signifying an annotation instance or the prefix to the interface literal signifying the definition of an annotation declaration.
AtclauseOrderCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
AtclauseOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
 
atomize() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Returns AtomicSequence.
ATTR_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Attribute value html tag component.
ATTRIB_TAB_WIDTH_NAME - Static variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Name for the moduleConfig attribute 'tabWidth'.
ATTRIBUTE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Html tag attribute.
ATTRIBUTE_NAME_CHECKS - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
String literal for attribute name.
ATTRIBUTE_NAME_COLUMNS - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
String literal for attribute name.
ATTRIBUTE_NAME_FILES - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
String literal for attribute name.
ATTRIBUTE_NAME_ID - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
String literal for attribute name.
ATTRIBUTE_NAME_LINES - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
String literal for attribute name.
ATTRIBUTE_NAME_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
String literal for attribute name.
ATTRIBUTE_NAME_QUERY - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
String literal for attribute name.
ATTRIBUTE_NODE_UNINITIALIZED - Static variable in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Holder value for lazy creation of attribute node.
attributeNode - Variable in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
The text attribute node.
AttributeNode - Class in com.puppycrawl.tools.checkstyle.xpath
Represents attribute of the element.
AttributeNode(String, String) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
Creates a new AttributeNode instance.
AUDIT_FINISHED_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
A key pointing to the finished audit message in the "messages.properties" file.
AUDIT_STARTED_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
A key pointing to the started audit message in the "messages.properties" file.
AuditEvent - Class in com.puppycrawl.tools.checkstyle.api
Raw event for audit.
AuditEvent(Object) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new instance.
AuditEvent(Object, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
AuditEvent(Object, String, Violation) - Constructor for class com.puppycrawl.tools.checkstyle.api.AuditEvent
Creates a new AuditEvent instance.
AuditEventDefaultFormatter - Class in com.puppycrawl.tools.checkstyle
Represents the default formatter for log message.
AuditEventDefaultFormatter() - Constructor for class com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
 
AuditEventFormatter - Interface in com.puppycrawl.tools.checkstyle
Represents the formatter interface for log message.
auditFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is finished.
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.SarifLogger
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
auditFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
 
AuditListener - Interface in com.puppycrawl.tools.checkstyle.api
Listener in charge of receiving events from the Checker.
auditStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that the audit is about to start.
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
 
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
 
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.SarifLogger
 
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
auditStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
 
AUTHOR - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
@author.
AUTHOR_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
'@author' literal in @author Javadoc tag.
authorFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Specify the pattern for @author tag.
AutomaticBean - Class in com.puppycrawl.tools.checkstyle.api
A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.
AutomaticBean() - Constructor for class com.puppycrawl.tools.checkstyle.api.AutomaticBean
 
AutomaticBean.OutputStreamOptions - Enum in com.puppycrawl.tools.checkstyle.api
Enum to specify behaviour regarding ignored modules.
AutomaticBean.PatternConverter - Class in com.puppycrawl.tools.checkstyle.api
A converter that converts a string to a pattern.
AutomaticBean.RelaxedAccessModifierArrayConverter - Class in com.puppycrawl.tools.checkstyle.api
A converter that converts strings to AccessModifierOption.
AutomaticBean.RelaxedStringArrayConverter - Class in com.puppycrawl.tools.checkstyle.api
A converter that does not care whether the array elements contain String characters like '*' or '_'.
AutomaticBean.ScopeConverter - Class in com.puppycrawl.tools.checkstyle.api
A converter that converts strings to scope.
AutomaticBean.SeverityLevelConverter - Class in com.puppycrawl.tools.checkstyle.api
A converter that converts strings to severity level.
AutomaticBean.UriConverter - Class in com.puppycrawl.tools.checkstyle.api
A converter that converts strings to uri.
AvoidDoubleBraceInitializationCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Detects double brace initialization.
AvoidDoubleBraceInitializationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
 
AvoidEscapedUnicodeCharactersCheck - Class in com.puppycrawl.tools.checkstyle.checks
Restricts using Unicode escapes (such as \u221e).
AvoidEscapedUnicodeCharactersCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
 
AvoidInlineConditionalsCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Detects inline conditionals.
AvoidInlineConditionalsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
 
AvoidNestedBlocksCheck - Class in com.puppycrawl.tools.checkstyle.checks.blocks
Finds nested blocks (blocks that are used freely in the code).
AvoidNestedBlocksCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
 
AvoidNoArgumentSuperConstructorCallCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks if call to superclass constructor without arguments is present.
AvoidNoArgumentSuperConstructorCallCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.AvoidNoArgumentSuperConstructorCallCheck
 
AvoidStarImportCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
Checks that there are no import statements that use the * notation.
AvoidStarImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
 
AvoidStaticImportCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
Checks that there are no static import statements.
AvoidStaticImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
 

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.
BASE_10 - Static variable in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Decimal radix.
BASE_10 - Static variable in class com.puppycrawl.tools.checkstyle.XMLLogger
Decimal radix.
BASE_16 - Static variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Default number for base 16 encoding.
BASE_16 - Static variable in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Hex radix.
BASE_16 - Static variable in class com.puppycrawl.tools.checkstyle.XMLLogger
Hex radix.
BASE_2 - Static variable in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Binary radix.
BASE_8 - Static variable in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Octal radix.
BASE_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Base tag name.
BASE_PACKAGE - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Base package of checkstyle modules checks.
BASE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Base html tag.
BaseCellEditor - Class in com.puppycrawl.tools.checkstyle.gui
A base class for CellEditors, providing default implementations for all methods in the CellEditor interface and support for managing a series of listeners.
BaseCellEditor() - Constructor for class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
 
baseClassName(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Returns base class name from qualified name.
basedir - Variable in class com.puppycrawl.tools.checkstyle.Checker
The basedir to strip off in file names.
BASEFONT_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Basefont tag name.
BASEFONT_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Basefont html tag.
baseName - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Specify Base name of resource bundles which contain message resources.
baseName - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
Bundle base name.
basicOffset - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Specify how far new indentation level should be indented when on the next line.
BeforeExecutionExclusionFileFilter - Class in com.puppycrawl.tools.checkstyle.filefilters
File filter BeforeExecutionExclusionFileFilter decides which files should be excluded from being processed by the utility.
BeforeExecutionExclusionFileFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filefilters.BeforeExecutionExclusionFileFilter
 
BeforeExecutionFileFilter - Interface in com.puppycrawl.tools.checkstyle.api
An interface for before execution file filtering events.
beforeExecutionFileFilters - Variable in class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
Filter set.
beforeExecutionFileFilters - Variable in class com.puppycrawl.tools.checkstyle.Checker
The audit event before execution file filters.
BeforeExecutionFileFilterSet - Class in com.puppycrawl.tools.checkstyle.api
A before execution file filter set applies filters to events.
BeforeExecutionFileFilterSet() - Constructor for class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
 
beforeFirstImport - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Whether there were any imports.
beginJavadocTree(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
Called before the starting to process a tree.
beginJavadocTree(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
 
beginProcessing(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
beginProcessing(String) - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
Called when about to be called to process a set of files.
beginProcessing(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
 
beginProcessing(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
 
beginProcessing(String) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
Called before the starting to process a tree.
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
 
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.IllegalTypeCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
 
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.javadoc.AbstractJavadocCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
 
beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
 
BLANK_LINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
Compiled regex pattern for a blank line.
BLOCK - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo.Type
Block type.
BLOCK - com.puppycrawl.tools.checkstyle.utils.JavadocUtil.JavadocTagType
Block type.
BLOCK_COMMENT_BEGIN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Beginning of block comment: '/*'.
BLOCK_COMMENT_END - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
End of block comment: '*/'.
BLOCK_FRAME - com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
Block frame type.
BLOCK_MULTIPLE_COMMENT_BEGIN - Static variable in class com.puppycrawl.tools.checkstyle.utils.ParserUtil
Symbols with which multiple comment starts.
BLOCK_MULTIPLE_COMMENT_END - Static variable in class com.puppycrawl.tools.checkstyle.utils.ParserUtil
Symbols with which multiple comment ends.
BLOCK_TAG_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.BlockTagUtil
Block tag pattern.
BLOCK_TAG_PATTERN_FIRST_LINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.BlockTagUtil
Block tag pattern for a first line.
blockCommentAst - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck.FileContext
DetailAST node of considered Javadoc comment that is just a block comment in Java language syntax tree.
blockCommentLineNumber - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Line number of the Block comment AST that is being parsed.
BlockCommentPosition - Class in com.puppycrawl.tools.checkstyle.utils
Utility class that has methods to check javadoc comment position in java file.
BlockCommentPosition() - Constructor for class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
Forbid new instances.
blockComments - Variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
C style comments.
blockCommentToJavadocTree - Variable in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Cache to store already parsed Javadoc comments.
BlockFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.BlockFrame
Creates block frame.
BlockOption - Enum in com.puppycrawl.tools.checkstyle.checks.blocks
Represents the policy for checking block statements.
BlockOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.blocks.BlockOption
 
BlockParentHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for parents of blocks ('if', 'else', 'while', etc).
BlockParentHandler(IndentationCheck, String, DetailAST, AbstractExpressionHandler) - 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.
BlockTagUtil - Class in com.puppycrawl.tools.checkstyle.checks.javadoc.utils
Tools for parsing block tags from a Javadoc comment.
BlockTagUtil() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.BlockTagUtil
Prevent instantiation.
BNOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ~ (bitwise complement) operator.
BODY - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Body html tag.
BODY_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Body tag name.
BODY_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
End body tag.
BODY_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Start body tag.
BooleanExpressionComplexityCheck - Class in com.puppycrawl.tools.checkstyle.checks.metrics
Restricts the number of boolean operators (&amp;&amp;, ||, &amp;, | and ^) in an expression.
BooleanExpressionComplexityCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
Creates new instance of the check.
BooleanExpressionComplexityCheck.Context - Class in com.puppycrawl.tools.checkstyle.checks.metrics
Represents context (method/expression) in which we check complexity.
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.
BOTTOM - com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
Represents the policy that static imports are all at the bottom.
BR_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Br tag name.
BR_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Br html tag.
braceAdjustment - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Specify how far a braces should be indented when on the next line.
BRACKET_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Pattern to match brackets in a full type name.
branchContains(int) - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
Deprecated.
Usage of this method is no longer accepted. We encourage traversal of subtrees to be written per the needs of each check to avoid unintended side effects.
branchContains(int) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
 
branchContainsJavadocComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
Checks whether a javadoc comment exists under the token.
branchTokenTypes - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
All token types in this branch.
branchVisited - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
True, when branch is visited, but not leaved.
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.
BUFFER - Static variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Default buffer for reading from streams.
BUFFER_SIZE - Static variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Size of default byte array for buffer.
BUFFER_SIZE - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
Input stream buffer size.
build() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
Returns new DetectorOptions instance.
Builder() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
 
bundle - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
Name of the resource bundle to get violations from.
BUNDLE_CACHE - Static variable in class com.puppycrawl.tools.checkstyle.api.Violation
A cache that maps bundle names to ResourceBundles.
BUNDLE_CACHE - Static variable in class com.puppycrawl.tools.checkstyle.DefaultLogger.LocalizedMessage
A cache that maps bundle names to ResourceBundles.
BXOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ^ (bitwise exclusive OR) operator.
BXOR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The ^= (bitwise exclusive OR assignment) operator.

C

cacheFile - Variable in class com.puppycrawl.tools.checkstyle.Checker
Cache file.
calculateBufferLength(AuditEvent, int) - Static method in class com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
Returns the length of the buffer for StringBuilder.
calculateDistanceBetweenScopes(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
Calculates distance between declaration of variable and its first usage in multiple scopes.
calculateDistanceInSingleScope(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
Calculates distance between declaration of variable and its first usage in single scope.
calculateResult(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
Returns the appropriate AccessResult based on whether there was a match and if the rule is to allow access.
calculateTagColumn(Matcher, int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Calculates column number using Javadoc tag matcher.
callingSuper - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck.MethodNode
True if the overriding method calls the super method.
canAssignValueToClassField(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Checks whether a value can be assigned to a field.
canBeOverridden(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
Checks whether a method can be overridden.
canBeReferencedFromStaticContext(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Checks whether a field can be referenced from a static context.
canBeSubclassed(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
Checks if the given class (given CLASS_DEF node) can be subclassed.
cancelCellEditing() - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
 
canChildrenBeNested() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
 
canChildrenBeNested() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
 
canChildrenBeNested() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Determines if child elements within the expression may be nested.
canContinueValidation(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Check if we can stop validation.
canReferenceImports() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
Checks that the tag can contain references to imported classes.
canReturnOnlyBooleanLiteral(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
Returns if an AST is a return statement with a boolean literal or a compound statement that contains only such a return statement.
capitalize(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
Capitalizes a given property name the way we expect to see it in a setter name.
CARRIAGE_RETURN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
Carriage return character.
CARRIAGE_RETURN_TO_TAG - Static variable in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
This regexp is used to convert carriage return to carriage-return tag.
CASE_CHILDREN - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
The child elements of a case expression.
CASE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A group of case clauses.
CaseHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for case statements.
CaseHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
caseIndent - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Specify how far a case label should be indented when on next line.
caseSensitive - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Control whether string comparison should be case-sensitive or not.
CATCH_FRAME - com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
Catch frame type.
CatchFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.CatchFrame
Creates catch frame.
CatchHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for catch blocks.
CatchHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
CatchParameterNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
Checks that catch parameter names conform to a specified pattern.
CatchParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck
Creates a new CatchParameterNameCheck instance.
ChainedPropertyUtil - Class in com.puppycrawl.tools.checkstyle.utils
Resolves chained properties from a user-defined property file.
ChainedPropertyUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.ChainedPropertyUtil
Prevent instantiation.
CHAR - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Any other symbol.
CHAR_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A character literal.
charset - Variable in class com.puppycrawl.tools.checkstyle.api.FileText
The charset used to read the file.
charset - Variable in class com.puppycrawl.tools.checkstyle.Checker
Name of a charset.
charset - Variable in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
Specify the character encoding to use when reading the headerFile.
CHECK - com.puppycrawl.tools.checkstyle.meta.ModuleType
Module is a Checkstyle check.
CHECK_ALIAS_MAP - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
A map from check source names to suppression aliases.
CHECK_SUFFIX - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Suffix to be removed from subclasses of Check.
CHECK_SUFFIX - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Suffix of checks.
checkAccess(String, String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
Returns whether a package or class is allowed to be imported.
checkAnnotationIndentation(DetailAST, NavigableMap<Integer, DetailAST>, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Checks line wrapping into annotations.
checkAnnotations(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
Checks annotations positions in code: 1) Checks whether the annotations locations are correct.
checkBaseTypes(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Checks the extends or implements statement.
checkBlockComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
Method to check if block comment is in correct format.
checkC - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Control whether to check C style comments (&#47;* ... *&#47;).
checkC - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Control whether to check C style comments (&#47;* ... *&#47;).
checkCase() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
Check the indentation of the case statement.
checkCase() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchRuleHandler
Check the indentation of the case statement.
checkCheckClosingParensOption(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Checks to see if the closing parenthesis are present if required or prohibited.
checkChildIndentation(DetailAST, String, IndentLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
Method to check indentation of try resources children.
checkChildren(DetailAST, int[], IndentLevel, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indent level of the children of the specified parent expression.
checkClassConstructorModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
Check if class constructor has proper modifiers.
checkClassName() - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Checks that current class is not excluded.
checkClassName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Checks type and type arguments/parameters of given method, parameter, variable or method call/reference.
checkComment(DetailAST, TextBlock) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Checks the Javadoc for a method.
checkComment(DetailAST, TextBlock) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Performs the various checks against the Javadoc comment.
checkCommentInModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Checks that packageDef token is separated from comment in modifiers.
checkComments(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Check if group of comments located right before token has more than one previous empty line.
checkCommentsInsideToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Check if group of comments located at the start of token has more than one previous empty line.
checkCompactNoArrayStyle(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Checks for compact no array style type violations.
checkCompactStyle(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Checks for compact style type violations.
checkComponentParamTag(DetailAST, List<JavadocTag>, String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Verifies that a record definition has the specified param tag for the specified record component name.
checkCondExpr() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CatchHandler
Check the indentation level of the conditional expression.
checkCondExpr() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
Check the indentation of the conditional expression.
checkCondExpr() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.WhileHandler
Check the indentation of the conditional expression.
checkConstructorModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
Check modifiers of constructor.
checkCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
Checks if number of return statements in the method are more than allowed.
checkCount(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.Context
Checks if we violate maximum allowed complexity.
checkCounters(MethodCountCheck.MethodCounter, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
Check the counters and report violations.
checkCoupling() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
Checks if coupling less than allowed or not.
checkCPP - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Control whether to check C++ style comments (//).
checkCPP - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Control whether to check C++ style comments (//).
checkCurrentClassAndRestorePrevious() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Restores previous context.
CHECKED_CHILDREN - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Children checked by parent handlers.
checkEmptyJavadoc - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Control whether to check if the Javadoc is missing a describing text.
checkEmptyLine(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
Determines whether or not the next line after empty line has paragraph tag in the beginning.
checkEnumConstant(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
Checks if enum constant has unnecessary semicolon.
checkEnumConstructorModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
Check if enum constructor has proper modifiers.
Checker - Class in com.puppycrawl.tools.checkstyle
This class provides the functionality to check a set of files.
Checker() - Constructor for class com.puppycrawl.tools.checkstyle.Checker
Creates a new Checker instance.
CHECKER_MODULE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
A checker module name.
CHECKER_THREADS_NUMBER - Static variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
The checker threads number.
checkerThreadsNumber - Variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
The checker threads number.
checkExistenceOfDefaultTranslation(TranslationCheck.ResourceBundle) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Checks an existence of default translation file in the resource bundle.
checkExistenceOfRequiredTranslations(TranslationCheck.ResourceBundle) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Checks an existence of translation files in the resource bundle.
checkExpandedStyle(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Checks for expanded style type violations.
checkExpression(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
Checks whether an expression is surrounded by parentheses.
checkExpressionSubtree(DetailAST, IndentLevel, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indentation level for an expression subtree.
checkFields - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Control whether to check references to fields.
checkFilesForConsistencyRegardingTheirKeys(Map<File, Set<String>>, Set<String>) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Compares th the specified key set with the key sets of the given translation files (arranged in a map).
checkFirstSentence - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Control whether to check the first sentence for proper end of sentence.
checkFirstSentenceEnding(DetailAST, TextBlock) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Checks that the first sentence ends with proper punctuation.
checkForAnnotationIndentation(NavigableMap<Integer, DetailAST>, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Checks for annotation indentation.
checkForDuplicates - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Boolean to say if we should check for duplicates.
checkFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Specify check pattern to suppress.
checkFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Specify check pattern to suppress.
checkFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
Specify check pattern to suppress.
checkForMethodLparenNewLine(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Checks whether the method lparen starts from a new line or not.
checkForNullParameterChild(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Checks whether parameter node has any child or not.
checkForParams() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ForHandler
Check the indentation of the parameters of the 'for' loop.
checkForRedundantModifier(DetailAST, int...) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
Checks if given ast has a redundant modifier.
checkHeaderNotInitialized() - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
Called before initializing the header.
checkHtml - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Control whether to check for incomplete HTML tags.
checkHtmlTags(DetailAST, TextBlock) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Checks the comment for HTML tags that do not have a corresponding close tag or a close tag that has no previous open tag.
checkIdent(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Checks the identifier of the given type.
checkIdent(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
Check if ident is parameter.
checkIdentifierAst(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Checks the identifier ast.
checkIf(DetailAST, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
Checks if a given IF terminated by return, throw or, if allowed break, continue.
checkIfSemicolonIsInDifferentLineThanPrevious(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
Checks if given semicolon is in different line than previous.
checkImportStatements(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
Check import statements.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indentation of the expression we are handling.
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CatchHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DoWhileHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ForHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ImportHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndexHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LambdaHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MemberDefHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PackageDefHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchRuleHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SynchronizedHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.WhileHandler
 
checkIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.YieldHandler
 
checkIndentation(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Checks line wrapping into expressions and definitions using property 'lineWrappingIndentation'.
checkIndentation(DetailAST, DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Checks line wrapping into expressions and definitions.
checkIndentation(DetailAST, DetailAST, int, int, LineWrappingHandler.LineWrappingOptions) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Checks line wrapping into expressions and definitions.
checking - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
Whether we should check this method or not.
checking - Variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
Should we check current class or not.
checking - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.Context
Should we perform check in current context or not.
checkingStack - Variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
Stack of checking information for classes.
checkInterfaceModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
Checks if interface has proper modifiers.
checkIsAllLinesAreWhitespace(int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
Checks is all lines from 'lineFrom' to 'lineTo' (exclusive) contain whitespaces only.
checkJavadocIsNotEmpty(TextBlock) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Checks that the Javadoc is not empty.
checkLabel() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
Check the indentation of the label.
checkLambda(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
Checks semicolon placement in lambda.
checkLastCaseGroup - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
Control whether the last case group must be checked.
checkLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation of the left curly brace.
checkLeftParen(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indentation of the left parenthesis.
checkLine(int, String, Matcher, int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
Check a line for matches.
checkLineIndent(DetailAST, IndentLevel, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indentation for a single-line.
checkLinesIndent(DetailAstSet, IndentLevel, boolean, int, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indentation for a set of lines.
checkLineWrappedLambda(boolean, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LambdaHandler
This method checks a line wrapped lambda, whether it is a lambda expression or switch rule lambda.
checkLoop(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
Checks if a given loop terminated by return, throw or, if allowed break, continue.
checkMax(int, int, String, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
Utility for reporting if a maximum has been exceeded.
checkMethodCall(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
Check whether the method call should be violated.
checkMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Control whether to check references to methods.
checkModifiers() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indentation level of modifiers.
checkModifiers() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MemberDefHandler
 
checkModifiers() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
 
checkModifiers(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Checks that method has final and static modifiers.
checkName - Variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
The source name of the suppressed check.
checkName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Checks that method name is @quot;main@quot;.
checkNestedIdent(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
Check if nested ident is parameter.
checkNonListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation level of a child that is not a list of statements.
checkOrderInTagSection(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
Checks order of atclauses in tag section node.
checkOrderSuggestedByJls(List<DetailAST>) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
Checks if the modifiers were added in the order suggested in the Java language specification.
checkOverloadMethodsGrouping(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck
Checks that if overload methods are grouped together they should not be separated from each other.
checkParagraphTag(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
Determines whether or not the line with paragraph tag has previous empty line.
checkParam(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
Checks if the given parameter is final.
checkParams(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Checks that method has only String[] or only String... param.
checkParamTags(List<JavadocTag>, DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Checks a set of tags for matching parameters.
checkPattern - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
The pattern for check class names.
checkPattern - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
The pattern for check class names.
checkRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
The regexp to match check names against.
checkRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
The regexp to match check names against.
checkResourceVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
Checks resource variable.
checkReturnTag(List<JavadocTag>, int, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Checks for only one return tag.
checkRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Check the indentation of the right curly brace.
checkRightParen(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Check the indentation of the right parenthesis.
checks - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
Define the RegExp for matching against the name of the check associated with an audit event.
checks - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
Define a Regular Expression matched against the name of the check associated with an audit event.
checkSingleLineComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
Checks if single-line comment is legal.
checkSlist(DetailAST, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
Checks if a given SLIST terminated by return, throw or, if allowed break, continue.
CHECKSTYLE_BUNDLE - Static variable in class com.puppycrawl.tools.checkstyle.Definitions
Name of resource bundle for Checkstyle.
CHECKSTYLE_PACKAGES - Static variable in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Name of default checkstyle package names resource file.
CHECKSTYLE_PREFIX - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Optional prefix for warning suppressions that are only intended to be recognized by checkstyle.
CheckstyleAntTask - Class in com.puppycrawl.tools.checkstyle.ant
An implementation of an ANT task for calling checkstyle.
CheckstyleAntTask() - Constructor for class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
 
CheckstyleAntTask.Formatter - Class in com.puppycrawl.tools.checkstyle.ant
Details about a formatter to be used.
CheckstyleAntTask.FormatterType - Class in com.puppycrawl.tools.checkstyle.ant
Poor man enumeration for the formatter types.
CheckstyleAntTask.Property - Class in com.puppycrawl.tools.checkstyle.ant
Represents a property that consists of a key and value.
CheckstyleErrorListener() - Constructor for class com.puppycrawl.tools.checkstyle.JavaParser.CheckstyleErrorListener
 
CheckstyleException - Exception in com.puppycrawl.tools.checkstyle.api
Represents an error condition within Checkstyle.
CheckstyleException(String) - Constructor for exception com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance.
CheckstyleException(String, Throwable) - Constructor for exception com.puppycrawl.tools.checkstyle.api.CheckstyleException
Creates a new CheckstyleException instance that was caused by another exception.
CheckstyleParserErrorStrategy - Class in com.puppycrawl.tools.checkstyle
Extending BailErrorStrategy allows us to report errors while cancelling the parsing operation.
CheckstyleParserErrorStrategy() - Constructor for class com.puppycrawl.tools.checkstyle.CheckstyleParserErrorStrategy
 
checkStyleType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Checks to see if the AnnotationElementStyleOption is correct.
checkSwitch(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
Checks if a given switch terminated by return, throw or, if allowed break, continue.
checkSwitchExpr() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
Check the indentation of the switch expression.
checkSynchronized(DetailAST, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
Checks if a given synchronized block terminated by return, throw or, if allowed break, continue.
checkSynchronizedExpr() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SynchronizedHandler
Check indentation of expression we synchronized on.
checkTag(int, String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
Verifies that a type definition has a required tag.
checkTag(DetailAST, List<JavadocTag>, String, Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Verifies that a type definition has a required tag.
checkThrows() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
Check the indentation level of the throws clause.
checkThrowsTags(List<JavadocTag>, List<JavadocMethodCheck.ExceptionInfo>, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Checks a set of tags for matching throws.
checkToken(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Checks that token and next token are separated.
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
 
checkTopLevelToken() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
 
checkTrailingComma(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Checks to see if the trailing comma is present if required or prohibited.
checkTranslationKeys(TranslationCheck.ResourceBundle) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Checks resource files in bundle for consistency regarding their keys.
checkTry(DetailAST, boolean, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
Checks if a given try/catch/finally block terminated by return, throw or, if allowed break, continue.
checkTryResources(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
Checks indentation of resources parameters in try resources.
checkTryResParen(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
Method to check the indentation of left paren or right paren.
checkType() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MemberDefHandler
Check the indentation of the method type.
checkType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Checks the given type, its arguments and parameters.
checkType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Checks that return type is void.
checkTypeArguments(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Checks the type arguments of the node.
checkTypeBounds(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Checks the upper and lower bounds for the given type.
checkTypeDefinition(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
Checks if type definition has unnecessary semicolon.
checkTypeMember(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
Checks if type member has unnecessary semicolon.
checkTypeParameters(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Checks the type parameters of the node.
checkTypeParamTag(DetailAST, List<JavadocTag>, String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Verifies that a type definition has the specified param tag for the specified type parameter name.
checkUnclosedTags(Deque<HtmlTag>, String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Checks to see if there are any unclosed tags on the stack.
checkUnusedParamTags(List<JavadocTag>, List<String>, List<String>) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Checks for unused param tags for type parameters and record components.
CheckUtil - Class in com.puppycrawl.tools.checkstyle.utils
Contains utility methods for the checks.
CheckUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Prevent instances.
checkVariableDefinition(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
Checks if variable definition has unnecessary semicolon.
checkWhileExpr() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DoWhileHandler
Check the indentation level of the while and conditional expression.
checkWrappingIndentation(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Checks indentation on wrapped lines between and including firstNode and lastNode.
checkWrappingIndentation(DetailAST, DetailAST, int, int, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Checks indentation on wrapped lines between and including firstNode and lastNode.
checkYield() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.YieldHandler
Check the indentation of the yield keyword.
child - Variable in class com.puppycrawl.tools.checkstyle.JavaAstVisitor.DetailAstPair
The child (potentially with siblings) of this pair.
childContext - Variable in class com.puppycrawl.tools.checkstyle.Checker
The context of all child components.
childContext - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
Context of child components.
childCount - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Number of children.
children - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Set of frame's children.
children - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
List of children AbstractImportControl objects.
children - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
Array of child nodes.
children - Variable in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
The list of child Configurations.
children - Variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
The children.
CHILDREN - com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith
Omit current node and start with child nodes.
chopString(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
Returns the specified string chopped to MAX_QUOTED_LENGTH plus an ellipsis (...) if the length of the string exceeds MAX_QUOTED_LENGTH.
clangComments - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
Map of the C comments indexed on the first line of the comment to a list of comments on that line.
CLASS_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A class declaration.
CLASS_FRAME - com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
Class frame type.
CLASS_MAX_NCSS - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
Default constant for max file ncss.
CLASS_MEMBER_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
Set of class member tokens.
CLASS_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Exception class name.
CLASS_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
Regex to match class names.
classAst - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
AST of class definition.
ClassContext(String, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
Create new context associated with given class.
ClassDataAbstractionCouplingCheck - Class in com.puppycrawl.tools.checkstyle.checks.metrics
Measures the number of instantiations of other classes within the given class or record.
ClassDataAbstractionCouplingCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck
Creates bew instance of the check.
ClassDefHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for class definitions.
ClassDefHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
classDepth - Variable in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Class definition depth.
ClassDesc(String, int, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
Create a new ClassDesc instance.
classes - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
Specify fully qualified class names that should not be instantiated.
classesContexts - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Stack of class contexts.
ClassFanOutComplexityCheck - Class in com.puppycrawl.tools.checkstyle.checks.metrics
Checks the number of other types a given class/record/interface/enum/annotation relies on.
ClassFanOutComplexityCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck
Creates new instance of this check.
classFieldNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
Set of all class field names.
ClassFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
Creates new instance of ClassFrame.
ClassImportRule - Class in com.puppycrawl.tools.checkstyle.checks.imports
Represents whether a class is allowed to be imported or not.
ClassImportRule(boolean, boolean, String, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.ClassImportRule
Constructs an instance.
classInfo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
Class information associated with this exception.
ClassInfo(JavadocMethodCheck.Token) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ClassInfo
Creates new instance of class information object.
classMaximum - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
Specify the maximum allowed number of non commenting lines in a class.
ClassMemberImpliedModifierCheck - Class in com.puppycrawl.tools.checkstyle.checks.modifier
Checks for implicit modifiers on nested types in classes and records.
ClassMemberImpliedModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
 
className - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ClassImportRule
Package to control access to.
className - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
Own class name.
classNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
The class names defined in the file.
classOrEnumOrRecordDef - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Whether the frame is CLASS_DEF, ENUM_DEF, ENUM_CONST_DEF, or RECORD_DEF.
classpath - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Class path to locate class files.
CLASSPATH_URL_PROTOCOL - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Pseudo URL protocol for loading from the class path.
ClassTypeParameterNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
Checks that class type parameter names conform to a specified pattern.
ClassTypeParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck
Creates a new ClassTypeParameterNameCheck instance.
cleanDefaultTokensText(String) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Clean up the default token text by removing hyperlinks, and only keeping token type text.
clear() - Method in class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
Clears the BeforeExecutionFileFilterSet.
clear() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
Clears the FilterSet.
clearBranchTokenTypes() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Clears branchTokenTypes cache for all parents of the current DetailAST instance, and the child count for the current DetailAST instance.
clearCache() - Static method in class com.puppycrawl.tools.checkstyle.api.Violation
Clears the cache.
clearCache() - Method in class com.puppycrawl.tools.checkstyle.Checker
Clears the cache.
clearChildCountCache(DetailAstImpl) - Static method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Clears the child count for the ast instance.
clearCreatedHandlers() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
Clears cache of created handlers.
clearViolations() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
Clears the sorted set of Violation of the check.
CliOptions() - Constructor for class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator.CliOptions
 
CliOptions() - Constructor for class com.puppycrawl.tools.checkstyle.Main.CliOptions
 
close(Closeable) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Closes a stream re-throwing IOException as IllegalStateException.
CLOSE - com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
Close stream in the end.
CLOSE_ANGLE_BRACKET - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Close angle bracket literal.
CLOSE_ANGLE_BRACKET - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
Close angle bracket literal.
CLOSE_PARENTHESIS - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
Close parenthesis literal.
closedTag - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
If this tag is self-closed.
closeError - Variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
Close error stream after use.
closeErrorWriter - Variable in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
Close output stream in audit finished.
closeInfo - Variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
Close info stream after use.
closeStream - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
Close output stream in auditFinished.
closeStream - Variable in class com.puppycrawl.tools.checkstyle.XMLLogger
Close output stream in auditFinished.
closeStream - Variable in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
Close output stream in auditFinished.
closeStreams() - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
Flushes the output streams and closes them if needed.
closingParens - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Define the policy for ending parenthesis.
ClosingParensOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ClosingParensOption
 
CODE - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
{@code}.
CODE_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
'@code' literal in {@code} Javadoc inline tag.
CodePointUtil - Class in com.puppycrawl.tools.checkstyle.utils
Contains utility methods for code point.
CodePointUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.CodePointUtil
Stop instances being created.
CodeSelector - Class in com.puppycrawl.tools.checkstyle.gui
Helper class to select a code.
CodeSelector(Object, JTextArea, List<Integer>) - Constructor for class com.puppycrawl.tools.checkstyle.gui.CodeSelector
Constructor.
CodeSelectorPresentation - Class in com.puppycrawl.tools.checkstyle.gui
Presentation model for CodeSelector.
CodeSelectorPresentation(DetailAST, List<Integer>) - Constructor for class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
Constructor.
CodeSelectorPresentation(DetailNode, List<Integer>) - Constructor for class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
Constructor.
col - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
The column in which the invalid tag occurs.
COL_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Col tag name.
COL_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Col html tag.
COLGROUP - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Colgroup html tag.
COLGROUP_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Colgroup tag name.
COLGROUP_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
End colgroup tag.
COLGROUP_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Start colgroup tag.
collapseWhitespace(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
Collapse whitespaces.
collect - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
Flag to indicate when time to start collecting references.
collectDeclarations(Deque<RequireThisCheck.AbstractFrame>, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Parses the next AST for declarations.
collectFirstNodes(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Finds first nodes on line and puts them into Map.
collectReferencesFromJavadoc(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
Collects references made in Javadoc comments.
collectReferencesFromJavadoc(TextBlock) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
Process a javadoc TextBlock and return the set of classes referenced within.
collectVariableDeclarations(DetailAST, RequireThisCheck.AbstractFrame) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Collects variable declarations.
COLON - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The : (colon) operator.
COLOR_KEY_TABLE_BACKGROUND - Static variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
The background color for table.
COLOR_KEY_TABLE_SELECTION_BACKGROUND - Static variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
The background color for selected cells.
COLOR_KEY_TABLE_SELECTION_FOREGROUND - Static variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
The text color for selected cells.
column - Variable in class com.puppycrawl.tools.checkstyle.api.LineColumn
The zero-based column number.
column - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
The column number of the tag.
COLUMN_NAMES - Static variable in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Column names.
COLUMN_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
The placeholder for column.
columnCharIndex - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
The column char index.
columnFilter - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
Column number filter.
columnNo - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
The column number.
columnNo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
Token's column number.
columnNo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
The column number of the tag.
columnNo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser.Point
Column number.
columnNo - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
The column number.
columnNo - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
Suppression column number.
columnNumber - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
Column number.
columnNumber - Variable in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
The column number of the element for which the query should be generated.
columns - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
Specify a comma-separated list of values, where each value is an integer or a range of integers denoted by integer-integer.
columnsCsv - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
CSV for column number filter.
com.puppycrawl.tools.checkstyle - package com.puppycrawl.tools.checkstyle
Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.ant - package com.puppycrawl.tools.checkstyle.ant
Contains code related to Checkstyle Ant Task.
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.annotation - package com.puppycrawl.tools.checkstyle.checks.annotation
Contains the Annotation 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 Class Design checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.header - package com.puppycrawl.tools.checkstyle.checks.header
File Header checks.
com.puppycrawl.tools.checkstyle.checks.imports - package com.puppycrawl.tools.checkstyle.checks.imports
Contains the Imports 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.javadoc - package com.puppycrawl.tools.checkstyle.checks.javadoc
Contains the Javadoc checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.javadoc.utils - package com.puppycrawl.tools.checkstyle.checks.javadoc.utils
Contains utils classes for 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.modifier - package com.puppycrawl.tools.checkstyle.checks.modifier
Contains the modifier checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.naming - package com.puppycrawl.tools.checkstyle.checks.naming
Contains the Naming conventions checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.regexp - package com.puppycrawl.tools.checkstyle.checks.regexp
Contains the regular expression checks that are bundled with the main distribution.
com.puppycrawl.tools.checkstyle.checks.sizes - package com.puppycrawl.tools.checkstyle.checks.sizes
Contains the Size Violations 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.filefilters - package com.puppycrawl.tools.checkstyle.filefilters
Contains the before execution file filters 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.grammar - package com.puppycrawl.tools.checkstyle.grammar
Contains the grammar used by the Checkstyle framework.
com.puppycrawl.tools.checkstyle.gui - package com.puppycrawl.tools.checkstyle.gui
User interface classes for CheckStyle.
com.puppycrawl.tools.checkstyle.meta - package com.puppycrawl.tools.checkstyle.meta
Contains module metadata generation classes for checkstyle.
com.puppycrawl.tools.checkstyle.utils - package com.puppycrawl.tools.checkstyle.utils
Contains utils classes for checkstyle.
com.puppycrawl.tools.checkstyle.xpath - package com.puppycrawl.tools.checkstyle.xpath
Contains the nodes implementations for XPATH queries and query generator.
com.puppycrawl.tools.checkstyle.xpath.iterators - package com.puppycrawl.tools.checkstyle.xpath.iterators
Contains the nodes implementations for XPATH queries and query generator.
combineExceptionInfo(List<JavadocMethodCheck.ExceptionInfo>, List<JavadocMethodCheck.ExceptionInfo>) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Combine ExceptionInfo lists together by matching names.
COMMA - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Comma separator between parameters in JavadocTokenTypes.PARAMETERS part of JavadocTokenTypes.REFERENCE.
COMMA - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The , (comma) operator.
COMMA_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Comma separator for StringTokenizer.
Comment - Class in com.puppycrawl.tools.checkstyle.api
Representation of the comment block.
Comment(String[], int, int, int) - Constructor for class com.puppycrawl.tools.checkstyle.api.Comment
Creates new instance.
COMMENT_CONTENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Text of single-line or block comment.
commentChecks - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
Registered comment checks.
commentFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
Specify the RegExp for the first comment inside empty catch block.
commentFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Specify comment pattern to trigger filter to begin suppression.
CommentListener - Interface in com.puppycrawl.tools.checkstyle.grammar
This interface is used to be notified by parser about comments in the parsed code.
CommentsIndentationCheck - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Controls the indentation between comments and surrounding code.
CommentsIndentationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
 
CommentSuppressor - Class in com.puppycrawl.tools.checkstyle.checks.regexp
Implementation of a MatchSuppressor that suppresses based on whether in a comment.
CommentSuppressor(FileContents) - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.CommentSuppressor
Constructor for this suppressor.
CommonUtil - Class in com.puppycrawl.tools.checkstyle.utils
Contains utility methods.
CommonUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Stop instances being created.
COMPACT - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ElementStyleOption
Compact example
COMPACT_CTOR_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A compact canonical constructor eliminates the list of formal parameters; they are declared implicitly.
COMPACT_NO_ARRAY - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ElementStyleOption
Compact example
compare(String, String, boolean) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Compares two strings.
compareCommonAncestorChildrenOrder(NodeInfo, NodeInfo) - Static method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Walks up the hierarchy until a common ancestor is found.
compareContainerOrder(String, String, boolean) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Compares two import strings.
compareImports(String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Checks compare two import paths.
compareOrder(NodeInfo) - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
Compares current object with specified for order.
compareOrder(NodeInfo) - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Compares current object with specified for order.
compareOrder(NodeInfo) - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
Compares current object with specified for order.
compareTo(LineColumn) - Method in class com.puppycrawl.tools.checkstyle.api.LineColumn
 
compareTo(Violation) - Method in class com.puppycrawl.tools.checkstyle.api.Violation
 
compareTo(SuppressionCommentFilter.Tag) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
Compares the position of this tag in the file with the position of another tag.
COMPARISON_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
The token types that identify comparison operators.
COMPILATION_UNIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
This is the root node for the source file.
compilationUnit() - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
Creates a new top-level frame for the compilation unit.
compileFlags - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
Flags to compile a regular expression with.
compileFlags(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
Specifies the compile-flags to compile a regular expression with and returns Builder object.
compilePatterns(String...) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Compiles the list of package groups and the order they should occur in the file.
COMPOUND_ASSIGN_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Set of all compound assign tokens.
CONDITIONALS_AND_RELATIONAL - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
Token types for conditional and relational operators.
config - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Config file containing configuration.
config - Variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Configuration object.
CONFIG_HASH_KEY - Static variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
The property key to use for storing the hashcode of the configuration.
configHash - Variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Generated configuration hash.
configStack - Variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The loaded configurations.
Configurable - Interface in com.puppycrawl.tools.checkstyle.api
A component that can be configured.
configuration - Variable in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
The configuration of this bean.
configuration - Variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The Configuration that is being built.
Configuration - Interface in com.puppycrawl.tools.checkstyle.api
A Configuration is used to configure a Configurable component.
configurationFile - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Config file location.
ConfigurationLoader - Class in com.puppycrawl.tools.checkstyle
Loads a configuration from a standard configuration XML file.
ConfigurationLoader(PropertyResolver, boolean, ThreadModeSettings) - Constructor for class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Creates a new ConfigurationLoader instance.
ConfigurationLoader.IgnoredModulesOptions - Enum in com.puppycrawl.tools.checkstyle
Enum to specify behaviour regarding ignored modules.
ConfigurationLoader.InternalLoader - Class in com.puppycrawl.tools.checkstyle
Implements the SAX document handler interfaces, so they do not appear in the public API of the ConfigurationLoader.
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.
ConstantNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
Checks that constant names conform to a specified pattern.
ConstantNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck
Creates a new ConstantNameCheck instance.
constantWaiverParentToken - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
Specify tokens that are allowed in the AST path from the number literal to the enclosing constant definition.
ConstructorFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ConstructorFrame
Creates a constructor frame.
constructSubTreeText(DetailNode, int, int) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Performs a DFS of the subtree with a node as the root and constructs the text of that tree, ignoring JavadocToken texts.
consume(CharStream) - Method in class com.puppycrawl.tools.checkstyle.grammar.CrAwareLexerSimulator
Overrides the 'consume()' method to add support for '\r' (carriage return) line endings.
CONTAINERS_FOR_ANON_INNERS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
An array of blocks in which local anon inner classes can exist.
containsAllSafeTokens(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
Looks for all "safe" Token combinations in the argument expression branch.
containsAnnotation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Checks if the AST is annotated with any annotation.
containsAnnotation(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Checks if the AST is annotated with the passed in annotation.
containsAnnotation(DetailAST, Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Checks if the given AST element is annotated with any of the specified annotations.
containsAttribute(Configuration, String) - Method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
Util method to recheck attribute in module.
containsBreak - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.ScopeData
Whether there is a break in the scope.
containsDefaultCaseLabelElement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
Checks if a switch block contains a default case label.
containsDefaultLabel(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
Checks if the case group or its sibling contain the 'default' switch.
containsDeprecatedTag(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
Checks to see if the javadoc contains a deprecated tag.
containsFieldOrVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
Check whether the frame contains a field or a variable with the given name.
containsFieldOrVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
 
containsFieldOrVariableDef(Set<DetailAST>, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
Whether the set contains a declaration with the text of the specified IDENT ast and it is declared in a proper position.
containsFile(String) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
Checks whether a resource bundle contains a file which name matches file name regexp.
containsForbiddenFragment(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
Tests if first sentence contains forbidden summary fragment.
containsInBranch(DetailNode, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
Checks whether node contains any node of specified type among children on any deep level.
containsInheritDocTag(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
Checks to see if the ast contains a inheritDoc tag.
containsInstanceField(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
Determines whether this FieldFrame contains an instance field.
containsMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
Check whether the frame contains a given method.
containsMethodDef(Set<DetailAST>, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
Whether the set contains a method definition with the same name and number of parameters.
containsOneArgument(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
Verify that method call has one argument.
containsPatternCaseLabelElement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
Checks if a switch block contains a case label with a pattern variable definition.
containsRegexAttribute(Attributes) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
Check if the given attributes contain the regex attribute.
containsStaticField(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
Determines whether this FieldFrame contains a static field.
containsWhitespaceBefore(int, int...) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
Returns whether the specified string contains only whitespace up to specified index.
containsWhitespaceBetween(int, int, int...) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
Returns whether the specified string contains only whitespace between specified indices.
contentHashSum - Variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile.ExternalResource
Hash sum which is calculated based on resource content.
context - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
The check context.
context - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
The check context.
context - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
Current method context.
context - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
The file context.
context - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
Current context.
context - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
Current method context.
Context - Interface in com.puppycrawl.tools.checkstyle.api
A context to be used in subcomponents.
Context(boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
Creates new method context.
Context(boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.Context
Creates new instance.
Context(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.Context
Creates new member context.
contextStack - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
Stack of method contexts.
contextStack - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
Stack of contexts.
contextStack - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
Stack of method contexts.
Contextualizable - Interface in com.puppycrawl.tools.checkstyle.api
A Component that needs context information from its container(parent object) to work.
contextualize(Context) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Implements the Contextualizable interface using bean introspection.
contextualize(Context) - Method in interface com.puppycrawl.tools.checkstyle.api.Contextualizable
Sets the context for this Component.
CONTROL_CONTEXT - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
Allowed AST types from an assignment AST node towards the root.
convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean.PatternConverter
 
convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean.RelaxedAccessModifierArrayConverter
 
convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean.RelaxedStringArrayConverter
 
convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean.ScopeConverter
 
convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean.SeverityLevelConverter
 
convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean.UriConverter
 
convertLinesToString(String...) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
Convert array of string to single String.
convertParseTreeToDetailNode(ParseTree) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Converts ParseTree (that is generated by ANTLRv4) to DetailNode tree.
convertToString(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
Converts given AST node to string representation.
convertUpperCamelToUpperUnderscore(String) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Converts the given text from camel case to all upper case with underscores separating each word.
copy(Receiver, int, Location) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Copy method.
count - Variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
Keeps track of the number of counted events.
count - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
Counter for return statements.
count - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.Context
Count of boolean operators.
count - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.Counter
The counters internal integer.
count - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.Context
Counter for context elements.
countCaseConstants(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
Counts number of case constants (EXPR) tokens in a switch labeled rule.
countCaseTokens(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
Counts number of case tokens subject to a case group token.
countComponents(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
Method to count the number of record components in this record definition.
countConditionalOperators(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
Calculates number of conditional operators, including inline ternary operator, for a token.
countEmpty - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
Control whether to count empty lines and comments.
countEmptyLines(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
Count the number of empty lines between statements.
counter - Variable in class com.puppycrawl.tools.checkstyle.Checker
Maintains error count.
Counter() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.Counter
 
counters - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
List containing the stacked counters.
counters - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
Maintains stack of counters, to support inner types.
countLinesColumns(String, int, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.ParserUtil
Count lines and columns (in last line) in text.
countMatches(Pattern, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
Count regexp matches into String literal.
countOfSemiInLambda - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
Counts number of semicolons in nested lambdas.
counts - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Counts of descendant tokens.
counts - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
Maintains the counts.
countTokens(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
Counts the number of occurrences of descendant tokens.
countUsedLines(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
Count number of used code lines without comments.
CovariantEqualsCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks that classes and records which define a covariant equals() method also override method equals(Object).
CovariantEqualsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
 
cppComments - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
Map of the C++ comments indexed on the first line of the comment.
CR - com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
Mac-style line separators.
CrAwareLexerSimulator - Class in com.puppycrawl.tools.checkstyle.grammar
Extends the LexerATNSimulator class in order to override the 'consume()' method so that we can handle '\r' line endings (pre-OSX macOS line endings) correctly in the ANTLR lexer.
CrAwareLexerSimulator(Lexer, ATN, DFA[], PredictionContextCache) - Constructor for class com.puppycrawl.tools.checkstyle.grammar.CrAwareLexerSimulator
Constructs a CrAwareLexerSimulator to interpret the input from the lexer.
create(int, Token) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Create a DetailAstImpl from a given token and token type.
create(Token) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Create a DetailAstImpl from a given token.
create(TerminalNode) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Create a DetailAstImpl from a given TerminalNode.
CREATE_LISTENER_EXCEPTION - Static variable in class com.puppycrawl.tools.checkstyle.Main
A key pointing to the create listener exception message in the "messages.properties" file.
createBeanUtilsBean() - Static method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Creates a BeanUtilsBean that is configured to use type converters that throw a ConversionException instead of using the default value when something goes wrong.
createBlockCommentNode(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.ParserUtil
Create block comment from string content.
createBlockCommentNode(CommonToken) - Static method in class com.puppycrawl.tools.checkstyle.utils.ParserUtil
Create block comment from token.
createButtonsPanel() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame
Create buttons panel.
createCharset(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
Creates charset by name.
createChildren() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Creates nodes for children.
createChildren() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
Creates nodes for children.
createChildren() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Iterates children of the current node and recursively creates new Xpath-nodes.
createChildren() - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
Iterates siblings of the current node and recursively creates new Xpath-nodes.
createChildren(AbstractNode, AbstractNode, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
Iterates siblings of the given node and creates new Xpath-nodes.
createChildrenNodes(JavadocNodeImpl, ParseTree) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Creates children Javadoc nodes base on ParseTree node's children.
createClasspath() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Creates classpath.
createCommentAstFromToken(CommonToken) - Static method in class com.puppycrawl.tools.checkstyle.JavaParser
Create comment AST from token.
createContent() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame
Create content of this MainFrame.
createDefaultLogger(Task) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
Creates default logger.
createdHandlers - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
Cache for created method call handlers.
createFromStandardCheckSet(String) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Create object from one of Checkstyle module names.
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.
createIdToResourceNameMap() - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Creates mapping between local resources and dtd ids.
createIdToResourceNameMap() - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
Creates mapping between local resources and dtd ids.
createIdToResourceNameMap() - Static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
Creates mapping between local resources and dtd ids.
createImaginary(int) - Static method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Create a DetailAstImpl from a given token and token type.
createImportRule(String, Attributes) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
Constructs an instance of an import rule based on the given name and attributes.
createJavadocNode(ParseTree, DetailNode, int) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Creates JavadocNodeImpl node on base of ParseTree node.
createJavadocParser(String, JavadocDetailNodeParser.DescriptiveErrorListener) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Parses block comment content as javadoc comment.
createLambdaParameter(JavaLanguageParser.IdContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Creates a 'PARAMETER_DEF' node for a lambda expression, with imaginary modifier and type nodes.
createListener(Main.OutputFormat, Path) - Static method in class com.puppycrawl.tools.checkstyle.Main
This method creates in AuditListener an open stream for validation data, it must be closed by RootModule (default implementation is Checker) by calling AuditListener.auditFinished(AuditEvent).
createListener(OutputStream, AutomaticBean.OutputStreamOptions) - Method in enum com.puppycrawl.tools.checkstyle.Main.OutputFormat
Returns a new AuditListener for this OutputFormat.
createListener(Task) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
Creates a listener for the formatter.
createMainFrame(String...) - Static method in class com.puppycrawl.tools.checkstyle.gui.Main
Helper method to create the MainFrame instance.
createMethodCallHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
Create new instance of handler for METHOD_CALL.
createModifiers(List<? extends ParseTree>) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Builds the modifiers AST.
createModule(String) - Method in interface com.puppycrawl.tools.checkstyle.ModuleFactory
Creates a new instance of a class from a given name.
createModule(String) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Creates a new instance of a class from a given name, or that name concatenated with "Check".
createModuleByTryInEachPackage(String) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Searching to class with given name (or name concatenated with "Check") in existing packages.
createNewCheckSortedSet() - Static method in class com.puppycrawl.tools.checkstyle.TreeWalker
Creates a new SortedSet with a deterministic order based on the Check's name before the default ordering.
createNewClassContext(String, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Creates new inner class context with given name and location.
createObject(String) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Creates a new instance of a named class.
createObjectFromFullModuleNames(String, Set<String>) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Create Object from optional full module names.
createObjectFromMap(String, Map<String, Set<String>>) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Create object with the help of the supplied map.
createOverridingProperties() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Create the Properties object based on the arguments specified to the ANT task.
createPattern(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
Creates pattern to use by DetectorOptions instance.
createPattern(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Helper method to create a regular expression.
createPattern(String, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Helper method to create a regular expression with a specific flags.
createPatternForExactMatch(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
Creates a Pattern from expression.
createPatternForExactMatch(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
Creates a Pattern from expression.
createPatternForPartialMatch(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
Creates a Pattern from expression that matches exactly and child packages.
createProperties(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Create the modulePropertyDetails content.
createProperties(Element) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
Create module property details from the XML metadata.
createPropertySection(ModuleDetails, Element, Document) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
Create the property section of the module detail object.
createRootJavadocNode(ParseTree) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Creates root JavadocNodeImpl node base on ParseTree root node.
createRootModule() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Creates new instance of the root module.
createSamePackageRegexp(int, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Creates samePackageDomainsRegExp of the first package domains.
createSlCommentNode(CommonToken) - Static method in class com.puppycrawl.tools.checkstyle.JavaParser
Create single-line comment from token.
createTypeDeclaration(ParserRuleContext, int, List<? extends ParseTree>) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Creates a type declaration DetailAstImpl from a given rule context.
createUnsupportedOperationException() - Static method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Returns UnsupportedOperationException exception.
createXmlLogger(Task) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
Creates XML logger.
createXmlReader(DefaultHandler) - Static method in class com.puppycrawl.tools.checkstyle.XmlLoader
Helper method to create XMLReader.
createXpathButtonsPanel() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame
Create xpath buttons panel.
CRLF - com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
Windows-style line separators.
CsvFilterElement - Class in com.puppycrawl.tools.checkstyle.filters
This filter element is immutable and accepts an integer that matches a CSV value, where each value is an integer or a range of integers.
CsvFilterElement(String) - Constructor for class com.puppycrawl.tools.checkstyle.filters.CsvFilterElement
Constructs a CsvFilterElement from a CSV, Comma-Separated Values, string.
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.
CTOR_FRAME - com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
Constructor frame type.
curlyIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
 
curlyIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
 
curlyIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Get the expected indentation level for the curly braces.
curlyIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
 
current - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Frame for the currently processed AST.
CURRENT_NODE - com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith
Start with current node.
currentClass - Variable in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Current class name.
currentClassName - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Name of current class.
currentContents - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.CommentSuppressor
File contents to check for comments.
currentDepth - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
Tracks the current depth in types.
currentFile - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
The file which is being parsed.
currentFrame - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
Stack of sets of field names, one for each class of a set of nested classes.
currentFrame - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
The scope is being processed.
currentImportControl - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
The package controller for the current file.
currentMatches - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
Tracks the number of matches.
currentMatches - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
Tracks the number of matches.
currentRangeValue - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
NP value for current range.
currentScopeAssignedVariables - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
Assigned variables of current scope.
currentScopeState - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.ScopeState
The state the check is in.
currentValue - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
The current value.
CUSTOM_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Name of custom Javadoc tag (or Javadoc inline tag).
CustomImportOrderCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
Checks that the groups of import declarations appear in the order specified by the user.
CustomImportOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
 
CustomImportOrderCheck.ImportDetails - Class in com.puppycrawl.tools.checkstyle.checks.imports
Contains import attributes as line number, import full path, import group.
CustomImportOrderCheck.RuleMatchForImport - Class in com.puppycrawl.tools.checkstyle.checks.imports
Contains matching attributes assisting in definition of "best matching" group for import.
customImportOrderRules - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Specify format of order declaration customizing by user.
customLeaveToken(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Leave all ast nodes under UnusedLocalVariableCheck.anonInnerClassHolders once again.
customMessage - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
A custom violation overriding the default violation from the bundle.
customOrderRules - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Processed list of import order rules.
customVisitToken(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Visit all ast nodes under UnusedLocalVariableCheck.anonInnerClassHolders once again.
CyclomaticComplexityCheck - Class in com.puppycrawl.tools.checkstyle.checks.metrics
Checks cyclomatic complexity against a specified limit.
CyclomaticComplexityCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
 

D

DD - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Description of a term html tag: <dd></dd>.
DD_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Description of a term tag name.
DD_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
End description of a term tag.
DD_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Start description of a term tag.
debug - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Option that controls whether to print debug info.
DEC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The -- (prefix decrement) operator.
DECLARATION_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Set of all declaration tokens.
declarationAccess - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.ScopeState
The sub-state the check is in.
DeclarationOrderCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks that the parts of a class, record, or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.
DeclarationOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
 
DeclarationOrderCheck.ScopeState - Class in com.puppycrawl.tools.checkstyle.checks.coding
Private class to encapsulate the state.
declaredAsAbstract - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
Is class declared as abstract.
declaredAsFinal - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
Is class declared as final.
declaredTypes - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
Nested types declared in the current scope.
DEF_TOKEN_TYPES - Static variable in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
Default token types.
DEF_TOKEN_TYPES_DEPRECATED - Static variable in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
Default token types for DEPRECATED Javadoc tag.
DEFAULT - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
Default attribute.
DEFAULT_ALLOWED_ABBREVIATIONS_LENGTH - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
The default value of "allowedAbbreviationLength" option.
DEFAULT_CHECK_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Control all checks.
DEFAULT_CHECK_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Default regex for checks that should be suppressed.
DEFAULT_CHECK_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
Default check format to suppress.
DEFAULT_COMMENT_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Format to turn checkstyle reporting off.
DEFAULT_COMPLEXITY_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
Default allowed complexity.
DEFAULT_DISTANCE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
Default value of distance between declaration of variable and its first usage.
DEFAULT_DUPLICATE_LIMIT - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Default duplicate limit.
DEFAULT_ERROR_LIMIT - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Default error report limit.
DEFAULT_EXCLUDED_CLASSES - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Class names to ignore.
DEFAULT_EXCLUDED_PACKAGES - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Package names to ignore.
DEFAULT_FILE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
Default(UNIX) file separator.
DEFAULT_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
Default value for format and extendedClassNameFormat properties.
DEFAULT_IGNORE_ANNOTATIONS - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Default ignore annotations canonical names.
DEFAULT_IGNORED_METHOD_NAMES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Default ignored method names.
DEFAULT_ILLEGAL_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Types illegal by default.
DEFAULT_IMMUTABLE_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Default immutable types canonical names.
DEFAULT_INDENTATION - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Default indentation amount - based on Sun.
DEFAULT_INDENTATION - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
Default tag continuation indentation.
DEFAULT_INFLUENCE_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
Default regex for lines that should be suppressed.
DEFAULT_LINE_NUMBER - Static variable in class com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck
Line number used to log violation when no AST nodes are present in file.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
Default value of max property.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
Default allowed complexity.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck
Default allowed complexity.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck
Default value of max value.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
Default allowed complexity.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
Default maximum number of lines.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
Default threshold.
DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
Default maximum number of lines.
DEFAULT_MAX_COLUMNS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
Default maximum number of columns in a line.
DEFAULT_MAX_COMPONENTS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
Default maximum number of allowed components.
DEFAULT_MAX_LINES - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
Default maximum number of lines.
DEFAULT_MAX_LINES - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
Default maximum number of lines.
DEFAULT_MAX_METHODS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
Default maximum number of methods.
DEFAULT_MAX_PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
Default maximum number of allowed parameters.
DEFAULT_MIN_LINE_COUNT - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
Default value of minimal amount of lines in method to allow no documentation.
DEFAULT_OFF_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Turns checkstyle reporting off.
DEFAULT_OFF_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
Comment format which turns checkstyle reporting off.
DEFAULT_ON_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Turns checkstyle reporting on.
DEFAULT_ON_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
Comment format which turns checkstyle reporting on.
DEFAULT_ORDER - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
Default order of atclauses.
DEFAULT_OUTPUT_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Default output format.
DEFAULT_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
Default pattern for type name.
DEFAULT_PERIOD - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
Default period literal.
DEFAULT_SEVERITY - Static variable in class com.puppycrawl.tools.checkstyle.api.Violation
The default severity level if one is not specified.
DEFAULT_TAB_WIDTH - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Default tab width for column reporting.
DEFAULT_TAGS - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
Block tags from Java 11 Documentation Comment Specification.
DEFAULT_THREAD_COUNT - Static variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
The default number of threads to use for checker and the tree walker.
DEFAULT_TRANSLATION_FILE_NAME_FORMATTER - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
File name format for default translation.
DEFAULT_TRANSLATION_REGEXP - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Regexp string for default translation files.
DEFAULT_VALUE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Regular expression for property default value location in class-level javadocs.
DefaultComesLastCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Check that the default is after all the cases in a switch statement.
DefaultComesLastCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
 
DefaultConfiguration - Class in com.puppycrawl.tools.checkstyle
Default implementation of the Configuration interface.
DefaultConfiguration(String) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Instantiates a DefaultConfiguration.
DefaultConfiguration(String, ThreadModeSettings) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Instantiates a DefaultConfiguration.
DefaultContext - Class in com.puppycrawl.tools.checkstyle
A default implementation of the Context interface.
DefaultContext() - Constructor for class com.puppycrawl.tools.checkstyle.DefaultContext
 
DefaultLogger - Class in com.puppycrawl.tools.checkstyle
Simple plain logger for text output.
DefaultLogger(OutputStream, AutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
Creates a new DefaultLogger instance.
DefaultLogger(OutputStream, AutomaticBean.OutputStreamOptions, OutputStream, AutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
Creates a new DefaultLogger instance.
DefaultLogger(OutputStream, AutomaticBean.OutputStreamOptions, OutputStream, AutomaticBean.OutputStreamOptions, AuditEventFormatter) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
Creates a new DefaultLogger instance.
DefaultLogger.LocalizedMessage - Class in com.puppycrawl.tools.checkstyle
Represents a message that can be localised.
defaultValue - Variable in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
Default value of property.
defined - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
Is package defined.
Definitions - Class in com.puppycrawl.tools.checkstyle
Contains constant definitions common to the package.
Definitions() - Constructor for class com.puppycrawl.tools.checkstyle.Definitions
Do no allow Definitions instances to be created.
delayedFireTableDataChanged() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeModelListener
Invokes fireTableDataChanged after all the pending events have been processed.
DELEGATE_TO_PARENT - com.puppycrawl.tools.checkstyle.checks.imports.MismatchStrategy
In a case if matching allow/disallow rule was not found, decision should be delegated to the parent and continue checking.
DELIMITER - Static variable in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
Delimiter to separate xpath results.
DELIMITER - Static variable in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
The delimiter between xpath queries.
DEPRECATED - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
@deprecated.
DEPRECATED - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
Deprecated annotation name.
DEPRECATED_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
'@deprecated' literal in @deprecated Javadoc tag.
depth - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
Current nesting depth.
depth - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
Current nesting depth.
depth - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
Current nesting depth.
depth - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Depth at which a type declaration is nested, 0 for top level type declarations.
depth - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
Depth of nesting of type declaration.
depth - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.TypeDeclarationDescription
Depth of nesting of type declaration.
depth - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
Used to count the depth of a Generic expression.
depth - Variable in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Depth of the node.
DESC_CLEAN - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Regular expression for removal of @code{-} present at the beginning of texts.
descendantEnum - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator
Descendant axis iterator.
descendantEnum - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.FollowingIterator
Descendant axis iterator.
descendantEnum - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.PrecedingIterator
Descendant axis iterator.
DescendantIterator - Class in com.puppycrawl.tools.checkstyle.xpath.iterators
Recursive-free implementation of the descendant axis iterator.
DescendantIterator(NodeInfo, DescendantIterator.StartWith) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator
Create an iterator over the "descendant" axis.
DescendantIterator.StartWith - Enum in com.puppycrawl.tools.checkstyle.xpath.iterators
Enum defines starting node for iterator.
DescendantTokenCheck - Class in com.puppycrawl.tools.checkstyle.checks
Checks for restricted tokens beneath other tokens.
DescendantTokenCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
 
description - Variable in enum com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
Mode's short description.
description - Variable in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
Description of the module.
description - Variable in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
Description of property.
description - Variable in enum com.puppycrawl.tools.checkstyle.PropertyType
The human-readable property description.
DESCRIPTION - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Description node.
DescriptiveErrorListener() - Constructor for class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.DescriptiveErrorListener
 
DesignForExtensionCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
Checks that classes are designed for extension (subclass creation).
DesignForExtensionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
Destroy the check.
destroy() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
destroy() - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
Cleans up the object.
destroy() - Method in interface com.puppycrawl.tools.checkstyle.api.RootModule
Cleans up the object.
destroy() - Method in class com.puppycrawl.tools.checkstyle.Checker
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
 
destroy() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
detailAst - Variable in class com.puppycrawl.tools.checkstyle.api.FullIdent
The topmost and leftmost AST of the full identifier.
detailAst - Variable in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
The ast node.
detailAst - Variable in class com.puppycrawl.tools.checkstyle.xpath.RootNode
The ast node.
DetailAST - Interface in com.puppycrawl.tools.checkstyle.api
An interface of Checkstyle's AST nodes for traversing trees generated from the Java code.
DetailAstImpl - Class in com.puppycrawl.tools.checkstyle
The implementation of DetailAST.
DetailAstImpl() - Constructor for class com.puppycrawl.tools.checkstyle.DetailAstImpl
 
DetailAstPair() - Constructor for class com.puppycrawl.tools.checkstyle.JavaAstVisitor.DetailAstPair
 
DetailAstSet - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Represents a set of abstract syntax tree.
DetailAstSet(IndentationCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
Construct an instance of this class with IndentationCheck parameters.
DetailNode - Interface in com.puppycrawl.tools.checkstyle.api
DetailNode is used to construct tree during parsing Javadoc comments.
DetailNodeTreeStringPrinter - Class in com.puppycrawl.tools.checkstyle
Parses file as javadoc DetailNode tree and prints to system output stream.
DetailNodeTreeStringPrinter() - Constructor for class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
Prevent instances.
details - Variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
The details on files.
Details(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
C-tor.
Details(DetailAST, DetailAST, DetailAST, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
Constructor.
detector - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
The detector to use.
detector - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
The detector to use.
DetectorOptions - Class in com.puppycrawl.tools.checkstyle.checks.regexp
Options for a detector.
DetectorOptions() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
Default constructor.
DetectorOptions.Builder - Class in com.puppycrawl.tools.checkstyle.checks.regexp
Class which implements Builder pattern to build DetectorOptions instance.
determineAssignmentConditions(DetailAST, FinalLocalVariableCheck.FinalVariableCandidate) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
Determines identifier assignment conditions (assigned or already assigned).
directoriesChecked - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
The directories checked.
DISALLOWED - com.puppycrawl.tools.checkstyle.checks.imports.AccessResult
Represents that access is disallowed.
DISALLOWED - com.puppycrawl.tools.checkstyle.checks.imports.MismatchStrategy
In a case if matching allow/disallow rule was not found, import will be disallowed by default.
DIV - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The / (division) operator.
DIV_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The /= (division assignment) operator.
DO_WHILE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
Literal while in do-while loop.
DOC_ROOT - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
{@docRoot}.
DOC_ROOT_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
'@docRoot' literal in {@docRoot} Javadoc inline tag.
doesChainedMethodNeedsLineWrapping() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
The function checks if the new keyword is a child of chained method calls, it checks if the new is directly followed by equal operator or return operator.
DOLLAR_SIGN - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Dollar sign literal.
DOLLAR_SIGN_STRING - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
Dollar sign string.
DOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The . (dot) operator.
DOT - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
The package separator: "."
DOT - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
A package separator - "."
DOT_ESCAPED_REGEX - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
The regex for the escaped package separator: "\\\\.".
DOT_REGEX - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
The regex for the package separator: "\\.".
DOT_REGEX_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
A pattern matching the package separator: "\."
DOUBLE_COLON - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The :: (double colon) separator.
doVisitToken(FullIdent, boolean, boolean, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Shares processing...
doVisitTokenInSameGroup(boolean, boolean, String, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Shares processing...
DoWhileHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for do...while blocks.
DoWhileHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
DT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Description term html tag: <dt></dt>.
DT_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Description term tag name.
DT_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
End description term tag.
DT_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Start description term tag.
DTD_CONFIGURATION_NAME_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The resource for version 1_0 of the configuration dtd.
DTD_CONFIGURATION_NAME_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The resource for version 1_1 of the configuration dtd.
DTD_CONFIGURATION_NAME_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The resource for version 1_2 of the configuration dtd.
DTD_CONFIGURATION_NAME_1_3 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The resource for version 1_3 of the configuration dtd.
DTD_PUBLIC_CS_ID - Static variable in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
The new public ID for the configuration dtd.
DTD_PUBLIC_CS_ID_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The new public ID for version 1_0 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The new public ID for version 1_0 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The new public ID for version 1_0 configuration dtd.
DTD_PUBLIC_CS_ID_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The new public ID for version 1_1 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The new public ID for version 1_1 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The new public ID for version 1_1 configuration dtd.
DTD_PUBLIC_CS_ID_1_1_XPATH - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The new public ID for version 1_1 configuration dtd.
DTD_PUBLIC_CS_ID_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The new public ID for version 1_2 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The new public ID for version 1_2 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The new public ID for version 1_2 configuration dtd.
DTD_PUBLIC_CS_ID_1_2_XPATH - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The new public ID for version 1_2 configuration dtd.
DTD_PUBLIC_CS_ID_1_3 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The new public ID for version 1_3 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_3 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The new public ID for version 1_3 of the configuration dtd.
DTD_PUBLIC_CS_ID_1_4 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The new public ID for version 1_4 of the configuration dtd.
DTD_PUBLIC_ID - Static variable in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The public ID for version 1_0 of the configuration dtd.
DTD_PUBLIC_ID_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The public ID for version 1_1 of the configuration dtd.
DTD_PUBLIC_ID_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_1_XPATH - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The public ID for version 1_2 of the configuration dtd.
DTD_PUBLIC_ID_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_2_XPATH - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_3 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The public ID for the configuration dtd.
DTD_PUBLIC_ID_1_3 - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
The public ID for version 1_3 of the configuration dtd.
DTD_PUBLIC_ID_1_4 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The public ID for the configuration dtd.
DTD_RESOURCE_BY_ID - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The map to look up the resource name by the id.
DTD_RESOURCE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
The resource for the configuration dtd.
DTD_RESOURCE_NAME_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The resource for the configuration dtd.
DTD_RESOURCE_NAME_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The resource for the configuration dtd.
DTD_RESOURCE_NAME_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The resource for the configuration dtd.
DTD_RESOURCE_NAME_1_3 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The resource for the configuration dtd.
DTD_RESOURCE_NAME_1_4 - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
The resource for the configuration dtd.
DTD_SUPPRESSIONS_NAME_1_0 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The resource for the configuration dtd.
DTD_SUPPRESSIONS_NAME_1_1 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The resource for the configuration dtd.
DTD_SUPPRESSIONS_NAME_1_1_XPATH - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The resource for the configuration dtd.
DTD_SUPPRESSIONS_NAME_1_2 - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The resource for the configuration dtd.
DTD_SUPPRESSIONS_NAME_1_2_XPATH - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The resource for the configuration dtd.
dumpMetadata(Checker, String, String...) - Static method in class com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtil
Process files using the checker passed and write to corresponding XML files.
duplicatedKeys - Variable in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck.UniqueProperties
Map, holding duplicated keys and their count.
duplicateLimit - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Control whether to check for duplicates of a required pattern, any negative value means no checking for duplicates, any positive value is used as the maximum number of allowed duplicates, if the limit is exceeded violations will be logged.

E

E_PLAIN - Static variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Poor man's enum for a plain formatter.
E_XML - Static variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Poor man's enum for an xml formatter.
eachLine - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck
Control whether to report on each line containing a tab, or just the first instance.
editor - Variable in class com.puppycrawl.tools.checkstyle.gui.CodeSelector
Editor.
editor - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTable
JTextArea editor.
ElementNode - Class in com.puppycrawl.tools.checkstyle.xpath
Represents element node of Xpath-tree.
ElementNode(AbstractNode, AbstractNode, DetailAST, int, int) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Creates a new ElementNode instance.
elements - Variable in class com.puppycrawl.tools.checkstyle.api.FullIdent
The list holding subsequent elements of identifier.
elementStyle - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
Define the annotation element styles.
ElementStyleOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ElementStyleOption
 
ELIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An expression list.
ELLIPSIS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A triple dot for variable-length parameters.
ElseHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for else blocks.
ElseHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
EMBED_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
"embed" tag name.
EMBED_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
HTML void element <embed>.
EMPTY_ABSTRACT_NODE_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Constant for optimization.
EMPTY_ABSTRACT_NODE_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.xpath.RootNode
Constant for optimization.
EMPTY_BIT_SET - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
For cases where no tokens should be accepted.
EMPTY_BYTE_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Copied from org.apache.commons.lang3.ArrayUtils.
EMPTY_CONFIGURATION_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
Constant for optimization.
EMPTY_DETAIL_NODE_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
Empty array of DetailNode type.
EMPTY_DOUBLE_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Copied from org.apache.commons.lang3.ArrayUtils.
EMPTY_INT_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Copied from org.apache.commons.lang3.ArrayUtils.
EMPTY_INTEGER_OBJECT_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Copied from org.apache.commons.lang3.ArrayUtils.
EMPTY_LINE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
Regex pattern for a blank line.
EMPTY_MODIFIER_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.api.AutomaticBean.RelaxedAccessModifierArrayConverter
Constant for optimization.
EMPTY_OBJECT_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Copied from org.apache.commons.lang3.ArrayUtils.
EMPTY_PATTERN_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Empty array of pattern type needed to initialize check.
EMPTY_STAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The empty statement.
EMPTY_STRING_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Copied from org.apache.commons.lang3.ArrayUtils.
EMPTY_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Non-special empty html tag.
EmptyBlockCheck - Class in com.puppycrawl.tools.checkstyle.checks.blocks
Checks for empty blocks.
EmptyBlockCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
 
EmptyCatchBlockCheck - Class in com.puppycrawl.tools.checkstyle.checks.blocks
Checks for empty catch blocks.
EmptyCatchBlockCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
 
EmptyForInitializerPadCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
Checks the padding of an empty for initializer; that is whether a white space is required at an empty for initializer, or such white space is forbidden.
EmptyForInitializerPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
 
EmptyForIteratorPadCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
Checks the padding of an empty for iterator; that is whether a white space is required at an empty for iterator, or such white space is forbidden.
EmptyForIteratorPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
 
EmptyLineSeparatorCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
Checks for empty line separators before package, all import declarations, fields, constructors, methods, nested classes, static initializers and instance initializers.
EmptyLineSeparatorCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
 
EmptyStatementCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Detects empty statements (standalone ";" semicolon).
EmptyStatementCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
 
ENABLE_EXTERNAL_DTD_LOAD - Static variable in class com.puppycrawl.tools.checkstyle.XmlLoader.LoadExternalDtdFeatureProvider
System property name to enable external DTD load.
encloseInGroup(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
Enclose expression in a (non-capturing) group.
encloseInGroup(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
Enclose expression in a (non-capturing) group.
encode(String) - Static method in class com.puppycrawl.tools.checkstyle.XMLLogger
Escape <, > & ' and " as their entities.
encode(String) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Escape <, >, &, ' and " as their entities.
encodeCharacter(char) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Encodes escape character for Xpath.
END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
End html tag component: '>'.
END_JAVADOC - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Multiline finished at end of comment.
END_OF_SENTENCE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
This regexp is used to extract the first sentence from the text.
endCollectingDeclarations(Queue<RequireThisCheck.AbstractFrame>, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Ends parsing of the AST for declarations.
endColNo - Variable in class com.puppycrawl.tools.checkstyle.api.Comment
Number of last column of the comment.
endColumnNo - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.TokenEnd
End column of token.
endElement(String, String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
 
endElement(String, String, String) - Method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
 
endElement(String, String, String) - Method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
 
endLineNo - Variable in class com.puppycrawl.tools.checkstyle.api.Comment
Number of last line of the comment.
endLineNo - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.TokenEnd
End line of token.
endOfSentenceFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Specify the format for matching the end of a sentence.
endsWith(int[], String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CodePointUtil
Tests if the unicode code points array ends with the specified suffix.
endsWithChar(String, char) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Tests if this string ends with the specified suffix.
endsWithNewline(RandomAccessFile, LineSeparatorOption) - Static method in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
Checks whether the content provided by the Reader ends with the platform specific line separator.
ensureSelfContainedRegex(String, boolean) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
Returns a regex that is suitable for concatenation by 1) either converting a plain string into a regular expression (handling special characters) or 2) by enclosing input in a (non-capturing) group if input already is a regular expression.
enterBlock() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
Enters an inner class, which requires a new variable set.
ENTITIES - Static variable in class com.puppycrawl.tools.checkstyle.XMLLogger
Some known entities to detect.
entries - Variable in class com.puppycrawl.tools.checkstyle.DefaultContext
Stores the context entries.
ENTRIES - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
A thread-local holder for the list of suppression entries for the last file parsed.
Entry(String, int, int, int, int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
Constructs a new suppression region entry.
ENUM - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The enum keyword.
ENUM_CONSTANT_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An enum constant declaration.
ENUM_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An enum declaration.
EOF - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
End Of File symbol.
EOL - com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
Represents the policy for placing the brace at the end of line.
EOL - com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption
Require that the token is at the end of the line.
EQUAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The == (equal) operator.
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.LineColumn
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.api.Violation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.CsvFilterElement
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilterElement
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilterElement
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
 
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
 
EQUALS - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Equals html tag component: '='.
EQUALS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
Method name for comparison.
EqualsAvoidNullCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks that any combination of String literals is on the left side of an equals() comparison.
EqualsAvoidNullCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
 
EqualsAvoidNullCheck.FieldFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
Holds the names of fields of a type.
EqualsHashCodeCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks that classes that either override equals() or hashCode() also overrides the other.
EqualsHashCodeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
 
equalsMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
Set of equals method definitions.
error(SAXParseException) - Method in class com.puppycrawl.tools.checkstyle.XmlLoader
 
ERROR - com.puppycrawl.tools.checkstyle.api.SeverityLevel
Severity level error.
ERROR_COUNTER - Static variable in class com.puppycrawl.tools.checkstyle.Main
A key pointing to the error counter message in the "messages.properties" file.
ERROR_LIMIT_EXCEEDED_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Error count exceeded message.
errorCount - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Tracks number of errors.
errorLimit - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Specify the maximum number of violations before the check will abort.
errorMessage - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.DescriptiveErrorListener
Error message that appeared while parsing.
errors - Variable in class com.puppycrawl.tools.checkstyle.XMLLogger.FileMessages
The file error events.
errorWriter - Variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
Where to write error messages.
errorWriter - Variable in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
Where to write error messages.
escape(String) - Static method in class com.puppycrawl.tools.checkstyle.SarifLogger
Escape \b, \f, \n, \r, \t, \", \\ and U+0000 through U+001F.
escapeAllControlChars(String) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
Replace all control chars with escaped symbols.
escapeAllControlChars(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
Replace all control chars with escaped symbols.
ESCAPED_BACKSLASH - Static variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
Regular expression for escaped backslash.
ESCAPED_LINE_FEED_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
Pattern to detect occurrences of '\n' in text.
escapeUnicode1F(char) - Static method in class com.puppycrawl.tools.checkstyle.SarifLogger
Escape the character between 0x00 to 0x1F in JSON.
eventIdRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
The regexp which is used to match the event ID.
eventMessageRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
The regexp which is used to match the event message.
eventSourceRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
The regexp which is used to match the event source.
exactMatch - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportRule
Indicates if the package name must be an exact match.
EXAMPLES_TAG - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Regular expression for check example location in class-level javadocs.
exampleSectionStartIdx - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Child number of the example section node, where parent is the class level javadoc root node.
EXCEPTION - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
@exception.
EXCEPTION_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
'@exception' literal in @exception Javadoc tag.
EXCEPTION_MSG - Static variable in class com.puppycrawl.tools.checkstyle.Checker
Message to use when an exception occurs and should be printed as a violation.
ExceptionInfo(DetailAST, JavadocMethodCheck.ClassInfo) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
Creates new instance for FullIdent.
exceptions - Variable in class com.puppycrawl.tools.checkstyle.XMLLogger.FileMessages
The file exceptions.
exceptionVariableName - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
Specify the RegExp for the name of the variable associated with exception.
exclude - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Option that allows users to specify a list of paths to exclude.
excludeClassesRegexps - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Specify user-configured regular expressions to ignore classes.
excludedClasses - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Specify user-configured class names to ignore.
excludedClasses - Variable in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
Specify pattern for qualified names of classes which are allowed to have a main method.
excludedPackages - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
Specify user-configured packages to ignore.
excludeRegex - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Option that allows users to specify a regex of paths to exclude.
excludes - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
Specify packages where starred class imports are allowed and classes where starred static member imports are allowed.
excludes - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
Control whether to allow for certain classes via a star notation to be excluded such as java.lang.Math.* or specific static members to be excluded like java.lang.System.out for a variable or java.lang.Math.random for a method.
excludeScope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Specify the visibility scope where Javadoc comments are not checked.
excludeScope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Specify the visibility scope where Javadoc comments are not checked.
excludeScope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
Specify the visibility scope where Javadoc comments are not checked.
excludeScope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
Specify the visibility scope where Javadoc comments are not checked.
excludeScope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
Specify the visibility scope where Javadoc comments are not checked.
ExecutableStatementCountCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
Restricts the number of executable statements to a specified limit.
ExecutableStatementCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
Constructs a ExecutableStatementCountCheck.
ExecutableStatementCountCheck.Context - Class in com.puppycrawl.tools.checkstyle.checks.sizes
Class to encapsulate counting information about one member.
execute() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
 
execute(CommandLine.ParseResult, Main.CliOptions) - Static method in class com.puppycrawl.tools.checkstyle.Main
Validates the user input and returns -1 if invalid, otherwise executes CheckStyle and returns the number of violations.
EXECUTE - com.puppycrawl.tools.checkstyle.ConfigurationLoader.IgnoredModulesOptions
Execute ignored modules.
executeIgnoredModules - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Whether to execute ignored modules - some modules may log above their severity depending on their configuration (e.g.
executeIgnoredModules - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Switch whether to execute ignored modules or not.
EXIT_WITH_CHECKSTYLE_EXCEPTION_CODE - Static variable in class com.puppycrawl.tools.checkstyle.Main
Exit code returned when execution finishes with CheckstyleException.
EXIT_WITH_INVALID_USER_INPUT_CODE - Static variable in class com.puppycrawl.tools.checkstyle.Main
Exit code returned when user specified invalid command line arguments.
exitBlock() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
Leave an inner class, so restore variable set.
ExpandCollapseAction() - Constructor for class com.puppycrawl.tools.checkstyle.gui.MainFrame.ExpandCollapseAction
 
EXPANDED - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ElementStyleOption
Expanded example
expandedTabColumn(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Returns the column number with tabs expanded.
expandedTabsColumnNo(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Get the column number for the start of a given expression, expanding tabs out into spaces in the process.
expandedTabsColumnNo(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
Get the column number for the start of a given expression, expanding tabs out into spaces in the process.
expandedTabsColumnNo(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
Get the column number for the start of a given expression, expanding tabs out into spaces in the process.
expandSelectedNode() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
Do expansion of a tree node.
expandTreeTableByPath(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
Expands path in tree table to given node so that user can see the node.
EXPLICIT_MODS - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Contains explicit access modifiers.
ExplicitInitializationCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks if any class or object member is 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
 
EXPR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An expression.
expressionValue - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.Values
NP value for expression.
expressionValues - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
Stack of NP values for expressions.
extendedClassNameFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
Specify pattern for extended class names.
extendIllegalClassNamesWithShortName(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
Extends illegal class names set via imported short type name.
EXTENDS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
An extends clause.
extension - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
Common extension of files which are included in the resource bundle.
EXTERNAL_GENERAL_ENTITIES - Static variable in class com.puppycrawl.tools.checkstyle.XmlLoader.LoadExternalDtdFeatureProvider
Feature that enables including external general entities in XML files.
EXTERNAL_PARAMETER_ENTITIES - Static variable in class com.puppycrawl.tools.checkstyle.XmlLoader.LoadExternalDtdFeatureProvider
Feature that enables including external parameter entities in XML files.
EXTERNAL_RESOURCE_KEY_PREFIX - Static variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
The property prefix to use for storing the hashcode of an external resource.
ExternalResource(String, String) - Constructor for class com.puppycrawl.tools.checkstyle.PropertyCacheFile.ExternalResource
Creates an instance.
ExternalResourceHolder - Interface in com.puppycrawl.tools.checkstyle.api
The following interface should be implemented by each module (inheritor of AbstractCheck, implementor of FileSetCheck, or Filter) which uses external resources of any kind for its configuration.
extractBaseName(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Extracts the base name (the unique prefix) of resource bundle from translation file name.
extractBlockComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns the specified block comment as a String array.
extractBlockTags(String...) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.BlockTagUtil
Extract the block tags from a Javadoc comment.
extractFullIdent(FullIdent, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Recursively extract a FullIdent.
extractInlineTagContent(DetailNode, StringBuilder) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
Extracts the content of inline custom tag recursively.
extractInlineTags(String...) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
Extract inline Javadoc tags from the given comment.
extractParamNameFromTag(JavadocTag) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
Extracts parameter name from tag.
extractQualifiedName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Get name of package and super class of anon inner class by concatenating the identifier values under TokenTypes.DOT.
extractQualifiedTypeName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
Extract the qualified type declaration name from given type declaration Ast.

F

failOnViolation - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Whether to fail build on violations.
failureProperty - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Property to set on violations.
FallThroughCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks for fall-through in switch statements.
FallThroughCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
 
FIELD_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Field name.
FIELD_TYPE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Field type.
FieldFrame(EqualsAvoidNullCheck.FieldFrame) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Creates new frame.
FieldFrame(HiddenFieldCheck.FieldFrame, boolean, String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
Creates new frame.
fieldNameToAst - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Map of field name to field DetailAst.
file - Variable in class com.puppycrawl.tools.checkstyle.api.FileText
The name of the file.
file - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
Specify the location of the file containing the import control configuration.
file - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
Specify the location of the suppressions XML document file.
file - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
Specify the location of the suppressions XML document file.
FILE - com.puppycrawl.tools.checkstyle.PropertyType
This property is a file.
FILE_ELEMENT_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
Qualified name for element 'file'.
FILE_EXTENSION_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
Pattern matching any file extension with dot included.
FILE_MAX_NCSS - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
Default constant for max file ncss.
FILE_NAME_WITH_LANGUAGE_CODE_FORMATTER - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
File name format with language code.
FILE_SEPARATOR_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
Regular expression for file separator corresponding to the host OS.
fileContents - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractCheck.FileContext
The current file contents.
fileContents - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck.FileContext
The current file contents.
fileContents - Variable in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
The file contents.
FileContents - Class in com.puppycrawl.tools.checkstyle.api
Represents the contents of a file.
FileContents(FileText) - Constructor for class com.puppycrawl.tools.checkstyle.api.FileContents
Creates a new FileContents instance.
fileContentsReference - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
References the current FileContents for this filter.
fileContentsReference - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
References the current FileContents for this filter.
FileContext() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractCheck.FileContext
 
FileContext() - Constructor for class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck.FileContext
 
FileContext() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck.FileContext
 
fileExtensions - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Specify the file type extension of files to process.
fileExtensions - Variable in class com.puppycrawl.tools.checkstyle.Checker
The file extensions that are accepted.
FILEFILTER - com.puppycrawl.tools.checkstyle.meta.ModuleType
Module is a Checkstyle file filter.
fileFinished(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that audit is finished on a specific file.
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
 
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
 
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.SarifLogger
 
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
fileFinished(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
 
FileImportControl - Class in com.puppycrawl.tools.checkstyle.checks.imports
Represents an import rules for a specific file.
FileImportControl(PkgImportControl, String, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
Construct a file node.
FileLengthCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
Checks for long source files.
FileLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
 
fileMaximum - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
Specify the maximum allowed number of non commenting lines in a file including all top level and nested classes.
fileMessages - Variable in class com.puppycrawl.tools.checkstyle.XMLLogger
Holds all messages for the given file.
FileMessages() - Constructor for class com.puppycrawl.tools.checkstyle.XMLLogger.FileMessages
 
fileName - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Name of file to check.
fileName - Variable in class com.puppycrawl.tools.checkstyle.api.AuditEvent
Filename event associated with.
fileName - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
The file name doing the import.
fileName - Variable in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
Current file name.
fileName - Variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
File name of cache.
fileName - Variable in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
Filename event associated with.
fileNamePattern - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
Specify the regular expression to match the file name against.
fileNamePattern - Variable in class com.puppycrawl.tools.checkstyle.filefilters.BeforeExecutionExclusionFileFilter
Define regular expression to match the file name against.
FILEPATH_CONVERSION - Static variable in class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
Compiled pattern for . used for generating file paths from package names.
filePattern - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
The pattern for file names.
filePattern - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
The pattern for file names.
fileRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
The regexp to match file names against.
fileRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
The regexp to match file names against.
files - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
Set of files which are included in the resource bundle.
files - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
Define the RegExp for matching against the file name associated with an audit event.
files - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
Define a Regular Expression matched against the file name associated with an audit event.
files - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
List of file to validate.
FileSelectionAction() - Constructor for class com.puppycrawl.tools.checkstyle.gui.MainFrame.FileSelectionAction
 
FileSetCheck - Interface in com.puppycrawl.tools.checkstyle.api
Interface for Checking a set of files for some criteria.
fileSetChecks - Variable in class com.puppycrawl.tools.checkstyle.Checker
Vector of fileset checks.
fileSets - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Contains the filesets to process.
fileStarted(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.api.AuditListener
Notify that audit is about to start on a specific file.
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
 
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
 
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.SarifLogger
 
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
fileStarted(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
 
FileStatefulCheck - Annotation Type in com.puppycrawl.tools.checkstyle
This annotation means that the check contains file-related context and therefore cannot be used from the others threads at the same time.
filesToProcess - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
The files to process.
FileTabCharacterCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
Checks that there are no tab characters ('\t') in the source code.
FileTabCharacterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck
 
fileText - Variable in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
The FileText object, representing content of the file.
FileText - Class in com.puppycrawl.tools.checkstyle.api
Represents the text contents of a file of arbitrary plain text type.
FileText(FileText) - Constructor for class com.puppycrawl.tools.checkstyle.api.FileText
Copy constructor.
FileText(File, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.FileText
Creates a new file text representation.
FileText(File, List<String>) - Constructor for class com.puppycrawl.tools.checkstyle.api.FileText
Compatibility constructor.
fillCacheWithExternalResources(Set<PropertyCacheFile.ExternalResource>) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Fills cache with a set of PropertyCacheFile.ExternalResource.
fillChecksFromAnnotationPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from annotation package.
fillChecksFromBlocksPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from blocks package.
fillChecksFromCodingPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from coding package.
fillChecksFromDesignPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from design package.
fillChecksFromHeaderPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from header package.
fillChecksFromImportsPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from imports package.
fillChecksFromIndentationPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from indentation package.
fillChecksFromJavadocPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from javadoc package.
fillChecksFromMetricsPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from metrics package.
fillChecksFromModifierPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from modifier package.
fillChecksFromNamingPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from naming package.
fillChecksFromRegexpPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from regexp package.
fillChecksFromSizesPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from sizes package.
fillChecksFromWhitespacePackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with Checks from whitespace package.
fillModulesFromChecksPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with modules from checks package.
fillModulesFromCheckstylePackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with modules from checkstyle package.
fillModulesFromFilefiltersPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with modules from filefilters package.
fillModulesFromFiltersPackage() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map with modules from filters package.
fillShortToFullModuleNamesMap() - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Fill short-to-full module names map.
fillTemplateWithStringsByRegexp(String, String, Pattern) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Puts part of line, which matches regexp into given template on positions $n where 'n' is number of matched part in line.
filter - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
SuppressFilterElement instance.
Filter - Interface in com.puppycrawl.tools.checkstyle.api
An interface for filtering AuditEvents.
FILTER - com.puppycrawl.tools.checkstyle.meta.ModuleType
Module is a Checkstyle filter.
filterChain - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
The filter chain to return in getAFilterChain(), configured during parsing.
filters - Variable in class com.puppycrawl.tools.checkstyle.api.FilterSet
Filter set.
filters - Variable in class com.puppycrawl.tools.checkstyle.Checker
The audit event filters.
filters - Variable in class com.puppycrawl.tools.checkstyle.filters.CsvFilterElement
Filter set.
filters - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
Set of individual suppresses.
filters - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
Set of individual xpath suppresses.
filters - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
The ast filters.
FilterSet - Class in com.puppycrawl.tools.checkstyle.api
A filter set applies filters to AuditEvents.
FilterSet() - Constructor for class com.puppycrawl.tools.checkstyle.api.FilterSet
 
FilterUtil - Class in com.puppycrawl.tools.checkstyle.utils
Utility methods for suppression filters.
FilterUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.FilterUtil
Stop instances being created.
FINAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The final keyword.
FINAL_KEYWORD - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Name for 'final' keyword.
FINAL_KEYWORD - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
Name for 'final' keyword.
FinalClassCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
Checks that a class that has only private constructors and has no descendant classes is declared as final.
FinalClassCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
 
FinalClassCheck.ClassDesc - Class in com.puppycrawl.tools.checkstyle.checks.design
Maintains information about the class.
FinalClassCheck.TypeDeclarationDescription - Class in com.puppycrawl.tools.checkstyle.checks.design
Maintains information about the type of declaration.
FinalLocalVariableCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
Checks that local variables that never have their values changed are declared final.
FinalLocalVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
 
FinalLocalVariableCheck.FinalVariableCandidate - Class in com.puppycrawl.tools.checkstyle.checks.coding
Represents information about final local variable candidate.
FinalLocalVariableCheck.ScopeData - Class in com.puppycrawl.tools.checkstyle.checks.coding
Holder for the scope data.
FinallyHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for finally blocks.
FinallyHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
FinalParametersCheck - Class in com.puppycrawl.tools.checkstyle.checks
Checks that parameters for methods, constructors, catch and for-each blocks are final.
FinalParametersCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
 
FinalVariableCandidate(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.FinalVariableCandidate
Creates new instance.
findAllExpressionsInChildren(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Method looks at children and returns list of expressions in strings.
findBetterPatternMatch(String, String, Pattern, CustomImportOrderCheck.RuleMatchForImport) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Tries to find better matching regular expression: longer matching substring wins; in case of the same length, lower position of matching substring wins.
findBundle(Set<TranslationCheck.ResourceBundle>, TranslationCheck.ResourceBundle) - Static method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
Searches for specific resource bundle in a set of resource bundles.
findChar(String[], char, TagParser.Point) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
Finds next occurrence of given character.
findChildrenOfExpressionType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
Find all child of given AST of type TokenType.EXPR
findChildWithTextAttribute(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Returns child DetailAst element of the given root, which has text attribute.
findChildWithTextAttributeRecursively(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Returns child DetailAst element of the given root, which has text attribute.
findClassFrame(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Find the class frame containing declaration.
findColumnNo(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Finds column number in the first non-comment node.
findCommentUnder(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
Finds comment in next sibling of given packageDef.
findContainingConstantDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
Finds the constant definition that contains aAST.
findCorrespondingXpathQuery(AuditEvent) - Static method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
Returns xpath query corresponding to violation of the TreeWalkerAuditEvent object which points to the same AST element as specified AuditEvent object.
findField(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Determines whether this FieldFrame contains the field.
findFinalVariableCandidateForAst(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.ScopeData
Searches for final local variable candidate for ast in the scope.
findFirstAnnotation(DetailAST, Predicate<DetailAST>) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Checks if the given AST is annotated with at least one annotation that matches the given predicate and returns the AST representing the first matching annotation.
findFirstToken(int) - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the first child token that makes a specified type.
findFirstToken(int) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
 
findFirstToken(DetailNode, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
Returns the first child token that has a specified type.
findFirstTokenByPredicate(DetailAST, Predicate<DetailAST>) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
Finds the first Optional child token of DetailAST root node which matches the given predicate.
findFirstUpperNamedBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
Find the Class, Constructor, Enum, Method, or Field in which it is defined.
findFrame(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Find frame containing declaration.
findFrame(RequireThisCheck.AbstractFrame, DetailAST, boolean) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Find frame containing declaration.
findIndexOfFirstNonBlankLine(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
Returns the index of the first non-blank line.
findLastAnnotation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
Find the last token of type TokenTypes.ANNOTATION under the given set of modifiers.
findLastChildWhichContainsSpecifiedToken(DetailAST, int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
Returns the last child token that makes a specified type and contains containType in its branch.
findLastPosition(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
Finds the last position of node without children.
findLastPosition(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
Finds the last position of node without children.
findLeftCurly(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
Calculates the left curly corresponding to the block to be checked.
findLineBreaks() - Method in class com.puppycrawl.tools.checkstyle.api.FileText
Find positions of line breaks in the full text.
findLineNo(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Finds line number in the first non-comment node.
findMatch() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
Method that finds the matches.
findMatch() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Recursive method that finds the matches.
findMatchingAnnotation(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Checks whether the AST is annotated with an annotation containing the passed in regular expression and return the AST representing that annotation.
findMatchingNodesByXpathQuery(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
Find nodes that match query.
findNearestMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
Finds the nearest comment text tag that matches an audit event.
findNextSibling(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
Return token type only if passed tokenType in argument is found or returns -1.
FindNodeByXpathAction() - Constructor for class com.puppycrawl.tools.checkstyle.gui.MainFrame.FindNodeByXpathAction
 
findPositionAmongSiblings(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Finds position of the ast element among siblings.
findPreviousStatement(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
Finds a previous statement of the comment.
findScopeOfVariable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Find the scope of variable.
findSelectionPositions() - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
Find start and end selection positions from AST line and Column.
findSelectionPositions(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
Find start and end selection positions from AST line and Column.
findSelectionPositions(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
Find start and end selection positions from DetailNode line and Column.
findStartTokenOfMethodCallChain(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
Finds the start token of method call chain.
findSubtreeAst(DetailAstSet, DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
Find the set of abstract syntax tree for a given subtree.
findTextStart(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Finds the index of the first non-whitespace character ignoring the Javadoc comment start and end strings (/** and */) as well as any leading asterisk.
findTokensInAstByType(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
Finds node of specified type among root children, siblings, siblings children on any deep level.
findTokenWhichBeginsTheLine(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
Finds a token which begins the line.
findWarningsHolder(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
Find the parent (holder) of the of the warnings (Expr).
finish() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
Filters out all references to locally defined types.
finish() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
Perform processing at the end of a set of lines.
finish() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
Perform processing at the end of a set of lines.
finishImportList() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Examine the order of all the imports and log any violations.
finishJavadocTree(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
Called after finished processing a tree.
finishJavadocTree(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.Checker
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.DefaultLogger
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filefilters.BeforeExecutionExclusionFileFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWarningsFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.SarifLogger
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
 
finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
 
finishProcessing() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
 
finishProcessing() - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
Called when all the files have been processed.
finishProcessing() - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
Called after finished processing a tree.
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
 
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.MultipleStringLiteralsCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
 
finishTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
 
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.
fireEditingCanceled() - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
Notifies all listeners that have registered interest in 'editing canceled' event.
fireEditingStopped() - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
Notifies all listeners that have registered interest in 'editing stopped' event.
fireErrors(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
Notify all listeners about the errors in a file.
fireErrors(String, SortedSet<Violation>) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the violations in a file.
fireErrors(String, SortedSet<Violation>) - Method in class com.puppycrawl.tools.checkstyle.Checker
Notify all listeners about the errors in a file.
fireFileFinished(String) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the end of a file audit.
fireFileFinished(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
Notify all listeners about the end of a file audit.
fireFileStarted(String) - Method in interface com.puppycrawl.tools.checkstyle.api.MessageDispatcher
Notify all listeners about the beginning of a file audit.
fireFileStarted(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
Notify all listeners about the beginning of a file audit.
fireTreeStructureChanged(Object, Object[], int[], Object...) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
Notify all listeners that have registered interest in 'tree structure changed' event.
FIRST_CLASS_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
Regex to match the first class name.
FIRST_LINE - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption
Represents a policy for the location of content starting from the same line as /**.
firstArg - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
An optional first argument.
firstChild - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
First child of this DetailAST.
firstColumn - Variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
The suppression region for the check - first column.
firstLine - Variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
The suppression region for the check - first line.
firstLine - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
The first line where warnings may be suppressed.
firstLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
The first line in set of ast.
firstNonTightHtmlTag - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
Stores the first non-tight HTML tag encountered while parsing javadoc.
flattenedTree(ParserRuleContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
Builds the AST for a particular node, then returns a "flattened" tree of siblings.
folderPattern - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
Specify the regular expression to match the folder path against.
FollowingIterator - Class in com.puppycrawl.tools.checkstyle.xpath.iterators
Recursive-free implementation of the following axis iterator.
FollowingIterator(NodeInfo) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.iterators.FollowingIterator
Create an iterator over the "following" axis.
FOR_CONDITION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A for loop condition.
FOR_EACH_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A for-each clause.
FOR_FRAME - com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
For frame type.
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.
forbiddenSummaryFragments - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
Specify the regexp for forbidden summary fragments.
forceStrictCondition - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Force strict indent level in line wrapping case.
forEachChild(DetailAST, int, Consumer<DetailAST>) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
Performs an action for each child of DetailAST root node which matches the given token type.
ForFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ForFrame
Creates for frame.
ForHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
Handler for for loops.
ForHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - 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.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
Specify the RegExp to match against warnings.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
Define the RegExp for illegal pattern.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
Specify method names to ignore.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
Specify pattern for exception class names.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
Specify valid identifiers.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
The regexp to match against.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
Specifies valid identifiers.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
Format of the regular expression to check for.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
Specify the pattern to match against.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
Specify the format of the regular expression to match.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
Specify the format of the regular expression to match.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
Specify the format of the regular expression to match.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
Specify pattern to match comments against.
format - Variable in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
Specify pattern for strings allowed before the comment.
format - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Output format.
format(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
 
format(AuditEvent) - Method in interface com.puppycrawl.tools.checkstyle.AuditEventFormatter
Formats an event message.
format(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
Specifies the format to use when matching lines and returns Builder object.
FORMAT_LINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
Specify pattern for strings to be formatted without comment specifiers.
formatHtmlElement(StringBuilder, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
Concatenates the HTML text from AST of a JavadocTokenTypes.HTML_ELEMENT.
formatInlineCodeTag(StringBuilder, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
Converts inline code tag into HTML form.
formatString - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
The format string of the regexp.
formatter - Variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
Formatter for the log message.
formatter - Variable in class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
Formatter for the log message.
Formatter() - Constructor for class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
 
formatters - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
Contains the formatters to log to.
FormatterType() - Constructor for class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.FormatterType
 
forStatementEnd - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
Hold the line-number where the last 'for-loop' statement ended.
found - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
Does the exception have throws tag associated with.
FQ_DEPRECATED - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
Fully-qualified Deprecated annotation name.
FQ_OVERRIDE - Static variable in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Fully-qualified Override annotation name.
FQ_SUPPRESS_WARNINGS - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
Fully-qualified SuppressWarnings annotation name.
frame - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
Stack of sets of field names, one for each class of a set of nested classes.
Frame(UnusedImportsCheck.Frame) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
Private constructor.
FRAME_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Frame tag name.
FRAME_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
Frame html tag.
frameName - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Name of the class, enum or enum constant declaration.
frameName - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
Name of the frame, such name of the class or enum declaration.
frameName - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AnonymousClassFrame
The name of the frame.
frameNameIdent - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
Name identifier token.
frames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Tree of all the parsed frames.
FrameType() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
 
fromName(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
Returns a JavadocTag from the tag name.
fromText(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
Returns a JavadocTag from the tag text.
FullIdent - Class in com.puppycrawl.tools.checkstyle.api
Represents a full identifier, including dots, with associated position information.
FullIdent() - Constructor for class com.puppycrawl.tools.checkstyle.api.FullIdent
Hide default constructor.
fullPackageName - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
The full name for the package.
fullQualifiedName - Variable in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
Fully qualified name of the module.
fullText - Variable in class com.puppycrawl.tools.checkstyle.api.FileText
The full text contents of the file.

G

GE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
The >= (greater than or equal) operator.
generate() - Method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Returns list of xpath queries of nodes, matching line number, column number and token type.
generate(FileText, DetailAST, int, int, int) - Static method in class com.puppycrawl.tools.checkstyle.SuppressionsStringPrinter
Creates XpathQueryGenerator instance and generates suppressions.
generate(String, OutputStream, String...) - Static method in class com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtil
Generate metadata from the module source files available in the input argument path.
generateId(StringBuilder) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Generate id method.
generateThirdPartyNameToFullModuleName(ClassLoader) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
Generate the map of third party Checkstyle module names to the set of their fully qualified names.
generateXpath() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
Generate Xpath.
generateXpathQuery(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
Returns full xpath query for given ast element.
generateXpathSuppressionsFile - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
Switch whether to generate suppressions file or not.
GENERIC_END - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A > symbol signifying the end of type arguments or type parameters.
GENERIC_START - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
A < symbol signifying the start of type arguments or type parameters.
GenericWhitespaceCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
Checks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention.
GenericWhitespaceCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
 
get(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileText
Retrieves a line of the text by its number.
get(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Context
Searches for the value with the specified attribute key in this context.
get(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
 
get(String) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
Retrieves the hash of a specific file.
getAbbreviation(String, int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
Gets the abbreviation, where beginIndex and endIndex are inclusive indexes of a sequence of consecutive upper-case characters.
getAbbreviationIfIllegal(String, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
Get Abbreviation if it is illegal, where beginIndex and endIndex are inclusive indexes of a sequence of consecutive upper-case characters.
getAcceptableJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
The configurable javadoc token set.
getAcceptableJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
 
getAcceptableJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
The configurable token set.
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidNoArgumentSuperConstructorCallCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
 
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.IllegalCatchCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
 
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.IllegalTypeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoArrayTrailingCommaCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoEnumTrailingCommaCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterOuterTypeDeclarationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.IllegalIdentifierNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.InterfaceTypeParameterNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LambdaParameterNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodTypeParameterNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PatternVariableNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordComponentNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordTypeParameterNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
 
getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
 
getAccessModifierFromModifiersToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Returns the access modifier of the method/constructor at the specified AST.
getAccessModifierFromModifiersTokenDirectly(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
Returns AccessModifierOption based on the information about access modifier taken from the given token of type TokenTypes.MODIFIERS.
getAlias(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Returns the alias for the source name of a check.
getAllAnnotationValues(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Get all annotation values.
getAllMatchingXpathQueriesText(Deque<DetailAST>) - Static method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
Generates a String with all matching XPath queries separated by newlines.
getAllNamespaces() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Returns namespace array.
getAllNewlineNodes(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
Finds and collects all NEWLINE nodes inside DESCRIPTION node.
getAllTokenIds() - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
Get all token IDs that are available in TokenTypes.
getAllTokensOfType(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
Collects all tokens of specific type starting with the current ast node.
getAllTokensOfType(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Collects all tokens of specific type starting with the current ast node.
getAllTokensOfType(DetailAST, int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Collects all tokens of specific type starting with the current ast node and which line number is lower or equal to the end line number.
getAllTokensWhichAreEqualToCurrent(DetailAST, DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Collects all tokens which are equal to current token starting with the current ast node and which line number is lower or equal to the end line number.
getAnnotation(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Checks if the AST is annotated with the passed in annotation and returns the AST representing that annotation.
getAnnotationHolder(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
Gets the AST that holds a series of annotations for the potentially annotated AST.
getAnnotationName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
Returns the name of the given annotation.
getAnnotationName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
Returns the name of the given annotation.
getAnnotationName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
Gets the name of the annotation.
getAnnotationName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
Gets name of an annotation.
getAnnotationTarget(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Get target of annotation.
getAnnotationValues(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Returns the annotation values represented by an AST.
getAnonSuperTypeMatchingCount(String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
Calculates and returns the type declaration matching count when classToBeMatched is considered to be super class of an anonymous inner class.
getArrayDeclaratorPreviousElement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
Returns proper argument for getPositionAfter method, it is a token after ARRAY_DECLARATOR, in can be RBRACK, IDENT or an array type definition (literal).
getArrayInitIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Getter to query how far an array initialisation should be indented when on next line.
getArrayInitIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
A shortcut for IndentationCheck property.
getAst() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
Gets the AST node representing this exception.
getAst(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
Get the ast corresponding to line number.
getAST() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.Context
Gets the member AST node.
getAttribute(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
Deprecated.
This shall be removed in future releases. Please use getProperty(String name) instead.
getAttribute(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
 
getAttributeNames() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
Deprecated.
This shall be removed in future releases. Please use getPropertyNames() instead.
getAttributeNames() - Method in interface com.puppycrawl.tools.checkstyle.api.Context
Returns the names of all attributes of this context.
getAttributeNames() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
 
getAttributeNames() - Method in class com.puppycrawl.tools.checkstyle.DefaultContext
 
getAttributeNode() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Checks if token type supports @text attribute, extracts its value, creates AttributeNode object and returns it.
getAttributeValue(String, String) - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
Returns attribute value.
getAttributeValue(String, String) - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Returns attribute value.
getAttributeValue(String, String) - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
Returns attribute value.
getAttributeValue(Element, String) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
Utility to get attribute value of an element.
getBaseName() - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
Returns the bundle base name.
getBaseURI() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Returns base uri.
getBasicOffset() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
A shortcut for IndentationCheck property.
getBasicOffset() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Getter to query how far new indentation level should be indented when on the next line.
getBeforeExecutionFileFilters() - Method in class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
Returns the Filters of the filter set.
getBlockCommentAst() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
Getter for block comment in Java language syntax tree.
getBlockCommentContent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
Gets content of block comment.
getBlockComments() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
Returns a map of all block comments.
getBlockContainingLocalAnonInnerClass(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
Get the block containing local anon inner class.
getBlockEndToken(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Returns the token which ends the code block.
getBraceAdjustment() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
A shortcut for IndentationCheck property.
getBraceAdjustment() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Getter to query how far a braces should be indented when on the next line.
getBraceAsFirstChild(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
Gets a SLIST if it is the first child of the AST.
getBraceFromSwitchMember(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
Gets the brace of a switch statement/ expression member.
getBranchTokenTypes() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
Returns token type with branch.
getBundle(String) - Method in class com.puppycrawl.tools.checkstyle.api.Violation
Find a ResourceBundle for a given bundle name.
getBundle(String) - Static method in class com.puppycrawl.tools.checkstyle.DefaultLogger.LocalizedMessage
Find a ResourceBundle for a given bundle name.
getCallLastNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
Returns method or constructor call right paren.
getCanonicalName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Gets canonical type's name from given TYPE node.
getCaseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
Getter to query how far a case label should be indented when on next line.
getCellEditorValue() - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
 
getCharset() - Method in class com.puppycrawl.tools.checkstyle.api.FileText
Get the character set which was used to read the file.
getCheckedChildren() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Returns array of token types which should be checked among children.
getCheckedChildren() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
 
getCheckerThreadsNumber() - Method in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
Gets the number of threads for the Checker module.
getCheckName() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
Gets the source name of the suppressed check.
getCheckShortName(AuditEvent) - Static method in class com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
Returns check name without 'Check' suffix.
getCheckstyleModules(Collection<String>, ClassLoader) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
Gets checkstyle's modules (directly, not recursively) in the given packages.
getCheckstyleResource(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Finds a resource with a given name in the Checkstyle resource bundle.
getChild(Object, int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
 
getChild(Object, int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Returns the child of parent at index.
getChildAtDetailAst(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Gets child of DetailAST node at specified index.
getChildCount() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the number of child nodes one level below this node.
getChildCount() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
 
getChildCount(int) - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
Returns the number of direct child tokens that have the specified type.
getChildCount(int) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
 
getChildCount(Object) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
 
getChildCount(Object) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Returns the number of children of parent.
getChildren() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
The set of child configurations.
getChildren() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailNode
Array of children.
getChildren() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
Getter for frame's children.
getChildren() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
 
getChildren() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
 
getChildren() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Getter method for children.
getChildren(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
Gets all the children which are one level below on the current DetailAST parent node.
getChildrenExpectedIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
 
getChildrenExpectedIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
 
getChildrenExpectedIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
Gets indentation level expected for children.
getClassBody(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
Finds the class body of the first class in the DetailAST.
getClassFrameWhereViolationIsFound(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Returns the class frame where violation is found (where the field is used without 'this') or null otherwise.
getClassNameWithPackage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
Retrieves class name with packages.
getClassShortName(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Gets the short class name from given canonical name.
getClassShortNames(Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
Converts canonical class names to short names.
getCodeBlockDefinitionToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
Returns code block definition token for current identifier.
getCol() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
Getter for col field.
getColumn() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
Gets the column associated with the violation.
getColumn() - Method in class com.puppycrawl.tools.checkstyle.api.LineColumn
Gets the zero-based column number.
getColumn() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
Determines the column number of the tag in the source file.
getColumn() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
Gets the column associated with the violation.
getColumn(ParseTree) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Gets column number from ParseTree node.
getColumnCharIndex() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
Gets the column char index.
getColumnCharIndex() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
Gets the column char index associated with the violation.
getColumnClass(int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
Returns type of specified column number.
getColumnClass(int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Returns type of specified column number.
getColumnClass(int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
 
getColumnCount() - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
Returns number of available column.
getColumnCount() - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Returns number of available columns.
getColumnCount() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
 
getColumnName(int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
Returns column name of specified column number.
getColumnName(int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
Returns name for specified column number.
getColumnName(int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
 
getColumnNo() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
Gets column number.
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
Gets the column number.
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
Gets the column number.
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
Gets column number.
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser.Point
Getter for column number.
getColumnNo() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
 
getColumnNumber() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailNode
Node column number.
getColumnNumber() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
 
getColumnNumber() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
Returns column number.
getColumnNumber() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
Returns column number.
getColumnNumber() - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
Returns column number.
getCommentFirstLine(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
Gets the first line of comment in catch block.
getCommentText(String...) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
Returns the comment text from the Javadoc.
getCondLeft(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
Retrieves the left side of a conditional.
getCondRight(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
Retrieves the right side of a conditional.
getConfiguration() - Method in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
Returns the configuration that was used to configure this component.
getConfiguration() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Returns configuration.
getConstructor(Class<T>, Class<?>...) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
Gets constructor of targetClass.
getContentOfInlineCustomTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
Gets the content of inline custom tag.
getContentWithoutPrecedingWhitespace(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Remove preceding newline and whitespace from the content of a text block.
getCount() - Method in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
Returns the number of counted events since audit started.
getCount() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.Counter
Gets the counters value.
getCount() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.Context
Gets the count.
getCountOfEmptyLinesBetween(int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
Counts empty lines between given parameters.
getCurrentFile() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
Get current file.
getCurrentVariables() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
Get current variable stack.
getCustomMessages() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
Returns an unmodifiable map instance containing the custom messages for this configuration.
getCustomViolation() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
Returns the formatted custom violation if one is configured.
getDeclaredNamespaces(NamespaceBinding[]) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
Returns namespace array.
getDeclaredScopeFromMods(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
Returns the Scope explicitly specified by the modifier set.
getDefaultAlias(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
Returns the default alias for the source name of a check, which is the source name in lower case with any dotted prefix or "Check" suffix removed.
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
Returns the default javadoc token types a check is interested in.
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
Returns only javadoc tags so visitJavadocToken only receives javadoc tags.
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
 
getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
 
getDefaultScope(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
Returns the default Scope for a DetailAST.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
Returns the default token a check is interested in.
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
 
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.EmptyCatchBlockCheck
 
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