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
All Classes All Packages
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. - AbstractAutomaticBean - Class in com.puppycrawl.tools.checkstyle
-
A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.
- AbstractAutomaticBean() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
- AbstractAutomaticBean.OutputStreamOptions - Enum in com.puppycrawl.tools.checkstyle
-
Enum to specify behaviour regarding ignored modules.
- AbstractAutomaticBean.PatternArrayConverter - Class in com.puppycrawl.tools.checkstyle
-
A converter that converts a comma-separated string into an array of patterns.
- AbstractAutomaticBean.PatternConverter - Class in com.puppycrawl.tools.checkstyle
-
A converter that converts a string to a pattern.
- AbstractAutomaticBean.RelaxedAccessModifierArrayConverter - Class in com.puppycrawl.tools.checkstyle
-
A converter that converts strings to
AccessModifierOption
. - AbstractAutomaticBean.RelaxedStringArrayConverter - Class in com.puppycrawl.tools.checkstyle
-
A converter that does not care whether the array elements contain String characters like '*' or '_'.
- AbstractAutomaticBean.ScopeConverter - Class in com.puppycrawl.tools.checkstyle
-
A converter that converts strings to scope.
- AbstractAutomaticBean.SeverityLevelConverter - Class in com.puppycrawl.tools.checkstyle
-
A converter that converts strings to severity level.
- AbstractAutomaticBean.UriConverter - Class in com.puppycrawl.tools.checkstyle
-
A converter that converts strings to uri.
- 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
- AbstractElementNode - Class in com.puppycrawl.tools.checkstyle.xpath
-
Represents element node of Xpath-tree.
- AbstractElementNode(AbstractNode, AbstractNode, int, int) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Creates a new
AbstractElementNode
instance. - 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
andAttributeNode
. - 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
- AbstractRootNode - Class in com.puppycrawl.tools.checkstyle.xpath
-
Represents root node of Xpath-tree.
- AbstractRootNode() - Constructor for class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Creates a new
AbstractRootNode
instance. - 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.SuppressWithNearbyTextFilter
- 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
-
Control whether to allow a method name to have the same name as the enclosing 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 skipping validation at all.
- 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.
- allowEmptySwitchBlockStatements - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Allow empty switch blocks and block statements.
- 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.
- allowUnnamedVariables - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Allow variables named with a single underscore (known as unnamed variables in Java 21+).
- allowWhenNoBraceAfterSemicolon - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
-
Allow unnecessary semicolon if closing parenthesis 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
-
Set of tokens of type
UnusedLocalVariableCheck.ANONYMOUS_CLASS_PARENT_TOKENS
andTokenTypes.LAMBDA
in some cases. - 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
- ANONYMOUS_CLASS_PARENT_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
An array of blocks in which local anon inner classes can exist.
- 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(Collection<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. e.g:
- 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.:
- args - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
Arguments for MessageFormat.
- args - Variable in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Arguments for java.text.MessageFormat, that is why type is Object[].
- ARGUMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Argument definition in
JavadocTokenTypes.PARAMETERS
part ofJavadocTokenTypes.REFERENCE
. - 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 initialization 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. - assertAllPropertySetterJavadocsAreFound(Set<String>, String, Map<String, DetailNode>) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Assert that each property has a corresponding setter javadoc that is not null.
- 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
-
Checks the order of javadoc block-tags or javadoc tags.
- 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.AbstractElementNode
-
Holder value for lazy creation of attribute node.
- attributeNode - Variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
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
-
Deprecated.since 10.9.3. Use
AbstractAutomaticBean
instead. - AutomaticBean() - Constructor for class com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
Deprecated.
- AutomaticBean.OutputStreamOptions - Enum in com.puppycrawl.tools.checkstyle.api
-
Deprecated.Enum to specify behaviour regarding ignored modules.
- 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.checks.javadoc.JavadocLeadingAsteriskAlignCheck
- 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.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.UnusedCatchParameterShouldBeUnnamedCheck
- beginTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
- 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.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
- BITWISE_BINARY_OPERATORS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Token types for bitwise binary operator.
- 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.
- BLOCK_TAGS - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Set of block tags supported by this check.
- 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() - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
Place the XML declaration at the top of the file.
- BODY - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Body html tag.
- body_() - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
Place a newline at the end of the file, flush the writer, and reset the sink.
- 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 (
&&
,||
,&
,|
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
- buildExpressionNode(ParseTree) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
Builds an expression node.
- bundle - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
Name of the resource bundle to get violations from.
- bundle - Variable in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Name of the resource bundle to get messages from.
- 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
- cachedFileAbsolutePath - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
The absolute path to the currently processed file.
- cacheFile - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
Cache file.
- 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(MatchResult, 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) - Static 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.
- canReferenceImports() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Checks that the tag can contain references to imported classes.
- canReturnOrYieldOnlyBooleanLiteral(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
-
Returns if an AST is a return or a yield statement with a boolean literal or a compound statement that contains only such a return or a yield 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.
- CASE_LABEL_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Tokens that are considered as case labels.
- 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.
- CatchParameterDetails(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
Create a new catch parameter instance.
- 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. - catchParameters - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
-
Keeps track of the catch parameters in a block.
- 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.
- CHARSET - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'charset'.
- 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_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
The precompiled pattern for a Check.
- CHECK_PROPERTIES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Set of properties that every check has.
- 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. 2) Checks whether the annotations have the valid indentation level.
- checkBaseTypes(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks the
extends
orimplements
statement. - checkBitwiseBinaryOperator(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Check if bitwise binary operator has unnecessary parentheses.
- 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 (
/* ... */
). - checkC - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Control whether to check C style comments (
/* ... */
). - 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, Collection<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.
- checkConditionalOrRelationalOperator(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Check if conditional or relational operator has unnecessary parentheses.
- 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, Set<String>) - 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, Matcher) - 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, Set<String>) - 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 onlyString...
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.SuppressWithNearbyTextFilter
-
Specify check name pattern to suppress.
- 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.
- CHECKS - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'checks'.
- checkSingleLineComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
-
Checks if single-line comment is legal.
- checkSlist(DetailAST, boolean, boolean, Set<String>) - 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_ORG_URL - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The url of the checkstyle website.
- 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, Set<String>) - 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, Set<String>) - 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, Iterable<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, Set<String>) - 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, Collection<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.
- checkUnnamedVariables(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Check if the variable is unnamed and has redundant final modifier.
- 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
andlastNode
. - 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
andlastNode
. - 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 exceedsMAX_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.
- CLASS_TO_PARENT_MODULE - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Class name and their corresponding parent module name.
- ClassAndPropertiesSettersJavadocScraper - Class in com.puppycrawl.tools.checkstyle.site
-
Class for scraping class javadoc and all property setter javadocs from the given checkstyle module.
- ClassAndPropertiesSettersJavadocScraper() - Constructor for class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
- 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 distinct classes that are instantiated 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_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() - 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.AbstractAutomaticBean.OutputStreamOptions
-
Close stream in the end.
- CLOSE - com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
-
Deprecated.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_END - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Reflects end of a code segment.
- CODE_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@code' literal in {@code} Javadoc inline tag.
- CODE_SNIPPET_END - Static variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Ending delimiter for code snippets.
- CODE_SNIPPET_START - Static variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Starting delimiter for code snippets.
- CODE_START - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Reflects start of a code segment.
- 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, Collection<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.
- collectMethodDeclarations(Deque<RequireThisCheck.AbstractFrame>, DetailAST, RequireThisCheck.AbstractFrame) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Collects
METHOD_DEF
declarations. - 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. - collectSuppressions(FileText) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Collets all
SuppressWithNearbyTextFilter.Suppression
instances retrieved from the givenFileText
. - 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.
- 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.site - package com.puppycrawl.tools.checkstyle.site
-
Contains classes for generating the Checkstyle website.
- 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(Collection<JavadocMethodCheck.ExceptionInfo>, Iterable<JavadocMethodCheck.ExceptionInfo>) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Combine ExceptionInfo collections together by matching names.
- COMMA - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Comma separator between parameters in
JavadocTokenTypes.PARAMETERS
part ofJavadocTokenTypes.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.AbstractAutomaticBean
-
Comma separator for StringTokenizer.
- COMMA_SPACE - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string ', '.
- COMMA_SPACE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
The precompiled pattern for a comma followed by a space.
- 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.AbstractElementNode
-
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.AbstractElementNode
-
Compares current object with specified for order.
- compareOrder(NodeInfo) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Compares current object with specified for order.
- compareOrder(NodeInfo) - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
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.
- CONDITIONAL_OPERATOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Token types for conditional 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.InternalLoader
-
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.AbstractAutomaticBean
-
The configuration of this bean.
- configuration - Variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
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.AbstractAutomaticBean
-
Implements the Configurable interface using bean introspection.
- configure(Configuration) - Method in interface com.puppycrawl.tools.checkstyle.api.Configurable
-
Configures this component.
- configureGlobalProperties(String) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Configures the global properties for the current module.
- 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.
- constructMessageKeyUrl(Class<?>, String) - Static method in class com.puppycrawl.tools.checkstyle.site.ViolationMessagesMacro
-
Constructs a URL to GitHub that searches for the message key.
- ConstructorFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ConstructorFrame
-
Creates a constructor frame.
- ConstructorsDeclarationGroupingCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that all constructors are grouped together.
- ConstructorsDeclarationGroupingCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck
- 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.
- 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.
- 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.
- containsNullCaseLabelElement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
-
Checks if a switch block contains a null case label.
- 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 or record pattern 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.AbstractAutomaticBean
-
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.AbstractAutomaticBean.PatternArrayConverter
- convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.PatternConverter
- convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.RelaxedAccessModifierArrayConverter
- convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.RelaxedStringArrayConverter
- convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.ScopeConverter
- convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.SeverityLevelConverter
- convert(Class, Object) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.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.
- copyOfArray(T[], int) - Static method in class com.puppycrawl.tools.checkstyle.utils.UnmodifiableCollectionUtil
-
Creates a copy of array.
- copyOfMap(Map<? extends K, ? extends V>) - Static method in class com.puppycrawl.tools.checkstyle.utils.UnmodifiableCollectionUtil
-
Creates a copy of Map.
- 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 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 methodequals(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.
- createAttributeNode() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Creates
AttributeNode
object and returns it. - createAttributeNode() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
- createBeanUtilsBean() - Static method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
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(DetailNode, 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
-
Deprecated.left in implementation until #12556 only to allow users to migrate to new gradle plugins. This method will be removed in Checkstyle 11.x.x .
- 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
andattributes
. - 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 isChecker
) by callingAuditListener.auditFinished(AuditEvent)
. - createListener(OutputStream, AbstractAutomaticBean.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.
- createListItem(XdocSink, Class<?>, String) - Static method in class com.puppycrawl.tools.checkstyle.site.ViolationMessagesMacro
-
Creates a list item for the given field.
- createListOfMessages(XdocSink, Class<?>, Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.site.ViolationMessagesMacro
-
Iterates through the fields of the class and creates an unordered list.
- 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.
- createObjectFromClassPath(String) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Create object with the help of the classpath.
- createObjectFromFullModuleNames(String, Set<String>) - Method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Create Object from optional full module names.
- createOverridingProperties() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Create the Properties object based on the arguments specified to the ANT task.
- createParentModuleParagraph(XdocSink, Class<?>, String) - Static method in class com.puppycrawl.tools.checkstyle.site.ParentModuleMacro
-
Creates a paragraph with a link to the parent module.
- 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.
- createSarifLogger(Task) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
Creates Sarif logger.
- createSink(Writer, String) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSinkFactory
-
Create a Sink instance.
- createSlCommentNode(Token) - 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.
- CURLY_BRACKET - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
The string '{}'.
- CURLY_BRACKETS - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string '{}'.
- 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.
- 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.
- currentModuleFile - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
The file of the current module being processed.
- currentModuleName - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
The name of the current module being processed.
- 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 ordered list of import groups.
- 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.
- CustomPrintWriter(Writer) - Constructor for class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink.CustomPrintWriter
-
Creates a new instance of this custom writer.
- 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.
- declaredAsPrivate - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Is class contains private modifier.
- 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_CHECK_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Default regex for checks that should be suppressed.
- 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_LINE_RANGE - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Default number of lines that should be suppressed.
- 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_NEARBY_TEXT_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Default nearby text pattern to turn check reporting off.
- 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 aswitch
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, AbstractAutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
-
Creates a new
DefaultLogger
instance. - DefaultLogger(OutputStream, AbstractAutomaticBean.OutputStreamOptions, OutputStream, AbstractAutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
-
Creates a new
DefaultLogger
instance. - DefaultLogger(OutputStream, AbstractAutomaticBean.OutputStreamOptions, OutputStream, AbstractAutomaticBean.OutputStreamOptions, AuditEventFormatter) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
-
Creates a new
DefaultLogger
instance. - DefaultLogger(OutputStream, AutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.DefaultLogger
-
Creates a new
DefaultLogger
instance. - 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.AbstractElementNode
-
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.
- DescriptionExtractor() - Constructor for class com.puppycrawl.tools.checkstyle.site.SiteUtil.DescriptionExtractor
- 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 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string '.'.
- 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.
- 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_SARIF - Static variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Poor man's enum for a sarif 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.
- ELEMENT_END - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Html element end symbol.
- ELEMENT_START - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Html element start symbol.
- ElementNode - Class in com.puppycrawl.tools.checkstyle.xpath
-
Represents DetailAST's 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 - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Constant value for cases when tokens set is empty.
- EMPTY_ABSTRACT_NODE_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Constant for optimization.
- EMPTY_ABSTRACT_NODE_ARRAY - Static variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
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.AbstractAutomaticBean.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.PkgImportControl
-
Enclose
expression
in a (non-capturing) group. - enclosingLambda - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Ast of type
TokenTypes.LAMBDA
enclosing the lambda parameter. - 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.
- encoding - Variable in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
Encoding of the writer.
- 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.
- 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 ifinput
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()
orhashCode()
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.
- 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.SuppressWithNearbyTextFilter.Suppression
-
The regexp which is used to match the event ID.
- 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.SuppressWithNearbyTextFilter.Suppression
-
The regexp which is used to match the event message.
- 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.SuppressWithNearbyTextFilter.Suppression
-
The regexp which is used to match the event source.
- 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.
- ExampleMacro - Class in com.puppycrawl.tools.checkstyle.site
-
A macro that inserts a snippet of code or configuration from a file.
- ExampleMacro() - Constructor for class com.puppycrawl.tools.checkstyle.site.ExampleMacro
- 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 likejava.lang.System.out
for a variable orjava.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(Sink, MacroRequest) - Method in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
- execute(Sink, MacroRequest) - Method in class com.puppycrawl.tools.checkstyle.site.ParentModuleMacro
- execute(Sink, MacroRequest) - Method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
- execute(Sink, MacroRequest) - Method in class com.puppycrawl.tools.checkstyle.site.ViolationMessagesMacro
- 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.
- expandedTabs(String, int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Processes and returns the column number of leading asterisk 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.
- expectedColumnNumberTabsExpanded - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Specifies the column number of starting block of the javadoc comment with tabs expanded.
- expectedColumnNumberWithoutExpandedTabs - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Specifies the column number of the leading asterisk without tabs expanded.
- 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 andchar
andfalse
forboolean
. - ExplicitInitializationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
- EXPR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An expression.
- EXPRESSIONS_WITH_NO_EXPR_ROOT - Static variable in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
The tokens here are technically expressions, but should not return an EXPR token as their root.
- 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.
- EXTENSION_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
The extension separator.
- EXTENSION_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.Checker
-
The extension separator.
- EXTENSION_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
The extension separator.
- 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 ofFileSetCheck
, orFilter
) 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_EXTENSIONS - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'fileExtensions'.
- 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 extensions of the 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
- fileLines - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Specifies the lines of the file being processed.
- 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. - 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
- FILESET_PROPERTIES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Set of properties that every FileSet check has.
- 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
-
Ensures that identifies classes that can be effectively declared as final are explicitly marked 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 specifiedAuditEvent
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.
- findFirstHtmlElementAfter(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Finds and returns first html element after the tag.
- 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
- 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.
- findFollowedBlockTagName(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Determines whether or not the paragraph tag is followed by block tag.
- 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. - findLastCaseGroupWhichContainsSlist(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Returns the last token of type
TokenTypes.CASE_GROUP
which containsTokenTypes.SLIST
. - 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.
- 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.
- 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.
- 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.
- findSentenceEndingOrNull(String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Finds the end of a sentence.
- 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.checks.javadoc.JavadocLeadingAsteriskAlignCheck
- finishJavadocTree(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
- finishLocalSetup() - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
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.api.AbstractViolationReporter
- 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.SuppressWithNearbyTextFilter
- 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 - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
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
-
Control the pattern to match 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.
- FORWARD_SLASH - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
The Forward slash.
- 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
andendIndex
are inclusive indexes of a sequence of consecutive upper-case characters. - getAbbreviationIfIllegal(String, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Get Abbreviation if it is illegal, where
beginIndex
andendIndex
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.ConstructorsDeclarationGroupingCheck
- 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.MissingNullCaseInSwitchCheck
- 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.UnusedCatchParameterShouldBeUnnamedCheck
- getAcceptableTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
- 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.coding.WhenShouldBeUsedCheck
- 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.SealedShouldHavePermitsListCheck
- 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 typeTokenTypes.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.
- getAllCaseLabels(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
-
Gets all case labels in the given switch AST node.
- 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.
- getAnnotationFullIdent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
-
Gets the full ident text of the annotation AST.
- 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 beRBRACK
,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 initialization should be indented when on next line.
- getArrayInitIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
-
A shortcut for
IndentationCheck
property. - getArrayInitNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MemberDefHandler
-
Finds the array init node.
- 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.
- getAsteriskColumnNumber(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Processes and returns an OptionalInt containing the column number of leading asterisk without tabs expanded.
- 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.AbstractElementNode
-
Checks if token type supports
@text
attribute, extracts its value, createsAttributeNode
object and returns it. - getAttributeValue(NamespaceUri, String) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns attribute value.
- getAttributeValue(NamespaceUri, String) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Returns attribute value.
- getAttributeValue(NamespaceUri, String) - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
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.
- getBlockStatements(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
-
Get all statements inside the case 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() - Method in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Obtain the ResourceBundle.
- 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.
- getCheckMessageKeys(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets the check's messages keys.
- 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 classes (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.
- getChildList(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck
-
Get a list of all children of the given AST.
- 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.
- getCodeSnippet(Collection<String>) - Static method in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Extract a code snippet from the given lines.
- 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.
- getConfigSnippet(Collection<String>) - Static method in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Extract a configuration snippet from the given lines.
- getConfiguration() - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
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.
- 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"/"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.JavadocLeadingAsteriskAlignCheck
- 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
- getDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
- getDefaultScope(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns the default
Scope
for aDetailAST
. - 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
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidNoArgumentSuperConstructorCallCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoArrayTrailingCommaCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoEnumTrailingCommaCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterOuterTypeDeclarationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.SealedShouldHavePermitsListCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Defined final to not allow JavadocChecks to change default tokens.
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.IllegalIdentifierNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.InterfaceTypeParameterNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LambdaParameterNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodTypeParameterNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PatternVariableNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordComponentNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordTypeParameterNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
- getDefaultValue() - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Get default value of property.
- getDefaultValue(String, Field, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Get the default value of the property.
- getDefaultValue(String, Field, Object, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get the default value of the property.
- getDepth() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
Get the depth of type declaration.
- getDepth() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.TypeDeclarationDescription
-
Get the depth of type declaration.
- getDepth() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Getter method for node depth.
- getDepth() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Getter method for node depth.
- getDepth() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Getter method for node depth.
- getDepth() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Getter method for node depth.
- getDescription() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame.JavaFileFilter
- getDescription() - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Get description of module.
- getDescription() - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Get description of property.
- getDescription() - Method in enum com.puppycrawl.tools.checkstyle.PropertyType
-
Returns the human-readable property description.
- getDescriptionFromJavadoc(DetailNode, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil.DescriptionExtractor
-
Extracts the description from the javadoc detail node.
- getDescriptionNodes(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil.DescriptionExtractor
-
Extracts description nodes from javadoc.
- getDescriptionText() - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Create the description text with starting index as 0 and ending index would be the first valid non-zero index amongst in the order of
propertySectionStartIdx
,exampleSectionStartIdx
andparentSectionStartIdx
. - getDetailAst() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
-
Gets the topmost leftmost DetailAST for this FullIdent.
- getDetails(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Collects validation Details.
- getDetailsForCase(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Collects details about case statements.
- getDetailsForDoLoops(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Collects validation details for LITERAL_DO loops' tokens.
- getDetailsForIf(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Collects validation details for LITERAL_IF.
- getDetailsForOthers(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Collects validation details for CLASS_DEF, RECORD_DEF, METHOD DEF, CTOR_DEF, STATIC_INIT, INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, and COMPACT_CTOR_DEF.
- getDetailsForSwitch(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Collects details about switch statements and expressions.
- getDetailsForTryCatch(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Collects validation details for LITERAL_TRY, and LITERAL_CATCH.
- getDifference(int[], int...) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get the difference between two lists of tokens.
- getDirectChildsByTag(Element, String) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Utility to get the children of an element by tag name.
- getDirectoryName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
-
Returns the directory name this file is in.
- getDisallowedAbbreviation(String) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Gets the disallowed abbreviation contained in given String.
- getDisplayName() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns display name.
- getDistributedPreviousStatement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Returns the first token of the distributed previous statement of comment.
- getDistToVariableUsageInChildNode(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Returns the distance to variable usage for in the child node.
- getDuplicatedKeys() - Method in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck.UniqueProperties
-
Retrieves a collections of duplicated properties keys.
- getEditingRow() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
- getEmptyLines(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Get list of empty lines.
- getEmptyLinesToLog(Iterable<Integer>) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Get list of empty lines to log.
- getEndColNo() - Method in class com.puppycrawl.tools.checkstyle.api.Comment
- getEndColNo() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
-
The column in the input file where the text block ends.
- getEndLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.Comment
- getEndLineNo() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
-
The last line of the text block in the input file.
- getEndLineNumber() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Get import end line number from ast.
- getErrorMessage() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.DescriptiveErrorListener
-
Getter for error message during parsing.
- getErrors() - Method in class com.puppycrawl.tools.checkstyle.XMLLogger.FileMessages
-
Returns the file error events.
- getExceptionInfo(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Get ExceptionInfo instance.
- getExceptions() - Method in class com.puppycrawl.tools.checkstyle.XMLLogger.FileMessages
-
Returns the file exceptions.
- getExceptionVariableName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
Gets variable's name associated with exception.
- getExclusions() - Method in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Gets the list of exclusions provided through the command line arguments.
- getExpectedAnnotationIndentation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Returns an expected annotation indentation.
- getExpressionValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.Values
-
Returns NP value for expression.
- getExtension() - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
-
Returns the common extension of files which are included in the resource bundle.
- getExternalResourceLocations() - Method in interface com.puppycrawl.tools.checkstyle.api.ExternalResourceHolder
-
Returns a set of external configuration resource locations which are used by the module.
- getExternalResourceLocations() - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Returns a set of external configuration resource locations which are used by all file set checks and filters.
- getExternalResourceLocations() - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
- getExternalResourceLocations() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
- getExternalResourceLocations() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
- getExternalResourceLocations() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
- getExternalResourceLocations() - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
- getField(Class<?>, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets the field with the given name from the given class.
- getFieldClass(Field, String, String, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets the class of the given field.
- getFieldName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Get the name of the field.
- getFieldType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Get field type.
- getFieldValue(Field, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Returns the value of the given field.
- getFieldWithoutThis(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Returns the frame where the field is declared, if the given field is used without 'this', and null otherwise.
- getFile() - Method in class com.puppycrawl.tools.checkstyle.api.FileText
-
Get the name of the file.
- getFileContents() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Deprecated.Usage of this method is no longer accepted. Please use AST based methods instead.
- getFileContents() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Returns the file contents associated with the file.
- getFileContents() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Returns FileContents for this filter.
- getFileContents() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Returns FileContents for this filter.
- getFileContents() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Returns contents of the file.
- getFileExtension(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Returns file extension for the given file name or empty string if file does not have an extension.
- getFileExtensions() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Makes copy of file extensions and returns them.
- getFileName() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Returns name of file being audited.
- getFileName() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Gets the name of the file.
- getFileName() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Returns name of file being audited.
- getFileName(File) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Retrieves the file name from the given
file
. - getFileNameWithoutExtension(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Returns file name without extension.
- getFilePath() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Returns full path to the file.
- getFilepathOrClasspathUri(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Resolves the specified local filename, possibly with 'classpath:' protocol, to a URI.
- getFiles() - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
-
Returns the set of files which are included in the resource bundle.
- getFilesToCheck() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Returns the list of files (full path name) to process.
- getFilesToProcess(Main.CliOptions) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Determines the files to process.
- getFileText(File) - Static method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Get FileText from a file.
- getFileText(String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Returns
FileText
instance created based on the given file name. - getFileText(String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Returns
FileText
instance created based on the given file name. - getFilteredViolations(String, FileContents, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Returns filtered set of
Violation
. - getFilters() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
-
Returns the Filters of the filter set.
- getFilters() - Method in class com.puppycrawl.tools.checkstyle.filters.CsvFilterElement
-
Returns the IntFilters of the filter set.
- getFinalCandidate(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Gets final variable candidate for ast.
- getFingerprint() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns fingerprint.
- getFirstArg() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Returns first argument.
- getFirstAst(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
-
Get the first AST of the specified method call.
- getFirstAstNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Get the first ast for given expression.
- getFirstChild() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Get the first child of this AST.
- getFirstChild() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getFirstChild(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Gets first child node of specified node.
- getFirstChildOfMatchingText(DetailNode, Pattern) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Get first child of parent node matching the provided pattern.
- getFirstChildOfType(DetailNode, int, int) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Returns the first child node which matches the provided
TokenType
and has the children index after the offset value. - getFirstClassNameNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Get node where class name of exception starts.
- getFirstColumn() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
-
Gets the first column of the suppression region.
- getFirstDomainsFromIdent(int, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Extracts defined amount of domains from the left side of package/import identifier.
- getFirstExpressionNodeFromMethodCall(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Returns the first EXPR DetailAST child from parent of comment.
- getFirstGroup() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Get first import group.
- getFirstIndentLevel() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Returns first indentation level.
- getFirstJavadocSentence(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
Extracts the first sentence as HTML formatted text from the comment of an DetailAST.
- getFirstJavadocSentence(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
Extracts the first sentence as HTML formatted text from a DetailNode.
- getFirstLine() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
-
Gets the first line of the suppression region.
- getFirstLine(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Get the first line number for given expression.
- getFirstNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Finds sub-node for given node minimal (line, column) pair.
- getFirstNodeInsideForWhileDoWhileBlocks(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Gets first Ast node inside FOR, WHILE or DO-WHILE blocks if variable usage is met only inside the block (not in its declaration!).
- getFirstNodeInsideIfBlock(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Gets first Ast node inside IF block if variable usage is met only inside the block (not in its declaration!).
- getFirstNodeInsideSwitchBlock(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Gets first Ast node inside SWITCH block if variable usage is met only inside the block (not in its declaration!).
- getFirstNodeInsideTryCatchFinallyBlocks(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Gets first Ast node inside TRY-CATCH-FINALLY blocks if variable usage is met only inside the block (not in its declaration!).
- getFirstNodeLineNumber(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
-
Get first child node in the tree line number.
- getFirstNonTightHtmlTag() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
Getter for the first non-tight HTML tag encountered while parsing javadoc.
- getFirstNonTightHtmlTag(JavadocParser, int) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
This method is used to get the first non-tight HTML tag encountered while parsing javadoc.
- getFirstSentenceOrNull(DetailNode, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Finds and returns the first sentence.
- getFirstToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Searches in given subtree (including given node) for the token which represents first symbol for this subtree in file.
- getFolderPath(File) - Static method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Retrieves the folder path from the given
file
. - getFollowingSiblings() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns following siblings of the current node.
- getFollowingSiblingsIterator() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns following sibling axis iterator.
- getForInitVariables(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Get all variables initialized In init part of for loop.
- getForIteratorVariables(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Get all variables which for loop iterating part change in every loop.
- getForLoopRightParen(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.ForHandler
-
Returns right parenthesis of for-loop statement.
- getFormat() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Format of the regular expression.
- getFormattedNodeClassNameWithoutContext(ParseTree) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Gets class name of ParseTree node and removes 'Context' postfix at the end and formats it.
- getFrameName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Getter for the frame name.
- getFrameName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Returns the name identifier text.
- getFrameName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AnonymousClassFrame
- getFrameNameIdent() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Returns the name identifier token.
- getFullImportIdent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Forms import full path.
- getFullQualifiedName() - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Get fully qualified name of module.
- getFullText() - Method in class com.puppycrawl.tools.checkstyle.api.FileText
-
Retrieve the full text of the file.
- getGenericTypeArgs(DetailAST, boolean) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Returns generic type arguments token.
- getGroupNumber(boolean, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Finds out what group the specified import belongs to.
- getGroupNumber(Pattern[], String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Finds out what group the specified import belongs to.
- getHandledTypes() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
-
Gets list of registered handler types.
- getHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
-
Get the handler for an AST.
- getHandlerFactory() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Accessor for the handler factory.
- getHandlerName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
-
Creates a handler name for this class according to ast type.
- getHandlerName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
-
Creates a handler name for this class according to ast type.
- getHashCodeBasedOnObjectContent(Serializable) - Static method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Calculates the hashcode for the serializable object based on its content.
- getHeaderLine(int) - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
Returns the line from the header.
- getHeaderLines() - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Return the header lines to check against.
- getHiddenAfter() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Get list tokens on COMMENTS channel to the right of the current token up to the next token on the DEFAULT_TOKEN_CHANNEL.
- getHiddenBefore() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Get list of tokens on COMMENTS channel to the left of the current token up to the preceding token on the DEFAULT_TOKEN_CHANNEL.
- getHtmlElementName(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Finds and returns first block-level html element name.
- getId() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Returns the identifier of the reporter.
- getId() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Returns the id (name) of this tag.
- getIdentifier(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Returns the Java identifier represented by an AST.
- getIdentifierAst() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Get ast of type
TokenTypes.IDENT
of the given lambda parameter. - getIdentLastToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Gets leftmost token of identifier.
- getIfContains(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Check whether the frame contains a given name.
- getIfContains(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.CatchFrame
- getIfContains(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
- getIfStatementRightParen(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
-
Returns right parenthesis of if statement.
- getIllegalInstantiation(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Checks illegal instantiations.
- getImportAST() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Get import ast.
- getImportContainer(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Extracts import container name from fully qualified import name.
- getImportedTypeCanonicalName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Gets imported type's canonical name.
- getImportFullPath() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Get import full path variable.
- getImportGroup() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Get import group.
- getImportGroup(boolean, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Get import valid group.
- getImportText(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
Returns import text.
- getIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Get the indentation amount for this handler.
- getIndentation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Get indentation for an AST node.
- getIndentation(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
Get indentation for a node.
- getIndentationTabWidth() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Get the width of a tab.
- getIndentCheck() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Accessor for the IndentCheck attribute.
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Compute the indentation amount for this handler.
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LambdaHandler
-
Compute the indentation amount for this handler.
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
- getIndentImpl() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchRuleHandler
- getIndex() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailNode
-
Node index among parent's children.
- getIndex() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
- getIndex(int, FileText, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Inner method to get the index number of the position of keyName.
- getIndexOfChild(Object, Object) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
- getIndexOfChild(Object, Object) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Return the index of child in parent.
- getIndexOpPreviousElement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Gets previous node for
INDEX_OP
token for usage in getPositionAfter method, it is a simplified copy of getArrayDeclaratorPreviousElement method. - getInlineTagNode(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Gets the node for the inline tag if present.
- getInlineTagNodeForAst(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Returns an inline javadoc tag node that is within a html tag.
- getInnerBopAst(JavaLanguageParser.BinOpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
Builds the binary operation (binOp) AST.
- getInstance(String) - Static method in enum com.puppycrawl.tools.checkstyle.api.Scope
-
Scope factory method.
- getInstance(String) - Static method in enum com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
SeverityLevel factory method.
- getInstance(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Factory method which returns an AccessModifier instance that corresponds to the given access modifier name represented as a
String
. - getInstanceName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Get name of instance whose method is called.
- getIntArrayPropertyValue(Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Returns the name of the bean property's default value for the int array class.
- getIntFromField(Field, Object) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Gets the value of a static or instance field of type int or of another primitive type convertible to type int via a widening conversion.
- getIntStream(Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get the int stream from the given value.
- getInvalidTags() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
-
Getter for invalidTags field.
- getItems(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Returns list of nodes matching xpath expression given event.
- getJavadocBefore(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Returns the Javadoc comment before the specified line.
- getJavadocCommentContent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Get content of Javadoc comment.
- getJavadocsForModuleOrProperty() - Static method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Get the module or property javadocs map.
- getJavadocTags(TextBlock) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Gets all standalone tags from a given javadoc.
- getJavadocTags(TextBlock, JavadocUtil.JavadocTagType) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Gets validTags from a given piece of Javadoc.
- getJavadocTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Gets Javadoc (DetailNode) tree of specified block comments.
- getKey() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
-
Gets key.
- getKey() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
-
Returns the violation key to locate the translation, can also be used in IDE plugins to map audit event violations to corrective actions.
- getKeyPattern(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Method returns regular expression pattern given key name.
- getKeyPattern(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck
-
Method returns regular expression pattern given key name.
- getLabel() - Method in enum com.puppycrawl.tools.checkstyle.meta.ModuleType
-
Get label corresponding to a module type.
- getLastChild() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Gets the last child node.
- getLastChild() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getLastColumn() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
-
Gets the last column of the suppression region.
- getLastColumnNumberOf(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
Returns the last column number of an ast.
- getLastDirectory() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Get the directory of the last loaded file.
- getLastElementBeforeEmptyLines(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Returns the element after which empty lines exist.
- getLastIndentLevel() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Returns last indentation level.
- getLastLambdaToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Looks for the last token in lambda.
- getLastLeadingAsteriskPosition(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck
-
Finds the position of the last leading asterisk in the string.
- getLastLine() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
-
Gets the last line of the suppression region.
- getLastNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
-
Finds sub-node for given node maximum (line, column) pair.
- getLastNodeLineNumber(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
-
Get last child node in the tree line number.
- getLastToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Finds a leaf, which is the most distant from the root.
- getLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
- getLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
- getLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Get the left curly brace portion of the expression we are handling.
- getLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
- getLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
- getLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
- getLeftCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
- getLeftCurly(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
-
Calculates the left curly corresponding to the block to be checked.
- getLeftNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Returns the left neighbour of a binary operator.
- getLeftParen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Get the left parenthesis portion of the expression we are handling.
- getLength(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
-
Get length of lambda body.
- getLengthOfBlock(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
-
Returns length of code.
- getLine() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Return the line number on the source file where the event occurred.
- getLine() - Method in class com.puppycrawl.tools.checkstyle.api.LineColumn
-
Gets the one-based line number.
- getLine() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
-
Getter for line field.
- getLine() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Returns line number of the tag in the source file.
- getLine() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Return the line number on the source file where the event occurred.
- getLine(int) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Returns the line associated with the tree.
- getLine(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Get the line from text of the file.
- getLine(ParseTree) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Gets line number from ParseTree node.
- getLineCodePoints(int) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Returns code point representation of file text from given line number.
- getLineColumnOfIndex(String, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Get LineColumn from string till index.
- getLineNo() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Gets line number.
- getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
-
Gets the line number.
- getLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
-
Gets the line number.
- getLineNo() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Returns the source line number where this tag was found.
- getLineNo() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Gets the line number.
- getLineNo() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser.Point
-
Getter for line number.
- getLineNo() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getLineNumber() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailNode
-
Node line number.
- getLineNumber() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
- getLineNumber() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage
-
Getter for line number where parse error occurred.
- getLineNumber() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns line number.
- getLineNumber() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
-
Returns line number.
- getLineNumber() - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
-
Returns line number.
- getLineNumber(int, FileText, String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Method returns the index number where the key is detected (starting at 0).
- getLineNumber(FileText, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck
-
Method returns line number the key is detected in the checked properties files first.
- getLines() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Returns the lines associated with the tree.
- getLines() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Gets the lines in the file.
- getLineStart(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Get the start of the line for the given line number.
- getLineStart(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Get a column number where a code starts.
- getLineStart(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Get the start of the line for the given expression.
- getLineStart(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Get the start of the line for the given expression.
- getLineStart(String) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Get the start of the specified line.
- getLineStart(String) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Get the start of the specified line.
- getLinesToPosition() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Get lines to position map.
- getLineWrappingHandler() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Accessor for the line wrapping handler.
- getLineWrappingIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
A shortcut for
IndentationCheck
property. - getLineWrappingIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
-
A shortcut for
IndentationCheck
property. - getLineWrappingIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
-
A shortcut for
IndentationCheck
property. - getLineWrappingIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
-
A shortcut for
IndentationCheck
property. - getLineWrappingIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Getter to query how far continuation line should be indented when line-wrapping is present.
- getLineWrappingIndentation() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
-
A shortcut for
IndentationCheck
property. - getLinkToDocument(String, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Constructs string with relative link to the provided document.
- getLinkToParentModule(String, String) - Static method in class com.puppycrawl.tools.checkstyle.site.ParentModuleMacro
-
Returns relative link to the parent module for the given module class.
- getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
- getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
- getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Get the child element representing the list of statements.
- getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
- getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
- getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
- getListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
- getListContentByAttribute(Element, String, String, String) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Utility to get the list contents by the attribute specified.
- getListeners() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Return the array of listeners set in this task.
- getListOfChecks(DetailAST, TreeWalker.AstState) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Method returns list of checks.
- getListSelectionModel() - Method in class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
Returns the list selection model.
- getLocalizedMessage(String, Object...) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Extracts localized messages from properties files.
- getLocalPart() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Returns local part.
- getLocalPart() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns local part.
- getLocalPart() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
-
Returns local part.
- getLogMessageId() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Returns message key we use for log violations.
- getLogMessageId() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck
- getLogMessageId() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck
- getMainAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Accessor for the MainAst attribute.
- getMatchingAstElements() - Method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Returns list of nodes matching defined line number, column number and token type.
- getMaximum() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
The maximum number of allowed detections.
- getMessage() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Return the violation associated to the event.
- getMessage() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
The message to report violations with.
- getMessage() - Method in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Gets the translated message.
- getMessage() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Return the violation associated to the event.
- getMessage(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Provide right message.
- getMessageArguments() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage
-
Getter for error message arguments.
- getMessageBundle() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Returns the message bundle name resource bundle that contains the messages used by this module.
- getMessageBundle(String) - Static method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
For unit tests, especially with a class with no package name.
- getMessageDispatcher() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
A message dispatcher is used to fire violations to interested audit listeners.
- getMessageKey() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage
-
Getter for key for error message.
- getMessageKey(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Get a message key depending on a comment type.
- getMessageKeys(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get string values of the message keys from the given check class.
- getMessages() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
-
Returns an unmodifiable map instance containing the custom messages for this configuration.
- getMessages() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
Returns an unmodifiable map instance containing the custom messages for this configuration.
- getMethod() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck.MethodNode
-
Returns the overriding method definition AST.
- getMethodAnnotationsList(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Gets the list of annotations on method definition.
- getMethodCalls() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Getter for frame's method calls.
- getMethodDefLineStart(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
-
Gets the start line of the method, excluding any annotations.
- getMethodDefParamRightParen(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
-
Returns right parenthesis of method definition parameter list.
- getMethodIdentAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
-
Returns method or constructor name.
- getMethodName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
Returns the name of the overriding method.
- getMethodName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SuperCloneCheck
- getMethodName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SuperFinalizeCheck
- getMethodsNumberOfLine(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Some javadoc.
- getMethodTags(TextBlock) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Returns the tags in a javadoc comment.
- getMethodWithoutThis(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Returns the frame where the method is declared, if the given method is used without 'this' and null otherwise.
- getMinimum() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
The minimum number of allowed detections.
- getMissedHtmlTag(RecognitionException) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Method to get the missed HTML tag to generate more informative error message for the user.
- getMissingFileName(TranslationCheck.ResourceBundle, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Returns the name of translation file which is absent in resource bundle or Guava's Optional, if there is not missing translation.
- getModifiers(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Returns the set of modifier Strings for a VARIABLE_DEF or CLASS_DEF AST.
- getModuleDetailsStore() - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Getter method for
moduleDetailsStore
. - getModuleId() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Returns id of module.
- getModuleId() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
-
Returns id of module.
- getModuleId() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Returns id of module.
- getModuleInstance(String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Returns the instance of the module with the given name.
- getModuleSimpleName() - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Extract simple file name from the whole file path name.
- getModuleType() - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Get module type(check/filter/filefilter) based on file name.
- getModuleType() - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Get module type.
- getMultilineNoArgTags(Matcher, String[], int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Gets multiline Javadoc tags with no arguments.
- getName() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
-
The name of this configuration.
- getName() - Method in enum com.puppycrawl.tools.checkstyle.api.Scope
-
Returns name of severity level.
- getName() - Method in enum com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
Returns name of severity level.
- getName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
Get the name of the catch parameter.
- getName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Get the name of the lambda parameter.
- getName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Get the name of variable.
- getName() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
-
Getter for name field.
- getName() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ClassInfo
-
Gets class name.
- getName() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
-
Gets exception name.
- getName() - Method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Gets the tag name.
- getName() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
Return name of tag.
- getName() - Method in enum com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Returns the access modifier name.
- getName() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
- getName() - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Get name of module.
- getName() - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Get name of property.
- getName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
Extracts the name of an ast.
- getNamespaceUri() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Get the URI part of the name of this node.
- getNearestClassFrameName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Gets the name of the nearest parent ClassFrame.
- getNearestClassOrEnumDefinition(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Returns CLASS_DEF or ENUM_DEF token which is the nearest to the given ast node.
- getNearestClassWithSameName(String, ToIntFunction<FinalClassCheck.ClassDesc>) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Get the nearest class with same name.
- getNearestEmptyLine(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Finds and returns nearest empty line in javadoc.
- getNearestNode(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Returns nearest node.
- getNearestSuppression(Collection<SuppressWithNearbyTextFilter.Suppression>, AuditEvent) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Finds the nearest
SuppressWithNearbyTextFilter.Suppression
instance which can suppress the givenAuditEvent
. - getNearestSuppression(Collection<SuppressWithPlainTextCommentFilter.Suppression>, AuditEvent) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Finds the nearest
SuppressWithPlainTextCommentFilter.Suppression
instance which can suppress the givenAuditEvent
. - getNewlineAndIndentSpaces(int) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Construct a string with a leading newline character and followed by the given amount of spaces.
- getNextCurNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Returns next curNode node.
- getNextFirstNonBlankOnLineAfter(int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
-
Returns column number of first non-blank char after specified column on specified line or -1 if such char doesn't exist.
- getNextFirstNonBlankOnLineAfter(int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
-
Returns column number of first non-blank char after specified column on specified line or
NOT_EXIST
if such char doesn't exist. - getNextImportGroup(int) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Get next import group.
- getNextNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
-
Finds next node of ast tree.
- getNextNode(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
-
Gets next node in the ast (sibling or parent sibling for the last node).
- getNextNodeLine(NavigableMap<Integer, DetailAST>, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Gets the next node line from the firstNodesOnLines map unless there is no next line, in which case, it returns the last line.
- getNextNonCommentAst(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
This method will skip the comment content while finding the next ast of current ast.
- getNextPoint(String[], TagParser.Point) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Increments column number to be examined, moves onto the next line when no more characters are available.
- getNextSibling() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Get the next sibling in line after this one.
- getNextSibling() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getNextSibling(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Custom getNextSibling method to handle different types of paragraph tag.
- getNextSibling(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Gets next sibling of specified node.
- getNextSibling(DetailNode, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Gets next sibling of specified node with the specified type.
- getNextSibling(ParseTree) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Gets next sibling of ParseTree node.
- getNextSiblingSkipComments(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Get next sibling node skipping any comment nodes.
- getNextStmt(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Returns the next statement of a comment.
- getNextSubTreeNode(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Gets the next node of a syntactical tree (child of a current node or sibling of a current node, or sibling of a parent of a current node).
- getNextSubTreeNode(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Gets the next node of a syntactical tree (child of a current node or sibling of a current node, or sibling of a parent of a current node).
- getNextToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Finds next token after the given one.
- getNextToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Get the token to start counting the number of lines to add to the distance aim from.
- getNodeClassNameWithoutContext(ParseTree) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Gets class name of ParseTree node and removes 'Context' postfix at the end.
- getNodeInfo(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Get string representation of the node as token name, node text, line number and column number.
- getNodeKind() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns type of the node.
- getNodeKind() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Returns type of the node.
- getNodeKind() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns type of the node.
- getNonExplicitProperties(Object, Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets properties that are not explicitly captured but should be documented if certain conditions are met.
- getNonListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Get the child element that is not a list of statements.
- getNonListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DoWhileHandler
- getNonListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ElseHandler
- getNonListChild() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
- getNthChild(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Returns the n'th child of an AST node.
- getNumberOfChildren() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Deprecated.This method will be removed in a future release. Use
DetailAST.getChildCount()
instead. - getNumberOfChildren() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getObjectFrame(EqualsAvoidNullCheck.FieldFrame) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Get the nearest parent frame which is CLASS_DEF, ENUM_DEF or ENUM_CONST_DEF.
- getOneLinePreviousStatement(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Does pre-order traverse of abstract syntax tree to find the previous statement of the comment.
- getOption(Class<T>, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
Retrieves an
Enum
type from a @{link String String}. - getOutputStream(Path) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Create output stream or return System.out.
- getOutputStreamOptions(Path) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Create
AbstractAutomaticBean.OutputStreamOptions
for the given location. - getPackageName() - Method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
-
Creates a full package name from the package names on the stack.
- getPackageName(String) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Retrieve package name of module from the absolute file path.
- getPackageNames(ClassLoader) - Static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
-
Returns the set of package names, compiled from all checkstyle_packages.xml files found on the given class loaders classpath.
- getPackageObjectFactory() - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Returns the default PackageObjectFactory with the default package names.
- getPackageText(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
Returns package text.
- getParameterDefinition() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
Get the parameter definition token of the catch parameter represented by ast of type
TokenTypes.PARAMETER_DEF
. - getParameters(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Computes the parameter nodes for a method.
- getParent() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Returns the parent token.
- getParent() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailNode
-
Parent node.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Getter for the parent frame.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
-
Getter for parent frame.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Returns the parent frame.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Accessor for the Parent attribute.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
- getParent() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getParent() - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Get parent of module.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns parent.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Returns parent.
- getParent() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns parent.
- getParent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
-
Returns the parent node of the comment.
- getParent(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Returns parent node, removing modifier/annotation nodes.
- getParent(DetailAST, BitSet) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
-
Get ast parent, ignoring token types from
skipTokens
. - getParentAst(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Get the parent node of the given type.
- getParenthesesChildrenAroundQuestion(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Returns the direct LPAREN tokens children to a given QUESTION token which contain an expression not a literal variable.
- getParentIndexOf(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Traverse parents until we reach the root node (@code{JavadocTokenTypes.JAVADOC}) child and return its index.
- getParentLoop(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Get the ast node of type
FinalLocalVariableCheck.LOOP_TYPES
that is the ancestor of the current ast node, if there is no such node, null is returned. - getParentModule(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Returns the parent module name for the given module class.
- getParentText(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Get module parent text from paragraph javadoc node.
- getParentType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
-
Returns type of parent node.
- getParseErrorMessage() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
Getter for error message during parsing.
- getParseErrorMessage(JavadocDetailNodeParser.ParseErrorMessage) - Static method in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
Builds violation base on ParseErrorMessage's violation key, its arguments, etc.
- getParseTreeTableModel() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Get parse tree table model.
- getPath() - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
-
Returns the common path of files which are included in the resource bundle.
- getPath(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Extracts path from a file name which contains the path.
- getPattern() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
The pattern to use when matching.
- getPatternArrayPropertyValue(Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets the name of the bean property's default value for the Pattern array class.
- getPatternSafely(Pattern) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Util method to get pattern String value from Pattern object safely, return null if pattern object is null.
- getPatternSafely(Pattern) - Static method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Util method to get pattern String value from Pattern object safely, return null if pattern object is null.
- getPosition() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Returns the position with in the comment line where this tag was found.
- getPosition() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
Return position of tag.
- getPositionAfter(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Gets position after token (place of possible redundant whitespace).
- getPostFixNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Gets postfix Node from AST if present.
- getPrecedingDot(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Gets the dot preceding a class member array index operation or class reference.
- getPrecedingSiblings() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns preceding siblings of the current node.
- getPrecedingSiblingsIterator() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns preceding sibling axis iterator.
- getPrefix() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns prefix.
- getPrevCaseToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Gets previous case-token for comment.
- getPreviousElementOfMultiDimArray(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Gets the previous element of a second or higher dimension of an array declaration or initialization.
- getPreviousNodeWithParentOfTypeAst(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Finds previous node by text order for an array declarator, which parent type is
TYPE
. - getPreviousSibling() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Returns the previous sibling or null if no such sibling exists.
- getPreviousSibling() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getPreviousSibling(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Gets previous sibling of specified node.
- getPreviousStatement(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Returns the previous statement of a comment.
- getPrevSiblingSkipComments(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Get previous sibling node skipping any comments.
- getPrevStatementFromSwitchBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Gets comment's previous statement from switch block.
- getPrevStatementWhenCommentIsUnderCase(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Gets previous statement for comment which is placed immediately under case.
- getProperties() - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Get property list of module.
- getProperties(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get a set of properties for the given class.
- getPropertiesForDocumentation(Class<?>, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get a set of properties for the given class that should be documented.
- getPropertiesJavadocs(Set<String>, String, File) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get the javadocs of the properties of the module.
- getProperty(String) - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
-
The property value for property name.
- getProperty(String) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
- getPropertyClass(String, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets the class of the given java property.
- getPropertyDefaultText(DetailNode, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Create property default text, which is either normal property value or list of tokens.
- getPropertyDescription(String, DetailNode, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get the description of the property.
- getPropertyName(String) - Static method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Get the property name from the setter method name.
- getPropertyNameFromExpression(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.ChainedPropertyUtil
-
Gets an unresolved property name from a property variable expression by stripping the preceding '${' and trailing '}'.
- getPropertyNames() - Method in interface com.puppycrawl.tools.checkstyle.api.Configuration
-
The set of property names.
- getPropertyNames() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
- getPublicId() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns public id.
- getQualifiedName() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
Get the complete type declaration name i.e. type declaration name with package name and outer type declaration name.
- getQualifiedName() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.TypeDeclarationDescription
-
Get the complete type declaration name i.e. type declaration name with package name and outer type declaration name.
- getQualifiedTypeDeclarationName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Get qualified type declaration name from type ast.
- getQualifiedTypeDeclarationName(String, String, String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Get the qualified name of type declaration by combining
packageName
,outerClassQualifiedName
andclassName
. - getRangeValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.Values
-
Returns NP value for range.
- getRecordComponentNames(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Collects the record components in a record definition.
- getReferencedClassDot(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Gets the dot preceding a class reference.
- getRegexCompileFlags() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Retrieves the compile-flags for the regular expression being built based on
matchAcrossLines
. - getReporter() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
The violation reporter to use.
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
The javadoc tokens that this check must be registered for.
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
-
The javadoc tokens that this check must be registered for.
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
- getRequiredJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
The tokens that this check must be registered for.
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidNoArgumentSuperConstructorCallCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoArrayTrailingCommaCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoEnumTrailingCommaCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterOuterTypeDeclarationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.SealedShouldHavePermitsListCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.IllegalIdentifierNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.InterfaceTypeParameterNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LambdaParameterNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodTypeParameterNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PatternVariableNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordComponentNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordTypeParameterNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
- getResolvedProperties(Properties) - Static method in class com.puppycrawl.tools.checkstyle.utils.ChainedPropertyUtil
-
Accepts user defined properties and returns new properties with all chained properties resolved.
- getResourceFromClassPath(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Gets a resource from the classpath.
- getRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
- getRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
- getRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Get the right curly brace portion of the expression we are handling.
- getRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
- getRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
- getRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
- getRightCurly() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
- getRightNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Returns the right neighbour of a binary operator.
- getRightParen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Get the right parenthesis portion of the expression we are handling.
- getRoot() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Returns root PkgImportControl.
- getRoot() - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
- getRoot() - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Returns value of root.
- getRoot() - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor.DetailAstPair
-
Returns the root node.
- getRoot() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns root.
- getRoot() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Returns root of the tree.
- getRoot() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns root.
- getRootAst() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Gets the root element of the AST tree.
- getRootModule(String, ClassLoader) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Creates a new instance of the root module that will control and run Checkstyle.
- getRowCount() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
- getSchemaType() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns type of the schema.
- getScope() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Get ast of type
TokenTypes.SLIST
orTokenTypes.LITERAL_FOR
orTokenTypes.OBJBLOCK
which is enclosing the variable i.e. its scope. - getScope(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns the
Scope
for a givenDetailAST
. - getScopeDefinition() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
-
Returns the surrounding scope definition (class, enum, etc.) which the method counts are connected to.
- getScopeFromMods(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns the
Scope
specified by the modifier set. - getSelectionEnd() - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
-
Returns selection end position.
- getSelectionStart() - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
-
Returns selection start position.
- getSeverity() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Get the severity level's name.
- getSeverityLevel() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Returns the severity level of the violations generated by this module.
- getSeverityLevel() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Gets the audit event severity level.
- getSeverityLevel() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
-
Gets the severity level.
- getShortDescription(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Returns the short description of a token for a given name.
- getShortFromFullModuleNames(String) - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Returns simple check name from full modules names map.
- getShortNameOfAnonInnerClass(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Get the short name of super class of anonymous inner class.
- getSinceJavadocTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Find the since Javadoc tag node in the given Javadoc.
- getSinceVersion(String, DetailNode, String, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get the since version of the property.
- getSinceVersionFromJavadoc(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Extract the since version from the Javadoc.
- getSingleLineComments() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Returns a map of all the single-line comments.
- getSmallestIndent(Collection<String>) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Helper method for stripIndentAndInitialNewLineFromTextBlock, to determine the smallest indent in a text block string literal.
- getSource() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
The object on which the Event initially occurred.
- getSourceFileName() - Method in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
-
Get source file name.
- getSourceName() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Gets the name of the source for the violation.
- getSourceName() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
-
Gets the name of the source for this Violation.
- getSourceName() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Gets the name of the source for the violation.
- getStartColNo() - Method in class com.puppycrawl.tools.checkstyle.api.Comment
- getStartColNo() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
-
The column in the input file where the text block starts.
- getStartColumn(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
-
Get starting column number for the ast.
- getStartLineNo() - Method in class com.puppycrawl.tools.checkstyle.api.Comment
- getStartLineNo() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
-
The line in the input file where the text block starts.
- getStartLineNumber() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Get import start line number from ast.
- getStatementList(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
-
Get the statement list token of the case block.
- getStrategyForImportControl(Attributes) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Utility to get a strategyOnMismatch property for "import-control" tag.
- getStrategyForSubpackage(Attributes) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Utility to get a strategyOnMismatch property for "subpackage" tag.
- getStringArrayPropertyValue(String, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets the name of the bean property's default value for the string array class.
- getStringExpr(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Returns the literal string expression represented by an AST.
- getStringInsideTag(String, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Get concatenated string within text of html tags.
- getStringOrDefault(Pattern, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Retrieves the String form of the
pattern
ordefaultString
if null. - getStringValue() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns string value.
- getStringValue() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns string value.
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Indentation level suggested for a child element.
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CaseHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LambdaHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MemberDefHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchRuleHandler
- getSuggestedChildIndent(AbstractExpressionHandler) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
- getSummarySentence(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Finds and returns summary sentence.
- getSuperClassName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Get super class name of given class.
- getSuperClassOfAnonInnerClass(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Get the
UnusedLocalVariableCheck.TypeDeclDesc
of the super class of anonymous inner class. - getSuppressElement(Attributes) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Returns the suppress element, initialized from given attributes.
- getSuppression(FileText, int) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Tries to extract the suppression from the given line.
- getSuppression(FileText, int) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Tries to extract the suppression from the given line.
- getSuppressionLoader(InputSource, String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Parses specified source and returns the suppression loader.
- getSuppressions(FileText) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Returns the list of
SuppressWithPlainTextCommentFilter.Suppression
instances retrieved from the givenFileText
. - getSuppressor() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
The suppressor to use.
- getSuppressWarnings(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
-
Gets the
SuppressWarnings
annotation that is annotating the AST. - getSurroundingAccessModifier(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Returns the access modifier of the surrounding "block".
- getSurroundingScope(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns the scope of the surrounding "block".
- getSynchronizedStatementRightParen(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.SynchronizedHandler
-
Returns right parenthesis of synchronized statement.
- getSystemId() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns system id.
- getTableCellEditorComponent(JTable, Object, boolean, int, int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable.TreeTableCellEditor
- getTableCellRendererComponent(JTable, Object, boolean, boolean, int, int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
TreeCellRenderer method.
- getTabWidth() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Get tab width to report audit events with.
- getTabWidth() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Get tab width to report audit events with.
- getTagId(String[], TagParser.Point) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Parse tag id.
- getTagName() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Gets tag name.
- getTagName(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Gets tag name from javadocTagSection.
- getTagTextFromProperty(DetailNode, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Get tag text from property data.
- getTagType() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Determines whether the suppression turns checkstyle reporting on or off.
- getTargetFiles(String, String...) - Static method in class com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtil
-
Get files that represent modules.
- getTemplatePath(String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Returns path to the template for the given module name or throws an exception if the template cannot be found.
- GETTER_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Pattern matching names of getter methods.
- getText() - Method in class com.puppycrawl.tools.checkstyle.api.Comment
- getText() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Gets the text of this AST.
- getText() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailNode
-
Node text.
- getText() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Get the full text of the file.
- getText() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
-
Gets the text.
- getText() - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
-
The text content of the text block.
- getText() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Returns the comment line of text where this tag appears.
- getText() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
-
Gets text of the token.
- getText() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
- getText() - Method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Gets the tag text.
- getText() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getText() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Get text to display in a text area.
- getText(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Get joined text from all text children nodes.
- getTextAttributeValue(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
-
Returns content of the text attribute of the ast element.
- getTextFromTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Get text from
JavadocTokenTypes.JAVADOC_INLINE_TAG
. - getTheNearestClass(String, List<UnusedLocalVariableCheck.TypeDeclDesc>) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
For all type declarations with the same name as the superclass, gets the nearest type declaration.
- getThreadModeSettings() - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
Gets the thread mode configuration.
- getThrowed(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Get ExceptionInfo for all exceptions that throws in method code by 'throw new'.
- getThrows(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Computes the exception nodes for a method.
- getThrowsIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Getter to query how far a throws clause should be indented when on next line.
- getTitle() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Returns title for the main frame.
- getTokenId(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Returns the ID of a token for a given name.
- getTokenId(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Returns the ID of a token for a given name.
- getTokenName(int) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Returns the name of a token for a given ID.
- getTokenName(int) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Returns the name of a token for a given ID.
- getTokenNames() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Returns the tokens registered for the check.
- getTokenType() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
-
Gets the token type.
- getTokenType() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Gets the token type of the violation.
- getTokenType() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Getter method for token type.
- getTokenType() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Getter method for token type.
- getTokenType() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
-
Getter method for token type.
- getTokenType() - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
-
Getter method for token type.
- getTokenType(ParseTree) - Static method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Gets token type of ParseTree node from JavadocTokenTypes class.
- getTokenTypesTotalNumber() - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Get total number of TokenTypes.
- getTopLevelAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
- getTopLevelAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
- getTopLevelAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Get the top level expression being managed by this handler.
- getTopLevelAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ClassDefHandler
- getTopLevelAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
- getTopLevelAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
- getTopLevelAst() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
- getTotal() - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
-
Fetches total number of methods.
- getTranslationKeys(File) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Loads the keys from the specified translation file into a set.
- getTree() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Returns tree.
- getTree() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
Getter for DetailNode tree.
- getTreeInfo() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns tree info.
- getTreeWalkerConfig(Configuration) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Returns
TreeWalker
module configuration. - getTreeWalkerThreadsNumber() - Method in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
Gets the number of threads for the TreeWalker module.
- getTryResLparen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
-
Method to find left parenthesis of try with resources.
- getTryResRparen() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
-
Method to find right parenthesis of try with resources.
- getType() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Gets the type of this AST.
- getType() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailNode
-
Node type.
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Get the type of the frame.
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.BlockFrame
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.CatchFrame
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ConstructorFrame
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ForFrame
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.MethodFrame
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.TryWithResourcesFrame
- getType() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
- getType() - Method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Gets the Tag type defined by
Type
. - getType() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- getType() - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Get type of property.
- getType(Field, String, String, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Get the type of the property.
- getTypeArgsClassNames(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Returns a list of type parameters class names.
- getTypeAst() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Get the associated ast node of type
TokenTypes.TYPE
. - getTypeDeclarationAst() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.TypeDeclarationDescription
-
Get the type declaration ast node.
- getTypeDeclarationNameMatchingCountDiff(String, UnusedLocalVariableCheck.TypeDeclDesc, UnusedLocalVariableCheck.TypeDeclDesc) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Get the difference between type declaration name matching count.
- getTypeDeclAst() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
Get the type declaration ast node.
- getTypeLastNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Searches parameter node for a type node.
- getTypeParameterNames(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Retrieves the names of the type parameters to the node.
- getTypeParameters(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Retrieves the type parameters to the node.
- getUnderlyingNode() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns underlying node.
- getUnderlyingNode() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns underlying node.
- getUnderlyingNode() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
-
Returns underlying node.
- getUnderlyingNode() - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
-
Returns underlying node.
- getUnicodeStringValue() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns the value of the item as a Unicode string.
- getUpdatedCopyOfVarStack(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
Get the copy of variables in instanceAndClassVar stack with updated scope.
- getURI() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns uri of the namespace for the current node.
- getUriByFilename(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Resolve the specified filename to a URI.
- getValidationType() - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Get validation type of property.
- getValidTags() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
-
Getter for validTags field.
- getValidTags(TextBlock, JavadocUtil.JavadocTagType) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Returns the list of valid tags found in a javadoc
TextBlock
. - getValue() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
-
Gets value.
- getValue() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
Return value of tag.
- getValueAt(int, int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
- getValueAt(Object, int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
-
Returns the value to be displayed for node at column number.
- getValueAt(Object, int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Returns the value to be displayed for node at column number.
- getValueAtDetailAST(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Gets a value for DetailAST object.
- getValueAtDetailNode(DetailNode, int) - Static method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Gets a value for DetailNode object.
- getValues() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.FormatterType
- getValuesStream(Object) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Generates a stream of values from the given value.
- getVarDefStatementSemicolon(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.MemberDefHandler
-
Returns semicolon for variable definition statement.
- getVariablesManagedByForLoop(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Determines which variable are specific to for loop and should not be change by inner loop body.
- getVariableUsageExpressionsInsideSwitchBlock(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Helper method for getFirstNodeInsideSwitchBlock to return all variable usage expressions inside a given switch block.
- getVersionString() - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Returns the version string printed when the user requests version help (--version or -V).
- getViolation() - Method in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Gets the violation.
- getViolation() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
-
Gets the translated violation.
- getViolation() - Method in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Gets the violation.
- getViolationAstForPackage(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Gets the Ast on which violation is to be given for package declaration.
- getViolationMessageKeys() - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Get violation message keys of the module.
- getViolationMessages(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Get the violation message text for a specific key from the list item.
- getViolations() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Returns the sorted set of
Violation
. - getViolations() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Returns the sorted set of
Violation
. - getVisibilityScope(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Returns the visibility scope for the variable.
- getVisibleContent(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Gets the string that is visible to user in javadoc.
- getWebOrFileProtocolUri(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Resolves the specified filename containing 'http', 'https', 'ftp', and 'file' protocols (or any RFC 2396 compliant URL) to a URI.
- getWhitespaceFollowedNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
For a visited ast node returns node that should be checked for not being followed by whitespace.
- getXdocsTemplatesFilePaths() - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Gets xdocs template file paths.
- getXpathFilter(Attributes) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Returns the xpath filter, initialized from given attributes.
- getXpathItems(String, AbstractNode) - Static method in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
-
Returns list of nodes matching xpath expression given node context.
- getXpathQuery(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Returns relative xpath query for given ast element from root.
- GlobalStatefulCheck - Annotation Type in com.puppycrawl.tools.checkstyle
-
This annotation means that the check contains global context, which will be updated while Checkstyle processes files.
- group - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.RuleMatchForImport
-
Import group for current best match.
- GROUP_SEPARATOR_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Pattern used to separate groups of imports.
- groupFilesIntoBundles(Set<File>, Pattern) - Static method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Groups a set of files into bundles.
- groups - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Specify list of type import groups.
- groupsReg - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Complied array of patterns for property
groups
. - GT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
>
(greater than) operator.
H
- haltOnException - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
Controls whether exceptions should halt execution or not.
- handleCommentAtTheEndOfTheCodeBlock(DetailAST, DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Handles a comment which is placed at the end of non-empty code block.
- handleCommentInEmptyCaseBlock(DetailAST, DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Handles a comment which is placed within empty case block.
- handleCommentInEmptyCodeBlock(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Handles a comment which is placed within the empty code block.
- handleEndTag(XmlPullParser, Sink) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
- handleFallThroughComment(DetailAST, DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Handles 'fall through' single-line comment.
- handleInternalLink(StringBuilder, String, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil.DescriptionExtractor
-
Converts the href value to a relative link to the document and appends it to the description.
- handlerFactory - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Factory from which handlers are distributed.
- HandlerFactory - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Factory for handlers.
- HandlerFactory() - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
-
Creates a HandlerFactory.
- handlers - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Handlers currently in use.
- handleStartTag(XmlPullParser, Sink) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
- HAS_MEMBERS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
-
Predicate for tokens that is used in
AvoidDoubleBraceInitializationCheck.hasOnlyInitialization(DetailAST)
. - hasAnyImportInCurrentGroup(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Checks if current group contains any import.
- hasArguments(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
Checks that annotation has arguments.
- hasArguments(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
Does method have any arguments.
- hasAtLeastOneSiblingWithSameTokenType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Checks if the given ast element has unique
TokenTypes
among siblings. - hasBlockParent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
-
Determine if the expression we are handling has a block parent.
- hasChildNodes() - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Determine whether the node has any children.
- hasChildNodes() - Method in class com.puppycrawl.tools.checkstyle.xpath.ElementNode
-
Determine whether the node has any children.
- hasChildNodes() - Method in class com.puppycrawl.tools.checkstyle.xpath.RootNode
-
Determine whether the node has any children.
- hasChildren() - Method in interface com.puppycrawl.tools.checkstyle.api.DetailAST
-
Returns whether this AST has any children.
- hasChildren() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- hasCurlies() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.BlockParentHandler
-
Determines if this block expression has curly braces.
- hasDeclaredConstructor - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Does class have implicit constructor.
- hasDefaultConstructor(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks if the class has a default constructor.
- hasDefaultCtor - Variable in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Result of details gathering.
- hasDefaultOrExplicitNonPrivateCtor(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Checks whether a class has default or explicit non-private constructor.
- hasEmptyImplementation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Checks whether a method has only comments in the body (has an empty implementation).
- hasEmptyLine(int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Checks, whether there are empty lines within the specified line range.
- hasEmptyLineAfter(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Checks if token have empty line after.
- hasEmptyLineBefore(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Checks if a token has an empty line before.
- hasFallThroughComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
Determines if the fall through case between
currentCase
andnextCase
is relieved by an appropriate comment. - hasFinalField(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Checks whether given instance member has final modifier.
- hasFingerprint() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns if implementation provides fingerprints.
- HASH - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Hash character in
JavadocTokenTypes.REFERENCE
. - hashCode() - Method in class com.puppycrawl.tools.checkstyle.api.LineColumn
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.api.Violation
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.CsvFilterElement
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilterElement
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilterElement
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
- hashCode() - Method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
- hasIgnoreAnnotation(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks if variable def has ignore annotation.
- hasIgnoredAnnotation(DetailAST, Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Checks whether a method has any of ignored annotations.
- hasIgnoredModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Checks if a variable is to be ignored based on its modifiers.
- hasInstanceMember(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Checks if a given name is a known instance member of the class.
- hasInstanceMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Checks if a given name is a known instance method of the class.
- hasInsufficientConsecutiveNewlines(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
-
Returns true when there are not enough empty lines before the provided tagNode.
- hasIntersectionWithBlockComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Checks if the specified position intersects with a block comment.
- hasIntersectionWithComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Checks if the specified position intersects with a comment.
- hasIntersectionWithSingleLineComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Checks if the specified position intersects with a single-line comment.
- hasJavadoc(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
-
Checks that there is javadoc before ast.
- hasJavadocAboveAnnotation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
-
Checks javadoc existence in annotations list.
- hasJavadocComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Checks whether a method has a javadoc comment.
- hasJavadocCommentOnToken(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Checks whether a token has a javadoc comment.
- hasJavadocInlineTags(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Checks if comment has in-line tags which are not ignored.
- hasJavadocTags(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Checks if comment has javadoc tags which are not ignored.
- hasLabel(DetailAST, Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
Checks if given break or continue ast has outer label.
- hasLineBreakAfter(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Checks if left curly has line break after.
- hasLineBreakBefore(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Checks if right curly has line break before.
- hasLiteralNull(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
-
Checks if the given case AST node has a null label.
- hasMultipleLinesBefore(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Whether the token has not allowed multiple empty lines before.
- hasNextTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Indicates if there are any more HtmlTag to retrieve.
- hasNodeAfter(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Checks whether an annotation node has any node after on the same line.
- hasNodeBefore(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Checks whether an annotation node has any node before on the same line.
- hasNodeBeside(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Checks whether an annotation node has any node before or after on the same line.
- hasNonPrivateStaticMethodOrField - Variable in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Result of details gathering.
- hasNonStaticMethodOrField - Variable in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Result of details gathering.
- hasNotAllowedTwoEmptyLinesBefore(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Checks if a token has empty two previous lines and multiple empty lines is not allowed.
- hasNullCaseLabel(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
-
Checks if the case contains null label.
- hasOnlyEmptyText(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck
-
Tests if description node is empty (has only new lines and blank strings).
- hasOnlyInitialization(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
-
Checks that block has at least one instance init block and no other class members.
- hasOverrideAnnotation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Checks that the method has "@Override" annotation.
- hasOverrideAnnotation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
-
Checks if the AST is annotated with
Override
orjava.lang.Override
annotation. - hasPatternCaseLabel(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
-
Checks if the given case AST node has a pattern variable declaration label or record pattern definition label.
- hasPatternLabel(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
-
Check if the case block has a pattern variable definition or a record pattern definition.
- hasPrecedingSemiColon(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks that a token is preceded by a semicolon.
- hasProperAccessModifier(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks if current variable has proper access modifier according to Check's options.
- hasPublic - Variable in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
-
If file has public type.
- hasPublicCtor - Variable in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Result of details gathering.
- hasReliefComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
Check if there is any fall through comment.
- hasSameNameAsSuperClass(String, UnusedLocalVariableCheck.TypeDeclDesc) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Whether the qualified name of
typeDeclDesc
matches the super class name. - hasShortCircuitTag(DetailAST, List<JavadocTag>) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Validates whether the Javadoc has a short circuit tag.
- hasSiblings(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
-
Checks whether the AST node has any siblings or not.
- hasStaticMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Checks if a given name is a known static method of the class.
- hasStringCaseLabel(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
-
Checks if the given case contains a string in its label.
- hasStringLiteralChild(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
-
Checks whether string literal or text block literals are concatenated.
- hasText(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
-
Checks if SLIST token contains any text.
- hasTrailComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Check if trail comment is present after ast token.
- hasTrailingWhitespace(DetailAST, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Checks if there is unwanted whitespace after the visited node.
- hasUnbracedStatements(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if switch member (case, default statements) has statements without curly braces.
- hasUnicodeChar(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Checks if literal has Unicode chars.
- hasValidAlignment(int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Checks the column difference between expected column number and leading asterisk column number.
- hasValidJavadocComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Checks whether a javadoc contains the specified comment pattern that denotes a method as designed for extension.
- hasValidParentToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
-
Check if the given
TokenTypes.IDENT
has a valid parent token. - hasWhitespaceBefore(int, int...) - Static method in class com.puppycrawl.tools.checkstyle.utils.CodePointUtil
-
Checks if the given code point array contains only whitespace up to specified index.
- hasWhitespaceBefore(int, String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Returns whether the specified string contains only whitespace up to the specified index.
- HEAD - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Head html tag.
- HEAD_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Head tag name.
- HEAD_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End head tag.
- HEAD_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start head tag.
- HEADER_CHECK_HEADER - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Check and property name.
- HeaderCheck - Class in com.puppycrawl.tools.checkstyle.checks.header
-
Checks that a source file begins with a specified header.
- HeaderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
- headerFile - Variable in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Specify the name of the file containing the required header.
- headerRegexps - Variable in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
The compiled regular expressions.
- HELP_WIDTH - Static variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Width of CLI help option.
- hiddenAfter - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
All tokens on COMMENTS channel to the right of the current token up to the next token on the DEFAULT_TOKEN_CHANNEL.
- hiddenBefore - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
All tokens on COMMENTS channel to the left of the current token up to the preceding token on the DEFAULT_TOKEN_CHANNEL.
- HiddenFieldCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that a local variable or a parameter does not shadow a field that is defined in the same class.
- HiddenFieldCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
- HiddenFieldCheck.FieldFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Holds the names of static and instance fields of a type.
- HideUtilityClassConstructorCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Makes sure that utility classes (classes that contain only static methods or fields in their API) do not have a public constructor.
- HideUtilityClassConstructorCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
- HideUtilityClassConstructorCheck.Details - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Details of class that are required for validation.
- HR_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Hr tag name.
- HR_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Hr html tag.
- HTML - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Html html tag.
- HTML_COMMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Html comment:
<!-- -->
. - HTML_COMMENT_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
HTML comment end symbol '-->'.
- HTML_COMMENT_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
HTML comment start symbol '<!--'.
- HTML_ELEMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Parent node for all html tags.
- HTML_ELEMENT_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End html tag: <XXXX>.
- HTML_ELEMENT_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start html tag: <XXXX>.
- HTML_ELEMENTS - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
This regexp is used to remove html tags, whitespace, and asterisks from a string.
- HTML_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Html tag name.
- HTML_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Non-special HTML tag.
- HTML_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End html tag.
- HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Identifier inside HTML tag: tag name or attribute name.
- HTML_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start html tag.
- HtmlTag - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Used to keep track of a tag and the text that follows it.
- HtmlTag(String, int, int, boolean, boolean, String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Construct the HtmlTag.
I
- ICON - Static variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
The icon to show in the OS task panel.
- id - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
The identifier of the reporter.
- id - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
The HTML tag name.
- id - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Specify a string matched against the ID of the check associated with an audit event.
- id - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Define a string matched against the ID of the check associated with an audit event.
- IDENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An identifier.
- identifierAst - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Ast of type
TokenTypes.IDENT
of the given lambda parameter. - idFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Specify check ID pattern to suppress.
- idFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Specify check ID pattern to suppress.
- idFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Specify check ID pattern to suppress.
- idPattern - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Specify check ID pattern to suppress.
- IfHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for if statements.
- IfHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- IGNORE - com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
Severity level ignore.
- IGNORE - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ClosingParensOption
-
Mixed styles.
- IGNORE - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ElementStyleOption
-
Mixed styles.
- IGNORE - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.TrailingArrayCommaOption
-
Mixed styles.
- IGNORE_FIRST_LINE - com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler.LineWrappingOptions
-
First line's indentation should NOT be checked.
- ignoreAbstractMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Control whether to ignore parameters of abstract methods.
- ignoreAnnotatedBy - Variable in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
-
Ignore classes annotated with the specified annotation(s).
- ignoreAnnotatedBy - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Ignore methods and constructors annotated with the specified annotation(s).
- ignoreAnnotation - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Ignore magic numbers in annotation declarations.
- ignoreAnnotationCanonicalNames - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Specify annotations canonical names which ignore variables in consideration.
- ignoreAnnotationElementDefaults - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Ignore magic numbers in annotation elements defaults.
- ignoreAnnotationShortNames - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Set of ignore annotations short names.
- ignoreCase - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
-
Control whether to ignore case when matching.
- ignoreCase - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Whether to ignore case when matching.
- ignoreCase - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Control whether to ignore case when searching.
- ignoreCase - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Control whether to ignore case when searching.
- ignoreCase - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Control whether to ignore case when searching.
- ignoreCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
-
Specifies whether to ignore case when matching and returns Builder object.
- ignoreComments - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Control whether to ignore matches found within comments.
- ignoreComments - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Control whether to ignore text in comments when searching.
- ignoreConstructorParameter - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Control whether to ignore constructor parameters.
- ignoreConstructors - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Control whether to ignore constructors.
- IGNORED_LIST - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
The list of ignored token types for being checked by lineWrapping indentation inside
checkIndentation()
as these tokens are checked for lineWrapping inside their dedicated handlers. - IGNORED_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
-
Set of token types that are used in
AvoidDoubleBraceInitializationCheck.HAS_MEMBERS
predicate. - ignoredAnnotations - Variable in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Specify annotations which allow the check to skip the method from validation.
- ignoredMethodNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Specify names of methods to ignore.
- ignoredMethodNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Specify methods that should not be checked.
- IgnoredModulesOptions() - Constructor for enum com.puppycrawl.tools.checkstyle.ConfigurationLoader.IgnoredModulesOptions
- ignoredTags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Specify block tags which are ignored by the check.
- ignoreEnhancedForColon - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Ignore whitespace around colon in enhanced for loop.
- ignoreEnums - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Allow to ignore enums when left curly brace policy is EOL.
- ignoreEqualsIgnoreCase - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Control whether to ignore
String.equalsIgnoreCase(String)
invocations. - ignoreFieldDeclaration - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Ignore magic numbers in field declarations.
- ignoreFileNameExtensions - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Control whether to ignore the file extension for the file name match.
- ignoreFinal - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Allow to ignore variables with a 'final' modifier.
- ignoreFinal - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Allow to skip variables with
final
modifier. - ignoreFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Define the RegExp for names of variables and parameters to ignore.
- ignoreHashCodeMethod - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Ignore magic numbers in hashCode methods.
- ignoreInlineTags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Control whether inline tags must be ignored.
- ignoreLines - Variable in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
-
Specify the line numbers to ignore.
- ignoreMethodNamesRegex - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Ignore method whose names are matching specified regex.
- ignoreModifier - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Control whether to ignore checking for the
abstract
modifier on classes that match the name. - ignoreModifiers - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Control whether to ignore modifiers (fields, ...).
- ignoreName - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Control whether to ignore checking the name.
- ignoreNamePattern - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
Specify the regexp to define variable names to ignore.
- ignoreNumbers - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Specify non-magic numbers.
- ignoreOccurrenceContext - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
Specify token type names where duplicate strings are ignored even if they don't match ignoredStringsRegexp.
- ignoreOverridden - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
Allows to skip methods with Override annotation from validation.
- ignoreOverriddenMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Allow to ignore checking overridden methods (marked with
Override
orjava.lang.Override
annotation). - ignoreOverriddenMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Allow to ignore methods tagged with
@Override
annotation (that usually mean inherited name). - ignoreOverriddenMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Ignore number of parameters for methods with
@Override
annotation. - ignorePattern - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
-
Specify pattern for lines to ignore.
- ignorePrimitiveTypes - Variable in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Ignore primitive types as parameters.
- ignorePrivateMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Allow private methods to be ignored.
- ignoreSetter - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Allow to ignore the parameter of a property setter method.
- ignoreStatic - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Allow to skip variables with
static
modifier. - ignoreStaticFinal - Variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Allow to skip variables with both
static
andfinal
modifiers. - ignoreStringsRegexp - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
Specify RegExp for ignored strings (with quotation marks).
- ignoreUnnamedParameters - Variable in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Ignore unnamed parameters.
- ignoreVariablePattern - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Define RegExp to ignore distance calculation for variables listed in this pattern.
- ILLEGAL_TYPE_OF_TOKEN - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Message thrown with IllegalStateException.
- illegalAbstractClassNameFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Specify RegExp for illegal abstract class names.
- IllegalCatchCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that certain exception types do not appear in a
catch
statement. - IllegalCatchCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
- illegalClasses - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Specify class names to reject, if regexp property is not set, checks if import equals class name.
- illegalClassesRegexps - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
The compiled regular expressions for classes.
- illegalClassNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
-
Specify exception class names to reject.
- illegalClassNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Specify throw class names to reject.
- illegalClassNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Specify classes that should not be used as types in variable declarations, return values or parameters.
- IllegalIdentifierNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks identifiers with a pattern for a set of illegal names, such as those that are restricted or contextual keywords.
- IllegalIdentifierNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.IllegalIdentifierNameCheck
-
Creates a new
IllegalIdentifierNameCheck
instance. - IllegalImportCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Checks for imports from a set of illegal packages.
- IllegalImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Creates a new
IllegalImportCheck
instance. - IllegalInstantiationCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks for illegal instantiations where a factory method is preferred.
- IllegalInstantiationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
- illegalPattern - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Control whether the pattern is required or illegal.
- illegalPkgs - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Specify packages to reject, if regexp property is not set, checks if import is the part of package.
- illegalPkgsRegexps - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
The compiled regular expressions for packages.
- illegalShortClassNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Illegal short classes.
- IllegalThrowsCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that specified types are not declared to be thrown.
- IllegalThrowsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
- IllegalTokenCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks for illegal tokens.
- IllegalTokenCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
- IllegalTokenTextCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks specified tokens text for matching an illegal pattern.
- IllegalTokenTextCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
- IllegalTypeCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that particular classes or interfaces are never used.
- IllegalTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Creates new instance of the check.
- IMG_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Img tag name.
- IMG_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Img html tag.
- immutableClassCanonicalNames - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Specify immutable classes canonical names.
- immutableClassShortNames - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Set of immutable classes short names.
- IMPLEMENTS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An implements clause.
- IMPORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An import declaration.
- importAST - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Import AST.
- ImportControlCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Controls what can be imported in each package and file.
- ImportControlCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
- ImportControlLoader - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Responsible for loading the contents of an import control configuration file.
- ImportControlLoader() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Constructs an instance.
- ImportDetails(String, String, boolean, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Initialise importFullPath, importGroup, staticImport, importAST.
- importedClassPackages - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
A map of (imported class name -> class name with package) pairs.
- importFullPath - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Import full path.
- importGroup - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Import group.
- ImportHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for import statements.
- ImportHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ImportHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- ImportOrderCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Checks the ordering/grouping of imports.
- ImportOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
- ImportOrderOption - Enum in com.puppycrawl.tools.checkstyle.checks.imports
-
Represents the policy for checking import order statements.
- ImportOrderOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
- imports - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
The imports for the file.
- imports - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
-
Set of the imports.
- imports - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Set of the imports.
- importToGroupList - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Contains objects with import attributes.
- INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
++
(prefix increment) operator. - incompleteTag - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
If the tag is incomplete.
- incorrectIndentationLines - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Lines logged as having incorrect indentation.
- increment() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.Counter
-
Increments the counter.
- increment(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
-
Increments to counter by one for the supplied scope.
- INCREMENT_AND_DECREMENT_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
An array of increment and decrement tokens.
- INCREMENT_DECREMENT_VARIABLE_USAGE_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
An array of token types that indicate a variable is being used within an expression involving increment or decrement operators, or within a switch statement.
- incrementCurrentValue(BigInteger) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Increments the current value by a specified amount.
- indent - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Indentation amount for this handler.
- INDENT_LEVEL_10 - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
A newline with 10 spaces of indentation.
- INDENT_LEVEL_12 - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
A newline with 12 spaces of indentation.
- INDENT_LEVEL_14 - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
A newline with 14 spaces of indentation.
- INDENT_LEVEL_16 - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
A newline with 16 spaces of indentation.
- INDENT_LEVEL_18 - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
A newline with 18 spaces of indentation.
- INDENT_LEVEL_20 - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
A newline with 20 spaces of indentation.
- INDENTATION - Static variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Eight whitespace characters.
- IndentationCheck - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Checks correct indentation of Java code.
- IndentationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
- indentationLog(DetailAST, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Log a violation message.
- indentCheck - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
The instance of
IndentationCheck
using this handler. - indentCheck - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
-
The instance of
IndentationCheck
used by this class. - indentCheck - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
The current instance of
IndentationCheck
class using this handler. - indentCheck - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
-
The instance of
IndentationCheck
used by this class. - IndentLevel - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Encapsulates representation of notion of expected indentation levels.
- IndentLevel() - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Creates new instance with no acceptable indentation level.
- IndentLevel(int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Creates new instance with one acceptable indentation level.
- IndentLevel(IndentLevel, int...) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Creates new instance for nested structure.
- index - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Node index among parent's children.
- index - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseListIterator
-
Current index.
- INDEX_OP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The array index operator.
- indexAmongSiblings - Variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Represents index among siblings.
- IndexHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for array index operation.
- IndexHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.IndexHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- indexOfNonWhitespace(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Method to find the index of the first non-whitespace character in a string.
- INFLOW - com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
-
Represents the policy that static imports are processed like non static imports.
- influenceFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Specify negative/zero/positive value that defines the number of lines preceding/at/following the suppression comment.
- INFO - com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
Severity level info.
- inForHeader - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
The for-header usually has 3 statements on one line, but THIS IS OK.
- infoWriter - Variable in class com.puppycrawl.tools.checkstyle.DefaultLogger
-
Where to write info messages.
- INHERIT_DOC - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
{@inheritDoc}
. - INHERIT_DOC_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@inheritDoc' literal in {@inheritDoc} Javadoc inline tag.
- init() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Initialize the check.
- init() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
- init() - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
-
Initialise the instance.
- init() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
- init() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
- INITIAL_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
The initial current value.
- INITIAL_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
The initial current value.
- initialize(int, String) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Initializes this DetailAstImpl.
- initialize(String) - Static method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Initialize the scraper.
- initialize(Token) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Initializes this DetailAstImpl.
- initStringBuilderWithOptimalBuffer(AuditEvent, String) - Static method in class com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
-
Returns the StringBuilder that should avoid StringBuffer.expandCapacity.
- INLINE - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo.Type
-
Inline type.
- INLINE - com.puppycrawl.tools.checkstyle.utils.JavadocUtil.JavadocTagType
-
Inline type.
- INLINE_RETURN_TAG_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Specify the format for inline return Javadoc.
- INLINE_TAG_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Inline tag pattern.
- InlineTagUtil - Class in com.puppycrawl.tools.checkstyle.checks.javadoc.utils
-
Tools for extracting inline tags from Javadoc comments.
- InlineTagUtil() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Prevent instantiation.
- InnerAssignmentCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks for assignments in subexpressions, such as in
String s = Integer.toString(i = 2);
. - InnerAssignmentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
- innerClasses - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Keeps ClassDesc objects for all inner classes.
- InnerTypeLastCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Checks nested (internal) classes/interfaces are declared at the bottom of the primary (top-level) class after all init and static init blocks, method, constructor and field declarations.
- InnerTypeLastCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
- inPackageInfo() - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Deprecated.use
CheckUtil.isPackageInfo(String)
for the same functionality, or useAbstractCheck.getFilePath()
to process your own standards. - INPUT_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Input tag name.
- INPUT_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Input html tag.
- inputFile - Variable in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator.CliOptions
-
The command line positional parameter to specify the input file.
- insertChildrenNodes(JavadocNodeImpl[], ParseTree) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Creates child nodes for each node from 'nodes' array.
- insertParameter(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Insert a parameter at the topmost scope stack.
- insertVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Insert a variable at the topmost scope stack.
- INSTANCE - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.NeverSuppress
-
The shared instance.
- INSTANCE_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An instance initializer.
- instanceAndClassVarStack - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
A stack of type declaration's instance and static variables.
- instanceFields - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
-
Set of instance field names.
- instanceMembers - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Set of idents of instance members declared in this frame.
- instanceMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Set of idents of instance methods declared in this frame.
- instantiations - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
The instantiations in the file.
- instVarOrClassVar - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Is an instance variable or a class variable.
- INTERFACE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An interface declaration.
- InterfaceIsTypeCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Implements Joshua Bloch, Effective Java, Item 17 - Use Interfaces only to define types.
- InterfaceIsTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- InterfaceMemberImpliedModifierCheck - Class in com.puppycrawl.tools.checkstyle.checks.modifier
-
Checks for implicit modifiers on interface members and nested types.
- InterfaceMemberImpliedModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
- InterfaceTypeParameterNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that interface type parameter names conform to a specified pattern.
- InterfaceTypeParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.InterfaceTypeParameterNameCheck
-
Creates a new
InterfaceTypeParameterNameCheck
instance. - INTERNAL_MODULES - Static variable in class com.puppycrawl.tools.checkstyle.Definitions
-
Name of modules which are not checks, but are internal modules.
- InternalLoader() - Constructor for class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Creates a new InternalLoader.
- intersects(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.Comment
- intersects(int, int, int, int) - Method in interface com.puppycrawl.tools.checkstyle.api.TextBlock
-
Checks if this comment intersects with a specified part of the file.
- IntFilterElement - Interface in com.puppycrawl.tools.checkstyle.filters
-
An interface for filtering Integer.
- IntMatchFilterElement - Class in com.puppycrawl.tools.checkstyle.filters
-
This filter element is immutable and accepts a matching Integer.
- IntMatchFilterElement(int) - Constructor for class com.puppycrawl.tools.checkstyle.filters.IntMatchFilterElement
-
Constructs a MatchFilter for an int.
- IntRangeFilterElement - Class in com.puppycrawl.tools.checkstyle.filters
-
This filter element is immutable and accepts an Integer in a range.
- IntRangeFilterElement(int, int) - Constructor for class com.puppycrawl.tools.checkstyle.filters.IntRangeFilterElement
-
Constructs a
IntRangeFilterElement
with a lower bound and an upper bound for the range. - INVALID_CATCH_PARAM_IDENT_PARENTS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
-
Invalid parents of the catch parameter identifier.
- INVALID_LAMBDA_PARAM_IDENT_PARENTS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
-
Invalid parents of the lambda parameter identifier.
- InvalidJavadocPositionCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that Javadocs are located at the correct position.
- InvalidJavadocPositionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck
- InvalidJavadocTag - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Value object for storing data about an invalid Javadoc validTags.
- InvalidJavadocTag(int, int, String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
-
Creates an instance.
- invalidTags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
-
Invalid validTags.
- invertMap(Map<String, Integer>) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Inverts a given map by exchanging each entry's key and value.
- invoke() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Main method to gather statistics.
- invokeConstructor(Constructor<T>, Object...) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Returns new instance of a class.
- isAbstract(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
-
Returns true if given class is abstract or false.
- isAbstract(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Checks if declared class is abstract or not.
- isAcceptable(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Checks if given indentation is acceptable.
- isAcceptableStatement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
-
Check if the statement is an acceptable statement inside the case block.
- isAcceptableToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks whether AcceptableTokens contains the given ast.
- isAfter(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.TokenEnd
-
Checks if saved coordinates located after given token.
- isAfterMethodReference(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Checks if current generic end ('>') is located after
method reference operator
. - isAllCharactersEscaped(String) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Checks if all characters in String literal is escaped.
- isAllowedPublicField(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks whether the variable satisfies the public field check.
- isAllowedTag(HtmlTag) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Determines if the HtmlTag is one which is allowed in a javadoc.
- isAloneOnLine(RightCurlyCheck.Details, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Checks whether right curly is alone on a line.
- isAlphabeticalOrderBroken(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Examine alphabetical order of imports.
- isAnnotatedByIgnoredAnnotations(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Checks if method or constructor is annotated by ignored annotation(s).
- isAnnotatedWithSafeVarargs(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Checks if method definition is annotated with.
- isAnnotationOnType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
-
Checks whether annotation on type takes place.
- isAnonymousClassDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Whether the AST is a definition of an anonymous class.
- isAnonymousClassVariable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks if current variable definition is definition of an anonymous class.
- isAnonymousInnerClassEnd(int, char) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Check for "})" or "};" or "},".
- isAnotherTagBefore(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
-
Returns true when there is a javadoc tag before the provided tagNode.
- isArrayTypeDeclaration(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.api.FullIdent
-
Checks an `ARRAY_DECLARATOR` ast to verify that it is not an array initialization, i.e.
- isAssignOperator(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Is Arithmetic operator.
- isAssignToken(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Check that token is related to assign tokens.
- isAssignToVariable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Checks if a node is
TokenTypes.ASSIGN
to a variable or resource. - isAstInside(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks if the given
ast
is equal to thetree
or a child of it. - isAstSimilar(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks if 2 AST are similar by their type and text.
- isAuditListener(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as the checkstyle audit listener module.
- isBeforeInSource(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Retrieves whether ast1 is located before ast2.
- isBitWiseBinaryOrConditionalOrRelationalOperator(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Check if token type is bitwise binary or conditional or relational operator.
- isBlank(int...) - Static method in class com.puppycrawl.tools.checkstyle.utils.CodePointUtil
-
Checks if given code point array is blank by either being empty, or contains only whitespace characters.
- isBlank(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Checks if the value arg is blank by either being null, empty, or contains only whitespace characters.
- isBlockAloneOnSingleLine(RightCurlyCheck.Details) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Checks whether block has a single-line format and is alone on a line.
- isBlockCommentEnd(int[], int) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Checks if the
line
atcolumnNo
is the end of a comment, '*/'. - isBlockStart(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Whether the AST node starts a block.
- isBooleanLiteralReturnOrYieldStatement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
-
Returns if an AST is a return or a yield statement with a boolean literal.
- isBooleanLiteralType(int) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Checks if a token type is a literal true or false.
- isBracesNeeded(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if token needs braces.
- isCalledOnStringFieldOrVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Determine, whether equals method is called on a field of String type.
- isCallingSuper() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck.MethodNode
-
Determines whether the overriding method has a call to the super method.
- isCanonicalName(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks whether type definition is in canonical form.
- isCaseTokenWithAnotherCaseFollowing(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
If token is CASE_GROUP or SWITCH_RULE and there is another
case
following. - isCatchParameterIdentifierCandidate(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
-
Visit ast of type
TokenTypes.IDENT
and check if it is a candidate for a catch parameter identifier. - isCellEditable(int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
-
Indicates whether the value for node
node
, at column numbercolumn
is editable. - isCellEditable(int) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Indicates whether the value for node
node
, at column numbercolumn
is editable. - isCellEditable(int, int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
- isCellEditable(EventObject) - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
- isCellEditable(EventObject) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable.TreeTableCellEditor
-
Overridden to return false, and if the event is a mouse event it is forwarded to the tree.
- isChainedMethodCallWrapped() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
-
If this is the first chained method call which was moved to the next line.
- isCharacterValidAfterGenericEnd(char) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Checks whether given character is valid to be right after generic ends.
- isCheckedMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Returns true if method has to be checked or false.
- isChecking() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.Context
-
Getter for checking property.
- isCheckMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
Checks whether
AuditEvent
source name matches the check pattern. - isCheckMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Checks whether
AuditEvent
source name matches the check format. - isCheckMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Checks whether
TreeWalkerAuditEvent
source name matches the check format. - isCheckMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
Checks whether
TreeWalkerAuditEvent
source name matches the check format. - isCheckstyleModule(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as a checkstyle module.
- isCheckstyleTreeWalkerCheck(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as the checkstyle check which has TreeWalker as a parent.
- isChild(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Checks if Ast node contains given element.
- isChildNodeTextMatches(DetailNode, Pattern) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Checks whether the first child
JavadocTokenType.TEXT
node matches given pattern. - isChildOf(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Determines if the given AST node has a parent node with given token type code.
- isClassFieldDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Determines whether a node is a class field definition.
- isClassMemberBlock(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Whether the AST is a class member block.
- isClassNamesSame(String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Check that class names are same by short name of class.
- isClassOrEnumOrRecordDef() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Getter for classOrEnumOrRecordDef.
- isClassProtected(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Checks if given class ast has protected modifier.
- isClassPublic(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Checks if given class is accessible from "public" scope.
- isClosedTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Indicates if this tag is a self-closed XHTML style.
- isCloseTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Indicates if this tag is a close (end) tag.
- isCodePointWhitespace(int[], int) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Converts the Unicode code point at index
index
to it's UTF-16 representation, then checks if the character is whitespace. - isColonFromLabel(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Checks if a node is
TokenTypes.COLON
from a label, switch case of default. - isComment(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Whether the ast is a comment.
- isCommentAtTheEndOfTheCodeBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether a comment is placed at the end of the code block.
- isCommentForMultiblock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Whether the comment might have been used for the next block in a multi-block structure.
- isCommentInBeginningOfLine(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Check if token is comment, which starting in beginning of line.
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Whether comment nodes are required or not.
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Defined final because all JavadocChecks require comment nodes.
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
- isCommentNodesRequired() - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
- isCommentOrInlineTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
-
Checks if the node can contain an unescaped block tag without violation.
- isCommentTag(String[], TagParser.Point) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
If this is a HTML-comments.
- isCommentType(int) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Is argument comment-related type (SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN, BLOCK_COMMENT_END, COMMENT_CONTENT).
- isCommentType(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Is argument comment-related type name (SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN, BLOCK_COMMENT_END, COMMENT_CONTENT).
- isComparison(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
-
Checks if an AST is a comparison operator.
- isCompoundAssignToken(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Check that token is related to compound assign tokens.
- isConstructor(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck
-
Check if the given AST is a constructor.
- isContainerNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
-
Check if the node is of type ctor (compact or canonical), instance/ static initializer, method definition or lambda.
- isContainVerifiableType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks is modifiers contain verifiable type.
- isContentsAllowMissingJavadoc(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Checks if the Javadoc can be missing if the method or constructor is below the minimum line count or has a special annotation.
- isCorrectJavadocPosition(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Checks Javadoc comment it's in right place.
- isCorrectLocation(DetailAST, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Checks whether an annotation has a correct location.
- isCountable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Checks if a token is countable for the ncss metric.
- isDeclarationToken(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Check that token is related to Definition tokens.
- isDeclaredAsAbstract() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Is class declared as abstract.
- isDeclaredAsFinal() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Is class declared as final.
- isDeclaredAsPrivate() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Does class is private.
- isDefinedFirst(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Whether the
{@summary}
tag is defined first in the javadoc. - isDefinition(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Whether the statement is a kind of definition (method, class etc.).
- isDistributedExpression(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether the previous statement of a comment is a method call chain or string concatenation statement distributed over two or more lines.
- isDistributedPreviousStatement(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether the previous statement of a comment is distributed over two or more lines.
- isDistributedReturnStatement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether the previous statement of a comment is a distributed return statement.
- isDistributedThrowStatement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether the previous statement of a comment is a distributed throw statement.
- isElse(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
-
Returns whether a token represents an ELSE.
- isElseIf(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
-
Returns whether a token represents an ELSE as part of an ELSE / IF set.
- isElseWithCurlyBraces(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
-
Returns whether a token represents an SLIST as part of an ELSE statement.
- isEmbeddedIn(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
-
Check if current frame is embedded in class or enum with specific name.
- isEmpty() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
-
Check if this set of ast is empty.
- isEmptyBlock(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Is empty block.
- isEmptyBlock(DetailAST, int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Tests if a given
DetailAST
is part of an empty block. - isEmptyCatch(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Tests if the given
DetailAst
is part of an allowed empty catch block. - isEmptyCatchBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
Checks if catch block is empty or contains only comments.
- isEmptyConfig - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Indicates if all properties are set to null.
- isEmptyCtorBlockCheckedFromRcurly(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Test if the given
DetailAST
is part of an allowed empty constructor (ctor) block checked from RCURLY. - isEmptyCtorBlockCheckedFromSlist(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Test if the given
DetailAST
is a part of an allowed empty constructor checked from SLIST token. - isEmptyLambda(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Test if the given
DetailAST
is part of an allowed empty lambda block. - isEmptyLine(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Determines whether or not the line is empty line.
- isEmptyLineMissed(CustomImportOrderCheck.ImportDetails, CustomImportOrderCheck.ImportDetails) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Examine empty lines between groups.
- isEmptyLoop(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Checks if loop is empty.
- isEmptyLoopBodyAllowed(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current loop has empty body and can be skipped by this check.
- isEmptyMethodBlock(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Test if the given
DetailAST
is part of an allowed empty method block. - isEmptySwitchBlockStatement(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Tests if the given
DetailAst
is part of an allowed empty switch case or default block. - isEmptyTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck
-
Tests if block tag is empty.
- isEmptyType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Test if the given
DetailAST
is part of an empty block. - isEndOfDescription(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil.DescriptionExtractor
-
Determines if the given child index is the end of the description.
- isEndOfEnumerationAfter(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck
-
Checks if enum body has no code elements after enum constants semicolon.
- isEndOfLineModeViolation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Checks whether operator violates
WrapOption.EOL
mode. - isEndOfScope(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Checks line for end of scope.
- isEnumMember(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Checks if current AST node is member of Enum.
- isEqualsMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
-
Determines if an AST is a valid Equals method implementation.
- isEqualsMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Tests whether a method definition AST defines an equals covariant.
- isExamplesText(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Checks whether the paragraph node corresponds to the example section.
- isExceptionInfoSame(JavadocMethodCheck.ExceptionInfo, JavadocMethodCheck.ExceptionInfo) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Check that ExceptionInfo objects are same by name.
- isExcludedClassRegexp(String) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
-
Checks if given class should be ignored as it belongs to excluded class regexp.
- isExempt(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
-
Checks if a class or static member is exempt from known excludes.
- isExpressionCountable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Checks if an expression is countable for the ncss metric.
- isExprSurrounded(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Tests if the given expression node is surrounded by parentheses.
- isExtendedClassNamedAsException(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
Checks that if extended class name conforms to specified format.
- isExtraHtml(String, Deque<HtmlTag>) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Determines if the given token is an extra HTML tag.
- isFallThroughComment(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether comment is a 'fall through' comment.
- isFieldDeclaration(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Determines whether or not the given AST is field declaration.
- isFileExists(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.FilterUtil
-
Checks if suppression source with given fileName exists.
- isFileFilterModule(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as the checkstyle file filter.
- isFileNameAndModuleAndModuleNameMatching(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Is matching by file name, module id and Check name.
- isFileNameAndModuleNameMatching(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Is matching by file name, module id, and Check name.
- isFileSetModule(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as the checkstyle file set.
- isFilterModule(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as the checkstyle filter.
- isFinalField(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks whether current field is final.
- isFirstChild(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Whether the ast is the first child of its parent.
- isFirstInLine(int[], int) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Checks if the
line
up to and includingcolumnNo
is all non-whitespace text encountered. - isFirstParagraph(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Determines whether or not the line with paragraph tag is first line in javadoc.
- isFirstParameterObject(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
-
Tests whether a method's first parameter is an Object.
- isFollowedByWhitespace(DetailAST, int...) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
-
Checks whether token is followed by a whitespace.
- isFollowsEmptyForIterator(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks that a token follows an empty for iterator.
- isForceStrictCondition() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Getter to query strict indent level in line wrapping case.
- isForLoopVariable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
-
Checks if a variable is the loop's one.
- isForwardReference(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Checks whether an identifier references a field which has been already defined in class.
- isFound() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
-
Checks that the exception has throws tag associated with it.
- isFromExcludedPackage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
-
Checks if given class should be ignored as it belongs to excluded package.
- isFromPackage(String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
-
Determines if an import statement is for types from a specified package.
- isGenericAfterNew(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Checks if generic is after
LITERAL_NEW
. - isGenericBeforeCtorInvocation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Checks if generic is before constructor invocation.
- isGenericBeforeMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Is generic before method reference.
- isGenericBeforeRecordHeader(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Checks if generic is before record header.
- isGetterMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Returns whether an AST represents a getter method.
- isGlobalProperty(Class<?>, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Checks if the property is a global property.
- isGreaterThan(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Returns true if indent less than minimal of acceptable indentation levels, false otherwise.
- isHandledType(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
-
Returns true if this type (form TokenTypes) is handled.
- isHasDeclaredConstructor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Does class have implicit constructor.
- isHasDefaultCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Getter.
- isHashCodeMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
-
Determines if an AST is a valid HashCode method implementation.
- isHasNonPrivateStaticMethodOrField() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Getter.
- isHasNonStaticMethodOrField() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Getter.
- isHasPublicCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.Details
-
Getter.
- isId() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns boolean.
- isIdentifier(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Checks whether the given string is a valid identifier.
- isIdMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
Checks whether the
AuditEvent
module ID matches the ID pattern. - isIdMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Checks whether the
AuditEvent
module ID matches the ID format. - isIdMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Checks whether the
TreeWalkerAuditEvent
module ID matches the ID format. - isIdMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
Checks whether the
TreeWalkerAuditEvent
module ID matches the ID format. - isIdref() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns boolean.
- isIfAfterElse() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IfHandler
-
Determines if this 'if' statement is part of an 'else' clause and on the same line.
- isIgnorableMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Checks if current method is ignorable due to Check's properties.
- isIgnore(int, FileText, LineColumn, Matcher) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Detect ignore situation.
- isIgnored(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
Decides whether the variable name of an AST is in the ignore list.
- isIgnoredConstructorParam(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Decides whether to ignore an AST node that is the parameter of a constructor.
- isIgnoredOverriddenMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Checks if method is overridden and should be ignored.
- isIgnoredParam(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Checks whether method or constructor parameter is ignored.
- isIgnoredParamOfAbstractMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Decides whether to ignore an AST node that is the parameter of an abstract method.
- isIgnoredPrimitiveParam(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Checks for skip current param due to ignorePrimitiveTypes option.
- isIgnoredPublicMember(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks whether variable belongs to public members that should be ignored.
- isIgnoredSetterParam(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Decides whether to ignore an AST node that is the parameter of a setter method, where the property setter method for field 'xyz' has name 'setXyz', one parameter named 'xyz', and return type void (default behavior) or return type is name of the class in which such method is declared (allowed only if
HiddenFieldCheck.setSetterCanReturnItsClass(boolean)
is called with value true). - isIgnoredUnnamedParam(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Checks for skip current param due to ignoreUnnamedParameters option.
- isIgnoreLine(int) - Method in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
-
Returns true if lineNo is header lines or false.
- isIgnoreSituation(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Checks if it is an ignore situation.
- isIllegalImport(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Checks if an import is from a package or class name that must not be used.
- isIllegalImportByPackagesAndClassNames(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Checks if an import is from a package or class name that must not be used.
- isIllegalImportByRegularExpressions(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Checks if an import matches one of the regular expressions for illegal packages or illegal class names.
- isImmediatelyFollowedByNewLine(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Tests whether the paragraph tag is immediately followed by the new line.
- isImmediatelyFollowedByText(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Tests whether the paragraph tag is immediately followed by the text.
- isImmutableField(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks if current field is immutable: has final modifier and either a primitive type or instance of class known to be immutable (such as String, ImmutableCollection from Guava, etc.).
- isImmutableFieldDefinedInFinalClass(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks whether immutable field is defined in final class.
- isIn(Scope) - Method in enum com.puppycrawl.tools.checkstyle.api.Scope
-
Checks if this scope is a subscope of another scope.
- isInAbstractOrNativeMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Determines whether an AST is a descendant of an abstract or native method.
- isInAnnotationBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is directly contained within an annotation block.
- isInBlockOf(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is directly contained within a specified block.
- isInCache(String, long) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Checks that file is in cache.
- isInClassBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is directly contained within a class block.
- isInCodeBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether the scope of a node is restricted to a code block.
- isInCompactConstructor(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Return whether ast is in a COMPACT_CTOR_DEF.
- isIncompleteTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
Indicates if this tag is incomplete (has no close >).
- isInContext(DetailAST, int[][], BitSet) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
-
Tests whether the provided AST is in one of the given contexts.
- isIncrementOrDecrementVariableUsed(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
A variable with increment or decrement operator is considered used if it is used as an argument or as an array index or for assigning value to a variable.
- ISINDEX_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Isindex tag name.
- ISINDEX_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Isindex html tag.
- isInEmptyCaseBlock(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether case block is empty.
- isInEmptyCodeBlock(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether comment is placed in the empty code block.
- isInEmptyForInitializerOrCondition(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
-
Checks that semicolon is in empty for initializer or condition.
- isInEnumBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is directly contained within an enum block.
- isInExpression(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks ast parent is in expression.
- isInHashCodeMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Determines whether or not the given AST is in a valid hash code method.
- isInheritDocTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Checks that the tag is a 'inheritDoc' tag.
- isInIgnoreBlock(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Checks if a 'throw' usage is contained within a block that should be ignored.
- isInIgnoreList(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Decides whether the number of an AST is in the ignore list of this check.
- isInIgnoreOccurrenceContext(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
Analyses the path from the AST root to a given AST for occurrences of the token types in
MultipleStringLiteralsCheck.ignoreOccurrenceContext
. - isInInterfaceBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is directly contained within an interface block.
- isInInterfaceOrAnnotationBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is directly contained within an interface or annotation block.
- isInitializationSequence(DetailAST, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Processes statements until usage of variable to detect sequence of initialization methods.
- isInitialized(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Check if VARIABLE_DEF is initialized or not.
- isInLambda - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Holds if current token is inside lambda.
- isInLambda(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Check if current param is lambda's param.
- isInLatestScopeDefinition(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Checks if there is a scope definition to check and that the method is found inside that scope (class, enum, etc.).
- isInlineDescription(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
-
Checks, if description node is a description of in-line tag.
- isInlineReturnTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks if the first tag inside ast is
{@return}
tag. - isInlineTagPresent(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks if the inline tag node is present.
- isInlineTagWithName(DetailNode, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks if the first tag inside ast is a tag with the given name.
- isInLoopIdiom(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
-
Tests whether the given AST is used in the "assignment in loop" idiom.
- isInNoBraceControlStatement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
-
Determines if ast is in the body of a flow control statement without braces.
- isInPatternDefinition(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Ascends AST to determine if given node is part of a pattern definition.
- isInPrivateMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Checks if method, which throws an exception is private.
- isInRecordBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is directly contained within a record block.
- isInScope(DetailAST, Scope) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Checks whether ast node is in a specific scope.
- isInScopeOfSuppression(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
Checks whether the
AuditEvent
is in the scope of the suppression. - isInScopeOfSuppression(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Checks whether
AuditEvent
is in the scope of the suppression. - isInScopeOfSuppression(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
Checks whether the
TreeWalkerAuditEvent
is in the scope of the suppression. - isInsideConstructorFrame(RequireThisCheck.AbstractFrame) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks whether a field usage frame is inside constructor frame.
- isInsideLocalAnonInnerClass(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Whether ast node of type
TokenTypes.LITERAL_NEW
is a part of a local anonymous inner class. - isInSpecificCodeBlocks(DetailAST, int...) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Checks whether the scope of a node is restricted to a specific code blocks.
- isInstanceField(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Check for instance field.
- isInStatic(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Determines whether an AST node is in a static method or static initializer.
- isInstVarOrClassVar() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Is an instance variable or a class variable.
- isInSwitch(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
Checks if the colon is inside a switch block.
- isInSwitchRule(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current ast's parent is a switch rule, e.g.:
- isInterfaceDeclaration(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Check that variable definition in interface or @interface definition.
- isInterfaceOrAnnotationMember(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Checks if current AST node is member of Interface or Annotation, not of their subnodes.
- isInTypeBlock(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Checks if ast is in a class, enum, anon class or record block.
- isInTypecast(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks whether
TokenTypes.RPAREN
is a closing paren of aTokenTypes.TYPECAST
. - isJavadoc(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
-
Checks that ast is a javadoc comment.
- isJavadocComment(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Checks block comment content starts with '*' javadoc comment identifier.
- isJavadocComment(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Checks that commentContent starts with '*' javadoc comment identifier.
- isLambdaCorrectlyIndented - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.LambdaHandler
-
Checks whether the lambda is correctly indented, this variable get its value from checking the lambda handler's indentation, and it is being used in aligning the lambda's children.
- isLambdaParameter(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks if the token is a Lambda parameter.
- isLambdaParameterIdentifierCandidate(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
-
Visit ast of type
TokenTypes.IDENT
and check if it is a candidate for a lambda parameter identifier. - isLambdaSingleParameterSurrounded(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Tests if the given node has a single parameter, no defined type, and is surrounded by parentheses.
- isLast(int, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck
-
Checks if the character position is the last one of the string.
- isLastLine(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
-
Checks whether this node is the end of a Javadoc comment, optionally preceded by blank text.
- isLeadingAsterisk(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
-
Checks whether the given node is a leading asterisk.
- isLeaf(Object) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
- isLeaf(Object) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Whether the node is a leaf.
- isLeftHandOfAssignment(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
-
Check if the given
TokenTypes.IDENT
is a left hand side value. - isLeftHandOfAssignment(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
-
Check if the given
TokenTypes.IDENT
is a left hand side value. - isLeftHandSideValue(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Checks whether the ast of type
TokenTypes.IDENT
is used as left-hand side value. - isLegalCommentContent(String) - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
-
Checks if given comment content is legal.
- isLineAndColumnMatching(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Whether line and column match.
- isLineEmptyAfterPackage(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Checks if there is another element at next line of package declaration.
- isLocalOnly() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
-
Return true if the guard is to only be applied locally or false.
- isLocalVariableDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Determines whether a node is a local variable definition.
- isLoggable(LogRecord) - Method in class com.puppycrawl.tools.checkstyle.Main.OnlyCheckstyleLoggersFilter
-
Returns whether the specified logRecord should be logged.
- isLoopAst(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Checks whether the ast is a loop.
- isMagicNumberExists(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Is magic number somewhere at ast tree.
- isMatch(int, String) - Method in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
-
Checks if a code line matches the required header line.
- isMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
Determines whether the source of an audit event matches the text of this suppression.
- isMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Checks whether the suppression matches the given
AuditEvent
. - isMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Determines whether the source of an audit event matches the text of this tag.
- isMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
Determines whether the source of an audit event matches the text of this tag.
- isMatch(String, int) - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
Checks if a code line matches the required header line.
- isMatchFile(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Checks if the given
fileName
matches the specifiedRegexpOnFilenameCheck.fileNamePattern
. - isMatchFolder(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Checks if the given
folderPath
matches the specifiedRegexpOnFilenameCheck.folderPattern
. - isMatchingByLineAndColumnAndTokenType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Checks if the given
DetailAST
node is matching line number, column number and token type. - isMatchingClassName(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Returns true if given class name is one of illegal classes or else false.
- isMatchingClassName(String) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Returns true if class name matches format of abstract class names.
- isMatchingRegexp(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Check name by regExp.
- isMessageMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
Checks whether the
AuditEvent
message matches the message pattern. - isMessageMatch(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Checks whether the
AuditEvent
message matches the message format. - isMessageMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Checks whether the
TreeWalkerAuditEvent
message matches the message format. - isMessageMatch(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
Checks whether the
TreeWalkerAuditEvent
message matches the message format. - isMessageNameMatching(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Is matching by message.
- isMessageNameMatching(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Is matching by message.
- isMethodInvocation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
-
Check if the given
TokenTypes.IDENT
is a child of a dot operator and is a candidate for catch parameter. - isMethodInvocation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
-
Check if the given
TokenTypes.IDENT
is a child of a dot operator and is a candidate for lambda parameter. - isMethodModifier(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.SynchronizedHandler
-
Checks if given synchronized is modifier of method.
- isMethodOfScrapedModule(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Checks if the given method is a method of the module being scraped.
- isMethodOrCtorOrInitDefinition(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Checks if a token is a method, constructor, or compact constructor definition.
- isMissingJavadocAllowed(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Checks if a missing Javadoc is allowed by the check's configuration.
- isMultiLevel() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Checks whether we have more than one level.
- isMultiLine(int) - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
Returns true if line is multiline header lines or false.
- isMultilineComment(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
-
Checks if a DetailAST of type
TokenTypes.BLOCK_COMMENT_BEGIN
span more than one line. - isMultipleTypeCatch(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Check if given parameter definition is a multiple type catch.
- isName(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Checks whether the given string is a valid name.
- isNamedAsException(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
Checks that a class name conforms to specified format.
- isNativeMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Checks whether a method is native.
- isNestedParagraph(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Determines whether the paragraph tag is nested.
- isNewLineModeViolation(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Checks whether operator violates
WrapOption.NL
mode. - isNextSiblingOf(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
-
Return true only if passed tokenType in argument is found or returns false.
- isNilled() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns boolean.
- isNonAcceptableIndent(int, IndentLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LambdaHandler
-
Checks that given indent is acceptable or not.
- isNonLocalTypeDeclaration(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Whether a type declaration is non-local.
- isNonTight() - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
This method is used to check if the javadoc parsed has non-tight HTML tags.
- isNonVoidMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Checks whether a method is a not void one.
- isNotRelevantSituation(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Is ast not a target of Check.
- isNotXpathFileGenerator(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class is
XpathFileGeneratorAstFilter
orXpathFileGeneratorAuditListener
. - isNumericType(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
Determine if a given type is a numeric type.
- isObjectParam(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
-
Determines if an AST is a formal param of type Object.
- isOfType(int, int...) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Determines if the token type belongs to the given types.
- isOfType(int, Set<Integer>) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Determines if the token type belongs to the given types.
- isOfType(DetailAST, int...) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Determines if the AST belongs to the given types.
- isOnAnnotationDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on annotation definition.
- isOnAnnotationField(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on annotation field declaration.
- isOnClass(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on class definition.
- isOnCompactConstructor(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on compact constructor, note that we don't need to check for a plain token here, since a compact constructor must be public.
- isOnConstructor(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on constructor.
- isOnDifferentLineWithPreviousToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
Checks if the colon is on same line as of case or default.
- isOnEnum(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on enum definition.
- isOnEnumConstant(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on enum constant.
- isOnField(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on field declaration.
- isOnInterface(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on interface definition.
- isOnlyTagInWholeJavadoc(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
-
Returns true when there are is only whitespace and asterisks before the provided tagNode.
- isOnlyUnicodeValidChars(String, Pattern) - Static method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Check if String literal contains Unicode control chars.
- isOnMember(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on type member declaration.
- isOnMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on method declaration.
- isOnPackage(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on package definition.
- isOnPlainClassMember(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Checks that block comment is on specified class member without any modifiers.
- isOnPlainToken(DetailAST, int, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Checks that block comment is on specified token without any modifiers.
- isOnPreviousLineIgnoringComments(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether the checked statement is on the previous line ignoring empty lines and lines which contain only comments.
- isOnRecord(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on record definition.
- isOnStartOfLine(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Determines if the given expression is at the start of a line.
- isOnTheSameLine(DetailAST, int, int, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Checks whether two statements are on the same line.
- isOnTokenWithAnnotation(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Checks that block comment is on specified token with annotation.
- isOnTokenWithModifiers(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Checks that block comment is on specified token with modifiers.
- isOnType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
-
Node is on type definition.
- isOuterMostType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Returns whether a node is contained in the outermost type block.
- isOverlappingByArgument(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks whether an overlapping by method or constructor argument takes place.
- isOverlappingByLocalVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks whether an overlapping by local variable takes place.
- isOverriddenMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
Checks whether a method is annotated with Override annotation.
- isOverriding(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Check if a method has annotation @Override.
- isOverridingMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
Determines whether an AST is a method definition for this check, without any parameters.
- isPackageInfo(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Checks if the given file path is a package-info.java file.
- isParameterized(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Checks whether an annotation has parameters.
- isParamTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Checks that the tag is an 'param' tag.
- isParentContainsTokenType(DetailAST, int) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Checks that some parent of given node contains given token type.
- isParentText(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Checks whether the
JavadocTokenType.PARAGRAPH
node is referring to the parent javadoc segment. - isPartOfDoubleBraceInitializerForNextToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Check if given ast is part of double brace initializer and if it should omit checking if next token is separated by whitespace.
- isPartOfDoubleBraceInitializerForPreviousToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Check if given ast is part of double brace initializer and if it should omit checking if previous token is separated by whitespace.
- isPassedInParameter(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Checks if logical operator is part of constructor or method call.
- isPathExcluded(String, Iterable<Pattern>) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Checks if a directory/file
path
should be excluded based on if it matches one of the patterns supplied. - isPatternValid(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Validates whether passed string is a valid pattern or not.
- isPipeOperator(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Checks if
binary OR
is applied to exceptions in multi-catch (pipe-syntax). - isPrecededByJavadoc(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Check if token is preceded by javadoc comment.
- isPrecedingEmptyForInit(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks that a token precedes an empty for initializer.
- isPrePreviousLineEmpty(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Checks if a token has empty pre-previous line.
- isPrimitive(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks if current type is primitive type (int, short, float, boolean, double, etc.).
- isPrivateInstanceVariable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Whether instance variable or class variable have private access modifier.
- isProperDefinition(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Whether the definition is correspondent to the IDENT.
- isProperDefinition(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
- isPropertyList(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Checks whether the list item node is part of a property list.
- isPublic(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
-
Checks if a type is public.
- isPublic(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
-
Checks if given modifiers has public access.
- isPublicStaticFinalIntField(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
Checks that the DetailAST is a
public
static
final
int
field. - isQualifiedIdentifier(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Checks whether ast is a fully qualified identifier.
- isReceiverParameter(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Checks whether a parameter is a receiver.
- isReference(String) - Static method in class com.puppycrawl.tools.checkstyle.XMLLogger
-
Finds whether the given argument is character or entity reference.
- isReferencedType(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
-
Checks whether this type name is used in this frame.
- isRegExp() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
-
Return true if the name is to be interpreted as a regular expression or false.
- isReloadActionEnabled() - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Returns true if the reload action is enabled, false otherwise.
- isResource(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Checks that given node is a resource.
- isResourceChanged(PropertyCacheFile.ExternalResource) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Checks whether the resource is changed.
- isResourceLocationInCache(String) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Checks whether resource location is in cache.
- isReturnedVariable(RequireThisCheck.AbstractFrame, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks whether the current variable is returned from the method.
- isReturnTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Checks that the tag is an 'return' tag.
- isRightcurlyFollowedBySemicolon(RightCurlyCheck.Details) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Checks whether the right curly is followed by a semicolon.
- isRootModule(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as the checkstyle root module.
- isRootNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Determines if given AST is a root node, i.e. if the type of the token we are checking is
COMPILATION_UNIT
. - isSameLineCaseGroup() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
-
Checks if SLIST node is placed at the same line as CASE_GROUP node.
- isSameNameMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
Is same name of method.
- isSameNodeInfo(NodeInfo) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns true if nodes are same, false otherwise.
- isSamePackage(String, int, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Check that type is of the same package.
- isSameVariables(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Check if both the Variables are same.
- isSeeOrInheritDocTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Checks that the tag is a 'see' or 'inheritDoc' tag.
- isSemicolon(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
-
Checks that
ast
is a semicolon. - isSeparatedByExtraEmptyLine(CustomImportOrderCheck.ImportDetails, CustomImportOrderCheck.ImportDetails) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Examine that imports separated by more than one empty line.
- isSeparatorBeforeImport(int) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Checks whether there is any separator before current import.
- isSeparatorInGroup(int, boolean, int) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Checks whether imports group separated internally.
- isSetterMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Returns whether an AST represents a setter method.
- isSetterMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Returns whether an AST represents a setter method.
- isSetterMethod(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Determine if a specific method identified by methodAST and a single variable name aName is a setter.
- isSignificant(String) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
-
Checks if given class shouldn't be ignored and not from java.lang.
- isSimilarSignature(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Whether the method definition has the same name and number of parameters.
- isSingleIfWithNoElse(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
-
Check if the case block statement is a single if statement with no else branch.
- isSingleLineCaseGroup(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if switch member in case group (case or default statement) is single-line statement, e.g.:
- isSingleLineDoWhile(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current do-while statement is single-line statement, e.g.:
- isSingleLineElse(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current else statement is single-line statement, e.g.:
- isSingleLineFor(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current for statement is single-line statement, e.g.:
- isSingleLineIf(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current if statement is single-line statement, e.g.:
- isSingleLineJavadoc(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Checks if comment is single-line comment.
- isSingleLineLambda(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current lambda statement is single-line statement, e.g.:
- isSingleLineStatement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current statement is single-line statement, e.g.:
- isSingleLineSwitchMember(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if switch member (case or default statement) in a switch rule or case group is on a single-line.
- isSingleLineSwitchRule(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if switch member in switch rule (case or default statement) is single-line statement, e.g.:
- isSingleLineWhile(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current while statement is single-line statement, e.g.:
- isSingleSpace(int[], int) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Checks if the
line
atcolumnNo
is a single space, and not preceded by another space. - isSingleTag(HtmlTag) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Determines if the HtmlTag is one which does not require a close tag.
- isSkipCase(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
Checks for cases that should be skipped: no assignment, local variable, final variables.
- isSkipStatement(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Checks if current statement can be skipped by "need braces" warning.
- isSpace(int[], int) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Checks if the
line
atcolumnNo
is a space. - isStandAloneIncrementOrDecrement(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Checks whether the ast of type
TokenTypes.IDENT
is used as an operand of a stand-alone increment or decrement. - isStandardClass(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Is Standard Class.
- isStarImport(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks if current import is star import.
- isStarImport(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks if current import is star import.
- isStarImportOfPackage(String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
-
Returns true if classOrStaticMember is a starred name of package, not just member name.
- isStatementWithPossibleCurlies(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Whether the statement can have or always have curly brackets.
- isStatic(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
-
Returns true if given class is static or false.
- isStaticFinalVariable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks whether variable has static final modifiers.
- isStaticImport() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Checks if import is static.
- isStreamed() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns boolean.
- isStringFieldOrVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Whether the field or the variable is of String type.
- isStringFieldOrVariableFromClass(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Whether the field or the variable from the specified class is of String type.
- isStringFieldOrVariableFromThisInstance(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Whether the field or the variable from THIS instance is of String type.
- isStringType(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
Whether the type is java.lang.String.
- isSummaryTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks if the javadoc inline tag is
{@summary}
tag. - isSuperCall(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
Determines whether a 'super' literal is a call to the super method for this check.
- isSuperCallInOverridingMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
Determines whether a super call in overriding method.
- isSuperClassOfAnonymousInnerClass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Whether the class is the super class of an anonymous inner class.
- isSuppressed(AuditEvent) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Checks for a suppression of a check with the given source name and location in the last file processed.
- isSuppressedAfterEventStart(int, int, SuppressWarningsHolder.Entry) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Checks whether suppression entry position is after the audit event occurrence position in the source file.
- isSuppressedBeforeEventEnd(int, int, SuppressWarningsHolder.Entry) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Checks whether suppression entry position is before the audit event occurrence position in the source file.
- isSurrounded(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Tests if the given
DetailAST
is surrounded by parentheses. - isSwitchExpression(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Check whether switch is expression or not.
- isSwitchExpression(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
-
Checks if this LITERAL_SWITCH token is part of a switch expression.
- isTag(String[], TagParser.Point) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Checks if the given position is start one for HTML tag.
- isTagIgnored(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Checks if list of ignored tags contains javadocTagSection's javadoc tag.
- isTargetNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Filters some false tokens that this check should ignore.
- isTerminated(DetailAST, boolean, boolean, Set<String>) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
Checks if a given subtree terminated by return, throw or, if allowed break, continue.
- isTextPresentInsideHtmlTag(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Whether some text is present inside the HTML element or tag.
- isTextSeparatedCorrectlyFromPrevious(int[], int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Checks if characters in
line
at and aroundcolumnNo
has the correct number of spaces. to returntrue
the following conditions must be met: the character atcolumnNo
is the first in the line. - isThrowsTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Checks that the tag is an 'throws' or 'exception' tag.
- isTokenWithNoChildSlist(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Tests whether the provided tokenType will never have a SLIST as child in its AST.
- isTopLevelClassJavadoc() - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Check if the current javadoc block comment AST corresponds to the top-level class as we only want to scrape top-level class javadoc.
- isTrailingBlockComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks if current comment block is trailing comment, e.g.:
- isTrailingBlockComment(TextBlock, int...) - Static method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Whether the C style comment is trailing.
- isTrailingComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks if current comment is a trailing comment.
- isTrailingSingleLineComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks if current single-line comment is trailing comment, e.g.:
- isTreeWalkerFilterModule(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Checks whether a class may be considered as the checkstyle
TreeWalker
filter. - isTryBlocksResourceSpecification(AbstractExpressionHandler) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
-
Check if the expression is resource of try block.
- isTypeDeclaration(int) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Is type declaration token type (CLASS_DEF, INTERFACE_DEF, ANNOTATION_DEF, ENUM_DEF, RECORD_DEF).
- isTypeDef(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
-
Checks if an AST node is a type definition.
- isTypeField(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
If variable definition is a type field.
- isUndocumentedProperty(Class<?>, String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Checks if the property is supposed to be documented.
- isUnnamedVariable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Check if the variable is unnamed.
- isUnusedImport(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Checks whether an import is unused.
- isUsed() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
Check if the catch parameter is used.
- isUsed() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Check if the lambda parameter is used.
- isUsed() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Is the variable used or not.
- isUserDefinedArrangementOfThis(RequireThisCheck.AbstractFrame, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks whether user arranges 'this' for variable in method, constructor, or block on his own.
- isUsingOfObjectReferenceToInvokeMethod(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks whether there is a use of an object reference to invoke an object's method on line.
- isValidLanguageCode(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Checks whether user specified language code is correct (is contained in available locales).
- isValidName(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Returns whether the provided name is for a valid tag.
- isValidOn(DetailAST) - Method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Checks if a particular Javadoc tag is valid within a Javadoc block of a given AST.
- isVariableDefCountable(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Checks if a variable definition is countable.
- isVariableInForInit(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Checks if current variable is defined in
for-loop init
, e.g.: - isVariableInOperatorExpr(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Checks if variable is in operator declaration.
- isVariableMatchesIgnorePattern(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Checks if entrance variable is contained in ignored pattern.
- isVerifiable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks if current method's return type or variable's type is verifiable according to memberModifiers option.
- isVerifiable(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
Checks if current empty catch block is verifiable according to Check's options (exception's variable name and comment format are both in consideration).
- isViolatingEmptyLineBetweenFieldsPolicy(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Checks whether token placement violates policy of empty line between fields.
- isViolation(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
-
Checks if a text node meets the criteria for a violation.
- isViolationMessagesText(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Checks whether the
JavadocTokenType.PARAGRAPH
node is referring to the violation message keys javadoc segment. - isVoidContext - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
-
Identifies if context is void.
- isWhiteSpaceBeforeColon(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
Checks if there is a whitespace before the colon of a switch case or switch default.
- isWhitespaceBeforeColonOfCase(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
Checks if there is a whitespace before the colon of a switch case.
- isWhitespaceBeforeColonOfDefault(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
Checks if there is a whitespace before the colon of a switch default.
- isWithNestedSubclass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Does class have nested subclass.
- isWithNonPrivateCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Does class have non-private ctors.
- isWrongOrder(String, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Checks whether import name is in wrong order.
- isXmlHeaderPrinted - Variable in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
-
Determines if xml header is printed.
- isXpathQueryForNodeIsAccurateEnough(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Checks if ast element has all requirements to have unique xpath query.
- isXpathQueryMatching(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Is matching by xpath query.
- isZero(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
Checks if given node contains numeric constant for zero.
- isZeroChar(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
Examine char literal for initializing to default value.
- isZeroDistanceToken(int) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Check if the token should be ignored for distance counting.
- items - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseListIterator
-
List of nodes.
- iterateAxis(int) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Determines axis iteration algorithm.
- iterateAxis(int) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Determines axis iteration algorithm.
- iterateAxis(int) - Method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Determines axis iteration algorithm.
- iterateAxis(int, NodePredicate) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Determines axis iteration algorithm.
- iterateOverBlockContainingLocalAnonInnerClass(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Iterate over all the ast nodes present under
ast
. - iteratePublicStaticIntFields(DetailAST, Consumer<String>) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
Walks over the type members and push the first javadoc sentence of every
public
static
int
field to the consumer.
J
- JAVA_FILE_EXTENSION - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Java file extension.
- JAVA_LANG - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
java.lang
package as string. - JAVA_LANG_PACKAGE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Regexp pattern to match java.lang package.
- JAVA_LANG_PREFIX - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Java.lang namespace prefix, which is stripped from SuppressWarnings.
- JAVA_WITH_COMMENTS - com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
-
Java tokens and comment nodes (singleline comments and block comments).
- JAVA_WITH_JAVADOC_AND_COMMENTS - com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
-
Java tokens, comments and Javadoc comments nodes (which are parsed from block comments).
- JavaAstVisitor - Class in com.puppycrawl.tools.checkstyle
-
Visitor class used to build Checkstyle's Java AST from the parse tree produced by
JavaLanguageParser
. - JavaAstVisitor(CommonTokenStream) - Constructor for class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
Constructs a JavaAstVisitor with given token stream.
- JavaAstVisitor.DetailAstPair - Class in com.puppycrawl.tools.checkstyle
-
Used to swap and organize DetailAstImpl subtrees.
- JAVADOC - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Root node of any Javadoc comment.
- JAVADOC_BLOCK_TAG_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
-
This regexp is used to extract the javadoc tags.
- JAVADOC_CHECK_PROPERTIES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Set of properties that every Javadoc check has.
- JAVADOC_CLOSING_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.BlockTagUtil
-
Closing tag.
- JAVADOC_FOR_MODULE_OR_PROPERTY - Static variable in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Map of scraped javadocs - name of property, javadoc detail node.
- JAVADOC_INLINE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Javadoc inline tag.
- JAVADOC_INLINE_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Last child of
JavadocTokenTypes.JAVADOC_INLINE_TAG
that represents right curly brace '}'. - JAVADOC_INLINE_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
First child of
JavadocTokenTypes.JAVADOC_INLINE_TAG
that represents left curly brace '{'. - JAVADOC_MULTILINE_TO_SINGLELINE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
This regexp is used to convert multiline javadoc to single-line without stars.
- JAVADOC_PREFIX_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Pattern to recognize leading "*" characters in Javadoc.
- JAVADOC_START - Static variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Symbols with which javadoc starts.
- JAVADOC_START - Static variable in class com.puppycrawl.tools.checkstyle.utils.ParserUtil
-
Symbols with which javadoc starts.
- JAVADOC_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Javadoc tag.
- JAVADOC_TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'javadocTokens'.
- JavadocBlockTagLocationCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space.
- JavadocBlockTagLocationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
-
Creates a new
JavadocBlockTagLocationCheck
instance with default settings. - javadocComments - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Map of the Javadoc comments indexed on the last line of the comment.
- JavadocContentLocationCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that the Javadoc content begins from the same position for all Javadoc comments in the project.
- JavadocContentLocationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
- JavadocContentLocationOption - Enum in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Represents the locations for the javadoc content.
- JavadocContentLocationOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption
- JavadocDetailNodeParser - Class in com.puppycrawl.tools.checkstyle
-
Used for parsing Javadoc comment as DetailNode tree.
- JavadocDetailNodeParser() - Constructor for class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
- JavadocDetailNodeParser.DescriptiveErrorListener - Class in com.puppycrawl.tools.checkstyle
-
Custom error listener for JavadocParser that prints user readable errors.
- JavadocDetailNodeParser.ParseErrorMessage - Class in com.puppycrawl.tools.checkstyle
-
Contains information about parse error message.
- JavadocDetailNodeParser.ParseStatus - Class in com.puppycrawl.tools.checkstyle
-
Contains result of parsing javadoc comment: DetailNode tree and parse error message.
- JavadocLeadingAsteriskAlignCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks the alignment of leading asterisks in a Javadoc comment.
- JavadocLeadingAsteriskAlignCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
- JavadocMetadataScraper - Class in com.puppycrawl.tools.checkstyle.meta
-
Class for scraping module metadata from the corresponding class' class-level javadoc.
- JavadocMetadataScraper() - Constructor for class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
- JavadocMethodCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks the Javadoc of a method or constructor.
- JavadocMethodCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
- JavadocMethodCheck.ClassInfo - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Contains class's
Token
. - JavadocMethodCheck.ExceptionInfo - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Stores useful information about declared exception.
- JavadocMethodCheck.Token - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Represents text element with location in the text.
- JavadocMissingLeadingAsteriskCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks if the javadoc has leading asterisks on each line.
- JavadocMissingLeadingAsteriskCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
- JavadocMissingWhitespaceAfterAsteriskCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that there is at least one whitespace after the leading asterisk.
- JavadocMissingWhitespaceAfterAsteriskCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck
- JavadocNodeImpl - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Implementation of DetailNode interface that is mutable.
- JavadocNodeImpl() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
- JavadocPackageCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that each Java package has a Javadoc file used for commenting.
- JavadocPackageCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
-
Creates a new instance.
- JavadocParagraphCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks the Javadoc paragraph.
- JavadocParagraphCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
- JavadocPropertiesGenerator - Class in com.puppycrawl.tools.checkstyle
-
This class is used internally in the build process to write a property file with short descriptions (the first sentences) of TokenTypes constants.
- JavadocPropertiesGenerator() - Constructor for class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
Don't create instance of this class, use the
JavadocPropertiesGenerator.main(String[])
method instead. - JavadocPropertiesGenerator.CliOptions - Class in com.puppycrawl.tools.checkstyle
-
Helper class encapsulating the command line options and positional parameters.
- javadocStartLineNumber - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Specifies the line number of starting block of the javadoc comment.
- JavadocStyleCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Validates Javadoc comments to help ensure they are well formed.
- JavadocStyleCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
- JavadocTag - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Represents a Javadoc tag.
- JavadocTag(int, int, String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Constructs the object.
- JavadocTag(int, int, String, String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
Constructs the object.
- JavadocTagContinuationIndentationCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks the indentation of the continuation lines in block tags.
- JavadocTagContinuationIndentationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
- JavadocTagInfo - Enum in com.puppycrawl.tools.checkstyle.checks.javadoc
-
This enum defines the various Javadoc tags and their properties.
- JavadocTagInfo(String, String, JavadocTagInfo.Type) - Constructor for enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Sets the various properties of a Javadoc tag.
- JavadocTagInfo.Type - Enum in com.puppycrawl.tools.checkstyle.checks.javadoc
-
The Javadoc Type.
- JavadocTags - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Value object for combining the list of valid validTags with information about invalid validTags encountered in a certain Javadoc comment.
- JavadocTags(Collection<JavadocTag>, Collection<InvalidJavadocTag>) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
-
Creates an instance.
- JavadocTagType() - Constructor for enum com.puppycrawl.tools.checkstyle.utils.JavadocUtil.JavadocTagType
- javadocTokens - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
The javadoc tokens the check is interested in.
- JavadocTokenTypes - Class in com.puppycrawl.tools.checkstyle.api
-
Contains the constants for all the tokens contained in the Abstract Syntax Tree for the javadoc grammar.
- JavadocTokenTypes() - Constructor for class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Empty private constructor of the current class.
- JavadocTypeCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks the Javadoc comments for type definitions.
- JavadocTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
- JavadocUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Contains utility methods for working with Javadoc.
- JavadocUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Prevent instantiation.
- JavadocUtil.JavadocTagType - Enum in com.puppycrawl.tools.checkstyle.utils
-
The type of Javadoc tag we want returned.
- JavadocVariableCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that a variable has a Javadoc comment.
- JavadocVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
- JavaFileFilter() - Constructor for class com.puppycrawl.tools.checkstyle.gui.MainFrame.JavaFileFilter
- javaFiveCompatibility - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
-
Enable java 5 compatibility mode.
- JavaNCSSCheck - Class in com.puppycrawl.tools.checkstyle.checks.metrics
-
Determines complexity of methods, classes and files by counting the Non Commenting Source Statements (NCSS).
- JavaNCSSCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
- JavaNCSSCheck.Counter - Class in com.puppycrawl.tools.checkstyle.checks.metrics
-
Class representing a counter.
- javaParseExceptionSeverity - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Specify severity Level to log Java parsing exceptions when they are skipped.
- JavaParser - Class in com.puppycrawl.tools.checkstyle
-
Helper methods to parse java source files.
- JavaParser() - Constructor for class com.puppycrawl.tools.checkstyle.JavaParser
-
Stop instances being created.
- JavaParser.CheckstyleErrorListener - Class in com.puppycrawl.tools.checkstyle
-
Custom error listener to provide detailed exception message.
- JavaParser.Options - Enum in com.puppycrawl.tools.checkstyle
-
Enum to be used for test if comments should be used.
- javaStyle - Variable in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
-
Control whether to enforce Java style (true) or C style (false).
- JDK_17 - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Constant for jdk 17 version number.
- JDK_22 - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Constant for jdk 22 version number.
- jdkVersion - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Set the JDK version that you are using.
- JLS_ORDER - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
-
The order of modifiers as suggested in sections 8.1.1, 8.3.1 and 8.4.3 of the JLS.
- joinPackageNamesWithClassName(String, Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Creates a string by joining package names with a class name.
K
- key - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
-
The property key.
- key - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
Key for the violation format.
- key - Variable in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Key for the message format.
- KEY - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Name of the key attribute.
- KEYGEN_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
"keygen" tag name.
- KEYGEN_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
HTML void element
<keygen>
. - keyList - Variable in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.SequencedProperties
-
Holding the keys in the same order as in the file.
- keys() - Method in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.SequencedProperties
-
Returns a copy of the keys.
L
- label - Variable in enum com.puppycrawl.tools.checkstyle.meta.ModuleType
-
String representation of the module type.
- LABEL_CHILDREN - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
-
The types of expressions that are children of a label.
- LABELED_STAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A labeled statement.
- LabelHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for labels.
- LabelHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.LabelHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- LAMBDA - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Special lambda symbol
->
. - LambdaBodyLengthCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Checks lambda body length.
- LambdaBodyLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
- LambdaHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for lambda expressions.
- LambdaHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.LambdaHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- LambdaParameterDetails(DetailAST, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Create a new lambda parameter instance.
- LambdaParameterNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks lambda parameter names.
- LambdaParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.LambdaParameterNameCheck
-
Creates new instance of
LambdaParameterNameCheck
. - lambdaParameters - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
-
Keeps track of the lambda parameters in a block.
- lambdaStatementEnd - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Hold the line-number where the last lambda statement ended.
- LAND - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
&&
(conditional AND) operator. - LANGUAGE_COUNTRY_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Regexp pattern for bundles names which end with language code, followed by country code suffix.
- LANGUAGE_COUNTRY_VARIANT_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Regexp pattern for bundles names which end with language code, followed by country code and variant suffix.
- LANGUAGE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Regexp pattern for bundles names which end with language code suffix.
- lastColumn - Variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
-
The suppression region for the check - last column.
- lastGroup - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Last imported group.
- lastImport - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Name of last import.
- lastImportLine - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Line number of last import.
- lastImportStatic - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
If last import was static.
- lastIndexOfNonWhitespace(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Helper method to find the index of the last non-whitespace character in a string.
- lastLine - Variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder.Entry
-
The suppression region for the check - last line.
- lastLine - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
The last line where warnings may be suppressed.
- lastLine - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
The last line where warnings may be suppressed.
- lastLine() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.DetailAstSet
-
Get the line number of the last line.
- lastLines - Variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
The line contents of the last file.
- lastPath - Variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
The path of the last file.
- lastStatementEnd - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Hold the line-number where the last statement ended.
- lastVariableResourceStatementEnd - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Hold the line-number where the last resource variable statement ended.
- lazyLoad(T, Supplier<T>) - Static method in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Initialize object by supplier if object is null.
- lcurly - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Left curly.
- LCURLY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A left curly brace (
{
). - LE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
<=
(less than or equal) operator. - LEADING_ASTERISK - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Leading asterisk.
- leave(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Checks number of return statements and restore previous context.
- leaveAddingConditional() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Leaves catch.
- leaveBranch() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Leaves else, default or case group tokens.
- leaveClassDef() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
Called when we leave class definition.
- leaveClassDef() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Restores previous context.
- leaveCompilationUnit() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
We process all the blocks containing local anonymous inner classes separately after processing all the other nodes.
- leaveConditional() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Leaves while, do, for, if, ternary (?
- leaveContainerNode(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
-
Process the end of a container node.
- leaveExpr(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Restores previous context.
- leaveForDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Pops the variables from the stack.
- leaveForEach(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Push current variables to the stack.
- leaveForIter(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Push current variables to the stack.
- leaveJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Called after all the child nodes have been process.
- leaveLiteralNew(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Determine whether LITERAL_NEW is an anonymous class definition and leave the frame it is in.
- leaveMethodDef() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Removes old context.
- leaveMethodDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Process the end of a method definition.
- leaveMethodDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Process the end of a method definition.
- leaveMultiplyingConditional() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Leaves try.
- leaveSlist(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Determine whether SLIST begins a block, determined by braces.
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Called after all the child nodes have been process.
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
- leaveUnitaryOperator() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Leaves ternary operator (?
- LEFT_BRACE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Left brace in
JavadocTokenTypes.PARAMETERS
part ofJavadocTokenTypes.REFERENCE
. - LEFT_CURLY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Curly for comparison.
- LEFT_SHIFT - Static variable in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
String representation of the left shift operator.
- LeftCurlyCheck - Class in com.puppycrawl.tools.checkstyle.checks.blocks
-
Checks for the placement of left curly braces (
'{'
) for code blocks. - LeftCurlyCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
- LeftCurlyOption - Enum in com.puppycrawl.tools.checkstyle.checks.blocks
-
Represents the options for placing the left curly brace
'{'
. - LeftCurlyOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
- legalAbstractClassNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Define abstract classes that may be used as types.
- legalComment - Variable in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
-
Define pattern for text allowed in trailing comments.
- length() - Method in enum com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
Returns length of file separator in bytes.
- LENGTH_OF_ALL_SEPARATORS - Static variable in class com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
-
Length of all separators.
- lengthExpandedTabs(String, int, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Returns the length of a String prefix with tabs expanded.
- lengthMinusTrailingWhitespace(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Returns the length of a string ignoring all trailing whitespace.
- level - Variable in class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
-
The severity level to watch out for.
- levels - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
-
Set of acceptable indentation levels.
- LF - com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
Unix-style line separators.
- LF_CR_CRLF - com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
Matches CR, LF and CRLF line separators.
- LI - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
List item html tag:
<li></li>
. - LI_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
List item tag name.
- LI_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End list item tag.
- LI_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start list item tag.
- limitedTokens - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Specify set of tokens with limited occurrences as descendants.
- line - Variable in class com.puppycrawl.tools.checkstyle.api.LineColumn
-
The one-based line number.
- line - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
-
The line in which the invalid tag occurs.
- line - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
The line number of the tag.
- line(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Get a single-line.
- LINE_BREAK_ESCAPE - Static variable in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink.CustomPrintWriter
-
A Regex pattern to represent all kinds of newline character.
- LINE_END_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
A pattern to split on line ends.
- LINE_FEED - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Line feed character.
- LINE_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The placeholder for line.
- LINE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
OS specific line separator.
- LINE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
OS specific line separator.
- LINE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.SuppressionsStringPrinter
-
OS specific line separator.
- LINE_TERMINATOR - Static variable in class com.puppycrawl.tools.checkstyle.api.FileText
-
Regular expression pattern matching all line terminators.
- lineBreaks - Variable in class com.puppycrawl.tools.checkstyle.api.FileText
-
The first position of each line within the full text.
- lineColumn(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileText
-
Determine line and column numbers in full text.
- LineColumn - Class in com.puppycrawl.tools.checkstyle.api
-
Immutable line and column numbers.
- LineColumn(int, int) - Constructor for class com.puppycrawl.tools.checkstyle.api.LineColumn
-
Constructs a new pair of line and column numbers.
- lineFilter - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Line number filter.
- lineIsBlank(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Checks if the specified line is blank.
- lineIsComment(int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Checks if the specified line is a single-line comment without code.
- LineLengthCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Checks for long lines.
- LineLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
- lineNo - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
The line number.
- lineNo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
The line number in the source file where this tag was found.
- lineNo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
-
Token's line number.
- lineNo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
The line number of the tag.
- lineNo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser.Point
-
Line number.
- lineNo - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
The line number.
- lineNo - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Suppression line.
- lineNumber - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Line number.
- lineNumber - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage
-
Line number where parse error occurred.
- lineNumber - Variable in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
The line number of the element for which the query should be generated.
- linePositionList - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Line position map.
- lineRange - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Specify negative/zero/positive value that defines the number of lines preceding/at/following the suppressing nearby text.
- lines - Variable in class com.puppycrawl.tools.checkstyle.api.FileText
-
The lines of the file, without terminators.
- lines - 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.
- lines2position - Variable in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
-
Mapping.
- linesCsv - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
CSV for line number filter.
- lineSeparator - Variable in enum com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
The line separator representation.
- lineSeparator - Variable in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
-
Specify the type of line separator.
- LineSeparatorOption - Enum in com.puppycrawl.tools.checkstyle.checks
-
Represents the options for line separator settings.
- LineSeparatorOption(String) - Constructor for enum com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
Creates a new
LineSeparatorOption
instance. - linesToPosition - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Lines to position map.
- lineWrappingHandler - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Instance of line wrapping handler to use.
- LineWrappingHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
This class checks line-wrapping into definitions and expressions.
- LineWrappingHandler(IndentationCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Sets values of class field, finds last node and calculates indentation level.
- LineWrappingHandler.LineWrappingOptions - Enum in com.puppycrawl.tools.checkstyle.checks.indentation
-
Enum to be used for test if first line's indentation should be checked or not.
- lineWrappingIndentation - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Specify how far continuation line should be indented when line-wrapping is present.
- LineWrappingOptions() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler.LineWrappingOptions
- link(String) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
Write an external link.
- LINK - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
{@link}
. - LINK_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Link tag name.
- LINK_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@link' literal in {@link} Javadoc inline tag.
- LINK_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Link html tag.
- LINKPLAIN - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
{@linkplain}
. - LINKPLAIN_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@linkplain' literal in {@linkplain} Javadoc inline tag.
- listenerList - Variable in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
-
A list of event listeners for the cell editor.
- listenerList - Variable in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
-
A list of event listeners for the tree model.
- listeners - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
Vector of listeners.
- listFiles(File, List<Pattern>) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Traverses a specified node looking for files to check.
- ListToTreeSelectionModelWrapper - Class in com.puppycrawl.tools.checkstyle.gui
-
ListToTreeSelectionModelWrapper extends DefaultTreeSelectionModel to listen for changes in the ListSelectionModel it maintains.
- ListToTreeSelectionModelWrapper(TreeTable) - Constructor for class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
Constructor to initialise treeTable.
- LITERAL - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
{@literal}
. - LITERAL_ASSERT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
assert
keyword. - LITERAL_BOOLEAN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
boolean
keyword. - LITERAL_BREAK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
break
keyword. - LITERAL_BYTE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
byte
keyword. - LITERAL_CASE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
case
keyword. - LITERAL_CATCH - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
catch
keyword. - LITERAL_CHAR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
char
keyword. - LITERAL_CLASS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
class
keyword. - LITERAL_CONTINUE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
continue
keyword. - LITERAL_DEFAULT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
default
keyword. - LITERAL_DO - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
do
keyword. - LITERAL_DOUBLE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
double
keyword. - LITERAL_ELSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
else
keyword. - LITERAL_EXCLUDE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'exclude' literal.
- LITERAL_FALSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
false
keyword. - LITERAL_FINALLY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
finally
keyword. - LITERAL_FLOAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
float
keyword. - LITERAL_FOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
for
keyword. - LITERAL_IF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
if
keyword. - LITERAL_INCLUDE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'include' literal.
- LITERAL_INSTANCEOF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
instanceof
operator. - LITERAL_INT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
int
keyword. - LITERAL_INTERFACE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
interface
keyword. - LITERAL_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@literal' literal in {@literal} Javadoc inline tag.
- LITERAL_LONG - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
long
keyword. - LITERAL_NATIVE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
native
keyword. - LITERAL_NEW - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
new
keyword. - LITERAL_NON_SEALED - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
non-sealed
keyword. - LITERAL_NULL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
null
keyword. - LITERAL_PERMITS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
permits
restricted identifier. - LITERAL_PRIVATE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
private
keyword. - LITERAL_PROTECTED - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
protected
keyword. - LITERAL_PUBLIC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
public
keyword. - LITERAL_RECORD - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
record
keyword. - LITERAL_RETURN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
return
keyword. - LITERAL_SEALED - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
sealed
restricted identifier. - LITERAL_SHORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
short
keyword. - LITERAL_STATIC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
static
keyword. - LITERAL_SUPER - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
super
keyword. - LITERAL_SWITCH - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
switch
keyword. - LITERAL_SYNCHRONIZED - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
synchronized
keyword. - LITERAL_THIS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
this
keyword use to refer the current object. - LITERAL_THROW - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
throw
keyword. - LITERAL_THROWS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
throws
keyword. - LITERAL_TRANSIENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
transient
keyword. - LITERAL_TRUE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
true
keyword. - LITERAL_TRY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
try
keyword. - LITERAL_VOID - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
void
keyword. - LITERAL_VOLATILE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
volatile
keyword. - LITERAL_WHEN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A
when
clause. - LITERAL_WHILE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
while
keyword. - LITERAL_YIELD - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
yield
keyword. - LITERALS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Token types for literals.
- LNOT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
!
(logical complement) operator. - load() - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Load cached values from file.
- load(URI) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Loads the import control file from a file.
- load(InputSource, URI) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Loads the import control file from a
InputSource
. - LOAD_EXTERNAL_DTD - Static variable in class com.puppycrawl.tools.checkstyle.XmlLoader.LoadExternalDtdFeatureProvider
-
Feature that enables loading external DTD when loading XML files.
- LOAD_PROPERTIES_EXCEPTION - Static variable in class com.puppycrawl.tools.checkstyle.Main
-
A key pointing to the load properties exception message in the "messages.properties" file.
- loadConfiguration(String, PropertyResolver) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Returns the module configurations in a specified file.
- loadConfiguration(String, PropertyResolver, ConfigurationLoader.IgnoredModulesOptions) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Returns the module configurations in a specified file.
- loadConfiguration(String, PropertyResolver, ConfigurationLoader.IgnoredModulesOptions, ThreadModeSettings) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Returns the module configurations in a specified file.
- loadConfiguration(String, PropertyResolver, ThreadModeSettings) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Returns the module configurations in a specified file.
- loadConfiguration(InputSource, PropertyResolver, ConfigurationLoader.IgnoredModulesOptions) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Returns the module configurations from a specified input source.
- loadConfiguration(InputSource, PropertyResolver, ConfigurationLoader.IgnoredModulesOptions, ThreadModeSettings) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Returns the module configurations from a specified input source.
- LoadExternalDtdFeatureProvider() - Constructor for class com.puppycrawl.tools.checkstyle.XmlLoader.LoadExternalDtdFeatureProvider
-
Stop instances being created.
- loadExternalResource(String) - Static method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Loads the content of external resource.
- loadExternalResources(Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Loads a set of
PropertyCacheFile.ExternalResource
based on their locations. - loadHeader(Reader) - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Load header to check against from a Reader into readerLines.
- loadHeaderFile() - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Load the header from a file.
- loadProperties(File) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Loads properties from a File.
- loadSuppressions(String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Returns the suppression filters in a specified file.
- loadSuppressions(InputSource, String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Returns the suppression filters in a specified source.
- loadUri(URI) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Loads the import control file from a URI.
- loadXpathSuppressions(String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Returns the suppression
TreeWalker
filters in a specified file. - loadXpathSuppressions(InputSource, String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Returns the suppression
TreeWalker
filters in a specified source. - localCheckAccess(String, String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
-
Checks whether any of the rules for this node control access to a specified package or file.
- LOCALE_COUNTRY - com.puppycrawl.tools.checkstyle.PropertyType
-
This property is a string represents an ISO 3166 2-letter code.
- LOCALE_LANGUAGE - com.puppycrawl.tools.checkstyle.PropertyType
-
This property is a string represents an ISO 639 code.
- localeCountry - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
Locale country to report messages .
- localeLanguage - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
Locale language to report messages .
- LocalFinalVariableNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that local final variable names conform to a specified pattern.
- LocalFinalVariableNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck
-
Creates a new
LocalFinalVariableNameCheck
instance. - LocalizedMessage - Class in com.puppycrawl.tools.checkstyle
-
Represents a message that can be localised.
- LocalizedMessage(String, Class<?>, String, Object...) - Constructor for class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Creates a new
LocalizedMessage
instance. - LocalizedMessage.Utf8Control - Class in com.puppycrawl.tools.checkstyle
-
Custom ResourceBundle.Control implementation which allows explicitly read the properties files as UTF-8.
- localOnly - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
-
Indicates if the rule only applies to this package.
- LocalVariableNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that local, non-
final
variable names conform to a specified pattern. - LocalVariableNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
-
Creates a new
LocalVariableNameCheck
instance. - locateFinest(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
-
Search down the tree to locate the finest match for a supplied package.
- locateFinest(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
- locateFinest(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
- location - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
-
Specify the policy on placement of the Javadoc content.
- location - Variable in class com.puppycrawl.tools.checkstyle.PropertyCacheFile.ExternalResource
-
Location of resource.
- log - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
Logger for Checker.
- log - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Logger for TranslationCheck.
- log() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Logs the violations for the check.
- log(int, int, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
- log(int, int, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
- log(int, int, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Log a message that has column information.
- log(int, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
- log(int, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
- log(int, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Log a message that has no column information.
- log(DetailAST, String, Object...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Helper method to log a Violation.
- LOG - Static variable in class com.puppycrawl.tools.checkstyle.Main
-
Logger for Main.
- logAsSeparated(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Log violations for each Token.
- logAsTotal(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Log validation as one violation.
- logChildError(DetailAST, int, IndentLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Log child indentation error.
- logCommaViolation(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
Logs a trailing array comma violation if one exists.
- logError(DetailAST, String, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Log an indentation error.
- logError(DetailAST, String, int, IndentLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Log an indentation error.
- logException(Exception, File) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Helper method to log an exception.
- logFirstSinglelineLine(int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
Logs warning if any non-multiline lines left in header regexp.
- logMatch(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
-
This method looks for a warning that matches a configured expression.
- logMessage(int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Displays the right message.
- logMissingTranslation(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Logs that translation file is missing.
- logMultilineIndentation(DetailAST, DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Logs comment which can have the same indentation level as next or previous statement.
- logsStarredImportViolation(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
-
Gets the full import identifier.
- logTag(int, String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Log a message.
- logViolation(int, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
Checks alignment of asterisks and logs violations.
- logViolation(String, DetailAST, RequireThisCheck.AbstractFrame) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Helper method to log a Violation.
- logViolations(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Traverse
variablesStack
stack and log the violations. - logWarningMessage(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler
-
Logs warning message if indentation is incorrect.
- logWrongImportGroupOrder(DetailAST, String, String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Log wrong import group order.
- LOOP_IDIOM_IGNORED_PARENTS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
-
The token types that are ignored while checking "loop-idiom".
- LOOP_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Loop types.
- LOR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
||
(conditional OR) operator. - lowerBound - Variable in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilterElement
-
Lower bound of the range.
- LPAREN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A left parenthesis (
(
). - LT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
<
(less than) operator.
M
- macroName - Variable in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
A macro name.
- macroParameters - Variable in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
The macro parameters.
- MagicNumberCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that there are no "magic numbers" where a magic number is a numeric literal that is not defined as a constant.
- MagicNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
- main(String...) - Static method in class com.puppycrawl.tools.checkstyle.gui.Main
-
Entry point.
- main(String...) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
TokenTypes.properties generator entry point.
- main(String...) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Loops over the files specified checking them for errors.
- Main - Class in com.puppycrawl.tools.checkstyle.gui
-
Entry point for starting the checkstyle GUI.
- Main - Class in com.puppycrawl.tools.checkstyle
-
Wrapper command line program for the Checker.
- Main() - Constructor for class com.puppycrawl.tools.checkstyle.gui.Main
-
Hidden constructor of the current utility class.
- Main() - Constructor for class com.puppycrawl.tools.checkstyle.Main
-
Client code should not create instances of this class, but use
Main.main(String[])
method instead. - MAIN_FOLDER_PATH - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Path to main source code folder.
- Main.CliOptions - Class in com.puppycrawl.tools.checkstyle
-
Command line options.
- Main.OnlyCheckstyleLoggersFilter - Class in com.puppycrawl.tools.checkstyle
-
Log Filter used in debug mode.
- Main.OutputFormat - Enum in com.puppycrawl.tools.checkstyle
-
Enumeration over the possible output formats.
- mainAst - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
The AST which is handled by this handler.
- mainAst - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
-
The AST which is handled by this handler.
- MainFrame - Class in com.puppycrawl.tools.checkstyle.gui
-
Displays information about a parse tree.
- MainFrame() - Constructor for class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
Create a new MainFrame.
- MainFrame.ExpandCollapseAction - Class in com.puppycrawl.tools.checkstyle.gui
-
Handler for Expand and Collapse events.
- MainFrame.FileSelectionAction - Class in com.puppycrawl.tools.checkstyle.gui
-
Handler for file selection action events.
- MainFrame.FindNodeByXpathAction - Class in com.puppycrawl.tools.checkstyle.gui
-
Handler for Find Node by Xpath Event.
- MainFrame.JavaFileFilter - Class in com.puppycrawl.tools.checkstyle.gui
-
Filter for Java files.
- MainFrame.ReloadAction - Class in com.puppycrawl.tools.checkstyle.gui
-
Handler for reload action events.
- MainFrameModel - Class in com.puppycrawl.tools.checkstyle.gui
-
Model for checkstyle frame.
- MainFrameModel() - Constructor for class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Instantiate the model.
- MainFrameModel.ParseMode - Enum in com.puppycrawl.tools.checkstyle.gui
-
Parsing modes which available in GUI.
- makeAcceptableTokens() - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Returns array of acceptable tokens.
- makeAstRoot(JavaAstVisitor.DetailAstPair, DetailAstImpl) - Static method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor.DetailAstPair
-
This method is used to replace the
^
(set as root node) ANTLR2 operator. - makeCodeSelection() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Make selection of code in a text area.
- match - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Control whether to look for a match or mismatch on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern.
- MATCH_INHERIT_DOC - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
-
Compiled regexp to match Javadoc tags with no argument and {}.
- MATCH_JAVADOC_ARG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Compiled regexp to match Javadoc tags that take an argument.
- MATCH_JAVADOC_ARG_MISSING_DESCRIPTION - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Compiled regexp to match Javadoc tags with argument but with missing description.
- MATCH_JAVADOC_MULTILINE_CONT - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Compiled regexp to look for a continuation of the comment.
- MATCH_JAVADOC_NOARG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Compiled regexp to match Javadoc tags with no argument.
- MATCH_JAVADOC_NOARG_CURLY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Compiled regexp to match Javadoc tags with no argument and {}.
- MATCH_JAVADOC_NOARG_MULTILINE_START - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Compiled regexp to match first part of multilineJavadoc tags.
- MATCH_SINGLELINE_COMMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Compiled regexp to match a single-line comment line.
- MATCH_SINGLELINE_COMMENT_PAT - Static variable in class com.puppycrawl.tools.checkstyle.api.FileContents
-
The pattern to match a single-line comment containing only the comment itself -- no code.
- matchAccessModifiers(AccessModifierOption) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
Checks whether a method has the correct access modifier to be checked.
- matchAccessModifiers(AccessModifierOption) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
-
Checks whether a record definition has the correct access modifier to be checked.
- matchAcrossLines - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Control whether to match expressions across multiple lines.
- matchDirectoryStructure - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
-
Control whether to check for directory and package name match.
- matcher - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
The matcher.
- matches(byte...) - Method in enum com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
Checks that bytes is equal to the byte representation of this line separator.
- matchesAtFront(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
Matches other package name exactly or partially at front.
- matchesAtFrontNoRegex(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
Non-regex case.
- matchesExactly(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
-
Check for equality of this with pkg.
- matchesExactly(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
- matchesExactly(String, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
- matchesFileExtension(File, String...) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Returns whether the file extension matches what we are meant to process.
- matchesSkipRegex(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Checks if the given method name matches the regex.
- matchesTag(TreeWalkerAuditEvent) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Whether current event matches any tag from
SuppressWithNearbyCommentFilter.tags
. - matchLength - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.RuleMatchForImport
-
Length of matching string for current best match.
- matchPattern(String, Pattern) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
- matchPosition - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.RuleMatchForImport
-
Position of matching string for current best match.
- MatchSuppressor - Interface in com.puppycrawl.tools.checkstyle.checks.regexp
-
Represents a suppressor for matches.
- matchValue - Variable in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilterElement
-
The matching Integer.
- MatchXpathCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Evaluates Xpath query and report violation on all matching AST nodes.
- MatchXpathCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
-
Specify maximum allowed nesting depth.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
-
Specify maximum allowed nesting depth.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
-
Specify maximum allowed nesting depth.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Specify maximum allowed number of return statements in non-void methods/lambdas.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Specify maximum allowed number of throws statements.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Specify the maximum threshold allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Specify the maximum number of boolean operations allowed in one expression.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Specify the maximum threshold allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Specify the maximum threshold allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
-
Specify the maximum number of lines allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
-
Specify the maximum threshold allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
-
Specify the maximum number of lines allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
-
Specify the maximum number of lines allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
-
Specify the maximum line length allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
-
Specify the maximum number of lines allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
-
Specify the maximum number of outer types allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Specify the maximum number of parameters allowed.
- max - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
-
Specify the maximum number of components allowed in the header of a record definition.
- MAX_QUOTED_LENGTH - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
The maximum string length before we chop the string.
- MAX_TEXT_LEN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
The maximum length of text to display with this tag.
- maxAllowed - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
-
Maximum allowed number of return statements.
- maxErrors - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
The maximum number of errors that are tolerated.
- maxForVoid - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Specify maximum allowed number of return statements in void methods/constructors/lambdas.
- maximum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Maximum number of times regular expression should occur in a file.
- maximum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Specify the maximum number of matches required in each file.
- maximum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Specify the maximum number of matches required in each file.
- maximum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Specify the maximum number of matches required in each file.
- maximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
-
Specifies the maximum allowed number of detections and returns Builder object.
- maximumDepth - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Specify the maximum depth for descendant counts.
- maximumMessage - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Define the violation message when the maximum count is exceeded.
- maximumNumber - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Specify a maximum count for descendants.
- maxPackage - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Specify the maximum number of
package
methods allowed. - maxPrivate - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Specify the maximum number of
private
methods allowed. - maxProtected - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Specify the maximum number of
protected
methods allowed. - maxPublic - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Specify the maximum number of
public
methods allowed. - maxTotal - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Specify the maximum number of methods allowed at all scope levels.
- maxWarnings - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
The maximum number of warnings that are tolerated.
- MEMBER - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
A class member in
JavadocTokenTypes.REFERENCE
. - MemberDefHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for member definitions.
- MemberDefHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.MemberDefHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- memberModifiers - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Control whether to check only methods and fields with any of the specified modifiers.
- MemberNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that instance variable names conform to a specified pattern.
- MemberNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
-
Creates a new
MemberNameCheck
instance. - message - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
-
Define the message which is used to notify about violations; if empty then the default message is used.
- message - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
The message to report on detection.
- message - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Specify message which is used to notify about violations, if empty then the default (hard-coded) message is used.
- message - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.
- message - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.
- message - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.
- message - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Define the RegExp for matching against the message of the check associated with an audit event.
- message - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Define a Regular Expression matched against the message of the check associated with an audit event.
- message(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
-
Specifies message to use when reporting a match and returns Builder object.
- MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Name of the message element.
- MESSAGE_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The placeholder for message.
- MESSAGE_QUERY_MAP - Static variable in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
-
Map from
Violation
objects to xpath queries. - messageArguments - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage
-
Error message arguments.
- messageDispatcher - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
The dispatcher errors are fired to.
- MessageDispatcher - Interface in com.puppycrawl.tools.checkstyle.api
-
Used by FileSetChecks to distribute AuditEvents to AuditListeners.
- messageFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Specify message pattern to suppress.
- messageFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Define message pattern to suppress.
- messageFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Specify message pattern to suppress.
- messageKey - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage
-
Key for error message.
- messagePattern - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Specify check violation message pattern to suppress.
- messageRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
The regexp to match message names against.
- messageRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
The regexp to match message names against.
- messages - Variable in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
The map containing custom messages.
- META_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Meta tag name.
- META_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Meta html tag.
- METADATA - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Name of the message element.
- MetadataGenerationException - Exception in com.puppycrawl.tools.checkstyle.meta
-
Exception for metadata generation errors.
- MetadataGenerationException(String) - Constructor for exception com.puppycrawl.tools.checkstyle.meta.MetadataGenerationException
-
Creates a new
MetadataGenerationException
instance. - MetadataGeneratorLogger - Class in com.puppycrawl.tools.checkstyle
-
Simple logger for metadata generator util.
- MetadataGeneratorLogger(OutputStream, AbstractAutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.MetadataGeneratorLogger
-
Creates a new MetadataGeneratorLogger instance.
- MetadataGeneratorUtil - Class in com.puppycrawl.tools.checkstyle.meta
-
Class which handles all the metadata generation and writing calls.
- MetadataGeneratorUtil() - Constructor for class com.puppycrawl.tools.checkstyle.meta.MetadataGeneratorUtil
-
Stop instances being created.
- method - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck.MethodNode
-
Method definition.
- METHOD_CALL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A method call.
- METHOD_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A method declaration.
- METHOD_FRAME - com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
-
Method frame type.
- METHOD_MAX_NCSS - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Default constant for max method ncss.
- METHOD_REF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A reference to a method or constructor without arguments.
- MethodCallHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for method calls.
- MethodCallHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- methodCalls - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Set of equals calls.
- MethodCountCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Checks the number of methods declared in each type declaration by access modifier or total count.
- MethodCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
- MethodCountCheck.MethodCounter - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Marker class used to collect data about the number of methods per class.
- MethodCounter(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
-
Creates an interface.
- MethodDefHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for method definitions.
- MethodDefHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.MethodDefHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- MethodFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.MethodFrame
-
Creates method frame.
- MethodLengthCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Checks for long methods and constructors.
- MethodLengthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
- methodMaximum - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Specify the maximum allowed number of non commenting lines in a method.
- methodModifier - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.SynchronizedHandler
-
Determine that "synchronized" token used as modifier of method.
- MethodNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that method names conform to a specified pattern.
- MethodNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
-
Creates a new
MethodNameCheck
instance. - MethodNode(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck.MethodNode
-
Constructs a stack node for a method definition.
- MethodParamPadCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks the padding between the identifier of a method definition, constructor definition, method call, constructor invocation, record, or record pattern; and the left parenthesis of the parameter list.
- MethodParamPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
- methodStack - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
Stack of methods.
- MethodTypeParameterNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that method type parameter names conform to a specified pattern.
- MethodTypeParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.MethodTypeParameterNameCheck
-
Creates a new
MethodTypeParameterNameCheck
instance. - minimum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Minimum number of times regular expression should occur in a file.
- minimum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Specify the minimum number of matches required in each file.
- minimum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Specify the minimum number of matches required in each file.
- minimum - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Specify the minimum number of matches required in each file.
- minimum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
-
Specifies the minimum allowed number of detections and returns Builder object.
- minimumDepth - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Specify the minimum depth for descendant counts.
- minimumMessage - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Define the violation message when the minimum count is not reached.
- minimumNumber - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Specify a minimum count for descendants.
- minLineCount - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Control the minimal amount of lines in method to allow no documentation.
- MINUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
-
(subtraction) operator. - MINUS_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
-=
(subtraction assignment) operator. - MismatchStrategy - Enum in com.puppycrawl.tools.checkstyle.checks.imports
-
Represents the strategy when none of the rules (allow/disallow tags) match inside subpackage and import-control tag of ImportControlCheck config.
- MismatchStrategy() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.imports.MismatchStrategy
- MissingCtorCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that classes (except abstract ones) define a constructor and don't rely on the default one.
- MissingCtorCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck
- MissingDeprecatedCheck - Class in com.puppycrawl.tools.checkstyle.checks.annotation
-
Verifies that the annotation
@Deprecated
and the Javadoc tag@deprecated
are both present when either of them is present. - MissingDeprecatedCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
- MissingJavadocMethodCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks for missing Javadoc comments for a method or constructor.
- MissingJavadocMethodCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
- MissingJavadocPackageCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks for missing package definition Javadoc comments in package-info.java files.
- MissingJavadocPackageCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
- MissingJavadocTypeCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.
- MissingJavadocTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
- MissingNullCaseInSwitchCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that a given switch statement or expression that use a reference type in its selector expression has a
null
case label. - MissingNullCaseInSwitchCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
- MissingOverrideCheck - Class in com.puppycrawl.tools.checkstyle.checks.annotation
-
Verifies that the
@Override
annotation is present when the@inheritDoc
javadoc tag is present. - MissingOverrideCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
- MissingSwitchDefaultCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that switch statement has a
default
clause. - MissingSwitchDefaultCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
- MOD - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
%
(remainder) operator. - MOD_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
%=
(remainder assignment) operator. - model - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
Checkstyle frame model.
- ModifiedControlVariableCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that for loop control variables are not modified inside the for block.
- ModifiedControlVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
- ModifierOrderCheck - Class in com.puppycrawl.tools.checkstyle.checks.modifier
-
Checks that the order of modifiers conforms to the suggestions in the Java Language specification, § 8.1.1, 8.3.1, 8.4.3 and 9.4.
- ModifierOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
- MODIFIERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Modifiers for type, method, and field declarations.
- modifyVariablesStack(UnusedLocalVariableCheck.TypeDeclDesc, Deque<UnusedLocalVariableCheck.VariableDesc>, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Add non-private instance and class variables of the super class of the anonymous class to the variables stack.
- MODULE - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Module elements.
- MODULE_DETAILS_STORE - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Module details store used for testing.
- MODULE_SUPER_CLASS_FILES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
List of files who are superclasses and contain certain properties that checks inherit.
- moduleClassLoader - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
The classloader used for loading Checkstyle module classes.
- moduleClassLoader - Variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
The class loader used to load Checkstyle core and custom modules.
- moduleDetails - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
ModuleDetails instance for each module AST traversal.
- ModuleDetails - Class in com.puppycrawl.tools.checkstyle.meta
-
Simple POJO class for module details.
- ModuleDetails() - Constructor for class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
- moduleFactory - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
The factory for instantiating submodules.
- moduleFactory - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
A factory for creating submodules (i.e. the Checks)
- ModuleFactory - Interface in com.puppycrawl.tools.checkstyle
-
A module factory creates Objects from a given name.
- moduleId - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
The id of the module generating the violation.
- moduleId - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Module id filter.
- moduleId - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Module id filter.
- moduleLoadOption - Variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Module load option which defines class search type.
- ModuleLoadOption() - Constructor for enum com.puppycrawl.tools.checkstyle.PackageObjectFactory.ModuleLoadOption
- moduleName - Static variable in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
-
Name of the module being scraped.
- ModulePropertyDetails - Class in com.puppycrawl.tools.checkstyle.meta
-
Simple POJO class module's property details.
- ModulePropertyDetails() - Constructor for class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
- ModuleReflectionUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Contains utility methods for module reflection.
- ModuleReflectionUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
Prevent instantiation.
- moduleType - Variable in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Type of the module(check/filter/filefilter).
- ModuleType - Enum in com.puppycrawl.tools.checkstyle.meta
-
Enum holding the types of module which can exist.
- ModuleType(String) - Constructor for enum com.puppycrawl.tools.checkstyle.meta.ModuleType
-
Creates a new instance.
- MSG_ACCESS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ANNOTATION_ORDER - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_BLOCK_TAG_LOCATION - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_CHILD_ERROR - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_CHILD_ERROR_MULTI - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_CLASS - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_CLASS_INFO - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_CONSTRUCTOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_CONTAINS_TAB - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_CTOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidNoArgumentSuperConstructorCallCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_DESC_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_DISALLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_DUPLICATE - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_DUPLICATE_REGEXP - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_DUPLICATE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_EMPTY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Message property key for the Empty Javadoc message.
- MSG_EMPTY - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_EQUALS_AVOID_NULL - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_EQUALS_IGNORE_CASE_AVOID_NULL - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ERROR - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ERROR_MULTI - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_EXPECTED_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_EXPR - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_EXTRA_HTML - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Message property key for the Extra HTML message.
- MSG_FALL_THROUGH - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_FALL_THROUGH_LAST - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_FILE - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_FILE_CONTAINS_TAB - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_HEADER_MISMATCH - Static variable in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_HEADER_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_IDENT - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ILLEGAL_ABSTRACT_CLASS_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ILLEGAL_REGEXP - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_INCOMPLETE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Message property key for the Incomplete Tag message.
- MSG_INSTANCE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_INVALID_INHERIT_DOC - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_INVALID_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
-
Message key for invalid pattern violation.
- MSG_IO_EXCEPTION_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Localization key for IO exception occurred on file open.
- MSG_IO_EXCEPTION_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck
-
Localization key for IO exception occurred on file open.
- MSG_JAVADOC_CONTENT_FIRST_LINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_JAVADOC_CONTENT_SECOND_LINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_JAVADOC_MISSED_HTML_CLOSE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Message key of error message.
- MSG_JAVADOC_MISSED_HTML_CLOSE - Static variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Message key of error message.
- MSG_JAVADOC_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_JAVADOC_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_JAVADOC_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_JAVADOC_PARSE_RULE_ERROR - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Parse error while rule recognition.
- MSG_JAVADOC_PARSE_RULE_ERROR - Static variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Parse error while rule recognition.
- MSG_JAVADOC_TAG_LINE_BEFORE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
-
The key in "messages.properties" for the message that describes a tag in javadoc requiring an empty line before it.
- MSG_JAVADOC_WRONG_SINGLETON_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Message key of error message.
- MSG_JAVADOC_WRONG_SINGLETON_TAG - Static variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Message key of error message.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
-
A key is pointing to the warning message text provided by user.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.NoArrayTrailingCommaCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.NoEnumTrailingCommaCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Warning message key.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.SealedShouldHavePermitsListCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Warning message key.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Localization key for check violation.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
A key is pointing to the warning message text for missing key in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck
-
Localization key for check violation.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_INCORRECT_STYLE - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_LOCATION - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_LOCATION_ALONE - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_MISSING_DEPRECATED - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_MISSING_OVERRIDE - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_ON_SAME_LINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_PARENS_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_PARENS_PRESENT - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_TRAILING_COMMA_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_ANNOTATION_TRAILING_COMMA_PRESENT - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_BLOCK - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_BLOCK_EMPTY - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_BLOCK_NESTED - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_BLOCK_NO_STATEMENT - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_CATCH_BLOCK_EMPTY - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_EQUALS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_EXT - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Warning message key.
- MSG_KEY_HASHCODE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_JAVADOC_DUPLICATE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_LINE_ALONE - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_LINE_BREAK_AFTER - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_LINE_BREAK_BEFORE - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_LINE_NEW - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_LINE_PREVIOUS - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_LINE_SAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_MIN - Static variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_MISMATCH - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_MISSING_TRANSLATION_FILE - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
A key is pointing to the warning message text for missing translation file in "messages.properties" file.
- MSG_KEY_NEED_BRACES - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_NO_CODE - Static variable in class com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_NO_NEWLINE_EOF - Static variable in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_SINGLE - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_SKIP_IF_LAST_AND_SHARED_WITH_CASE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_SUM_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_SUM_MIN - Static variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_SUPPRESSED_WARNING_NOT_ALLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_TAG_NOT_VALID_ON - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_UNABLE_OPEN - Static variable in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_KEY_UNCLOSED_HTML_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Message key of error message.
- MSG_KEY_VOID - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
A key pointing to the warning message text in "messages.properties" file.
- MSG_KEY_WRONG_ENDING - Static variable in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LAMBDA - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LANG - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LEGACY_PACKAGE_HTML - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LEX - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LINE_BEFORE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LINE_NEW - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LINE_NEW - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LINE_PREVIOUS - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LINE_PREVIOUS - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LINE_PREVIOUS - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LINE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MANY_METHODS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MATCH - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_METHOD - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_METHOD - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISMATCH - Static variable in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISMATCH - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISPLACED_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISSING_ASTERISK - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISSING_FILE - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISSING_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MISSING_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MODIFIER_ORDER - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MULTIPLE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MULTIPLE_COMMA - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_MULTIPLE_LINES - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
A key is pointing to the warning message empty.line.separator.multiple.lines in "messages.properties" file.
- MSG_MULTIPLE_LINES_AFTER - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
A key is pointing to the warning message empty.line.separator.lines.after in "messages.properties" file.
- MSG_MULTIPLE_LINES_INSIDE - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
A key is pointing to the warning message empty.line.separator.multiple.lines.inside in "messages.properties" file.
- MSG_NO_ABSTRACT_CLASS_MODIFIER - Static variable in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_NO_PERIOD - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Message property key for the No Javadoc end of Sentence Period message.
- MSG_NONGROUP_EXPECTED - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_NONGROUP_IMPORT - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_NOT_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ORDER - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_ORDERING - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PACKAGE_INFO - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PACKAGE_METHODS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PKG_JAVADOC_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PRECEDED_BLOCK_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PRIVATE_METHODS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PROTECTED_METHODS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_PUBLIC_METHODS - Static variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_RECORD - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_REDUNDANT_PARAGRAPH - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_REGEXP_EXCEEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_REGEXP_EXCEEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_REGEXP_MINIMUM - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_REGEXP_MINIMUM - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_REQUIRED_REGEXP - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_RETURN - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_RETURN_EXPECTED - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SEMI - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterOuterTypeDeclarationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SEMI - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SEMI - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SEMI - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SEPARATED_IN_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SEPARATED_IN_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SEPARATION - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SHOULD_BE_SEPARATED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
A key is pointing to the warning message empty.line.separator in "messages.properties" file.
- MSG_STACKOVERFLOW - Static variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_STATIC - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_STRING - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SUMMARY_FIRST_SENTENCE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SUMMARY_JAVADOC - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SUMMARY_JAVADOC_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_SUMMARY_MISSING_PERIOD - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_TAG_AFTER - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_TAG_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_TAG_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNCLOSED_HTML - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Message property key for the Unclosed HTML message.
- MSG_UNCLOSED_HTML_TAG - Static variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Message property key for the Unclosed HTML message.
- MSG_UNKNOWN_PKG - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNKNOWN_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_CATCH_PARAMETER - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_LAMBDA_PARAMETER - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_LOCAL_VARIABLE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_NAMED_LOCAL_VARIABLE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_TAG_GENERAL - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_UNUSED_TAG_GENERAL - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_VARIABLE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WRITE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_FOLLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_FOLLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_FOLLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_ILLEGAL_FOLLOW - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_FOLLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_FOLLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_FOLLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_FOLLOWED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_NOT_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_PRECEDED - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MSG_WS_TYPECAST - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
-
A key is pointing to the warning message text in "messages.properties" file.
- MULTI_THREAD_CHECKER_MODULE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
A multi thread checker module name.
- MULTI_THREAD_TREE_WALKER_MODULE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
A multi thread three walker module name.
- MultilineDetector - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
A detector that matches across multiple lines.
- MultilineDetector(DetectorOptions) - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
Creates an instance.
- multiLines - Variable in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
Specify the line numbers to repeat (zero or more times).
- MultipleStringLiteralsCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks for multiple occurrences of the same string literal within a single file.
- MultipleStringLiteralsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
Construct an instance with default values.
- MultipleVariableDeclarationsCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that each variable declaration is in its own statement and on its own line.
- MultipleVariableDeclarationsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
-
Decides whether the name of an AST should be checked against the format regexp.
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.CatchParameterNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.IllegalIdentifierNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.InterfaceTypeParameterNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LambdaParameterNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodTypeParameterNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PatternVariableNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordComponentNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.RecordTypeParameterNameCheck
- mustCheckName(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck
- MutableExceptionCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Ensures that exception classes (classes with names conforming to some pattern and explicitly extending classes with names conforming to other pattern) are immutable, that is, that they have only final fields.
- MutableExceptionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- MUTATION_OPERATIONS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Operations which can change control variable in update part of the loop.
N
- name - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
The name of the catch parameter.
- name - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
The name of the variable.
- name - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
-
The name for the file.
- name - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag
-
The name of the invalid tag.
- name - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ClassInfo
-
FullIdent
associated with this class. - name - Variable in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
The tag name.
- name - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
Name of the tag ("link", "see", etc).
- name - Variable in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
The name of this configuration.
- name - Variable in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Name of the module.
- name - Variable in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Name of property.
- name - Variable in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
The name of the attribute.
- NAME - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Name attribute.
- NAME_ATTRIBUTE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Name for attribute 'name'.
- NAME_TO_FULL_MODULE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Map of Checkstyle module names to their fully qualified names.
- NAME_TO_TAG - Static variable in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Holds tag name to tag enum mappings.
- nameToValueMapFromPublicIntFields(Class<?>) - Static method in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Creates a map of 'field name' to 'field value' from all
public
int
fields of a class. - NAMING - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'naming'.
- nearbyTextPattern - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Specify nearby text pattern to trigger filter to begin suppression.
- NeedBracesCheck - Class in com.puppycrawl.tools.checkstyle.checks.blocks
-
Checks for braces around code blocks.
- NeedBracesCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
- needSeparator(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Checks whether import groups should be separated.
- NestedForDepthCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Restricts nested
for
blocks to a specified depth. - NestedForDepthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
- NestedIfDepthCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Restricts nested if-else blocks to a specified depth.
- NestedIfDepthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
- NestedTryDepthCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Restricts nested try-catch-finally blocks to a specified depth.
- NestedTryDepthCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
- NEVER - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ClosingParensOption
-
Without parens example
- NEVER - com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.TrailingArrayCommaOption
-
Without comma example
- NeverSuppress - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
An implementation of
MatchSuppressor
that never suppresses a match. - NeverSuppress() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.NeverSuppress
-
Stop creation of instances.
- newBuilder() - Static method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Returns new Builder object.
- newBundle(String, Locale, String, ClassLoader, boolean) - Method in class com.puppycrawl.tools.checkstyle.LocalizedMessage.Utf8Control
- NewHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for operator new.
- NewHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Newline symbol - '\n'.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Newline pattern.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Compiled pattern used to match newline control characters, for replacement.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Compiled pattern used to match preceding newline in text block content.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
The newline character.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Newline character.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink.CustomPrintWriter
-
Unix-Style newline character.
- NEWLINE - Static variable in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Newline pattern.
- NEWLINE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Pattern matching a newline.
- NEWLINE_TO_TAG - Static variable in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
-
This regexp is used to convert new line to newline tag.
- NewlineAtEndOfFileCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Checks whether files end with a line separator.
- NewlineAtEndOfFileCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
- next() - Method in class com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator
-
Get the next item in the sequence.
- next() - Method in class com.puppycrawl.tools.checkstyle.xpath.iterators.FollowingIterator
-
Get the next item in the sequence.
- next() - Method in class com.puppycrawl.tools.checkstyle.xpath.iterators.PrecedingIterator
-
Get the next item in the sequence.
- next() - Method in class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseDescendantIterator
-
Get the next item in the sequence.
- next() - Method in class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseListIterator
-
Get the next item in the sequence.
- NEXT_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Multiline finished at next Javadoc.
- nextSibling - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
First sibling of this DetailAST.
- nextTag() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Returns the next available HtmlTag.
- nextToken - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Next token.
- NL - com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
-
Represents the policy that the brace must always be on a new line.
- NL - com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption
-
Require that the token is on a new line.
- NLOW - com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
-
Represents the policy that if the brace will fit on the first line of the statement, then apply
EOL
rule. - NoArrayTrailingCommaCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that array initialization do not contain a trailing comma.
- NoArrayTrailingCommaCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NoArrayTrailingCommaCheck
- NoCloneCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that the clone method is not overridden from the Object class.
- NoCloneCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck
- NoCodeInFileCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Checks whether file contains code.
- NoCodeInFileCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck
- node - Variable in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
-
DetailAST or DetailNode node.
- nodeForRow(int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
-
Finds node for a given row.
- NoEnumTrailingCommaCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that enum definition does not contain a trailing comma.
- NoEnumTrailingCommaCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NoEnumTrailingCommaCheck
- NoFinalizerCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that there is no method
finalize
with zero parameters. - NoFinalizerCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck
- NoLineWrapCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks that chosen statements are not line-wrapped.
- NoLineWrapCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck
- NON_BASE_TOKEN_PROPERTIES - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Set of properties not inherited from the base token configuration.
- NON_GROUP_RULE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
NON_GROUP group name.
- NON_PRINTABLE_CHARS - Static variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Regular expression for non-printable unicode chars.
- NONE - com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions
-
Do nothing in the end.
- NONE - com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
-
Deprecated.Do nothing in the end.
- NONE - com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler.LineWrappingOptions
-
First line's indentation should be checked.
- NonEmptyAtclauseDescriptionCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that the block tag is followed by description.
- NonEmptyAtclauseDescriptionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck
- NOSPACE - com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
-
Represents no spacing following a left parenthesis or preceding a right one.
- NOT_EQUAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
!=
(not equal) operator. - NOT_EXIST - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.AnnotationArrayInitHandler
-
Constant to define that the required character does not exist at any position.
- NOT_EXIST - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler
-
Constant to define that the required character does not exist at any position.
- NOT_INITIALIZED - Static variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Constant to indicate if not calculated the child count.
- NOTHING - com.puppycrawl.tools.checkstyle.api.Scope
-
Nothing scope.
- notifyBegin(DetailAST, FileContents, TreeWalker.AstState) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Notify checks that we are about to begin walking a tree.
- notifyEnd(DetailAST, TreeWalker.AstState) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Notify checks that we have finished walking a tree.
- notifyLeave(DetailAST, TreeWalker.AstState) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Notify checks that leaving a node.
- notifyVisit(DetailAST, TreeWalker.AstState) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Notify checks that visiting a node.
- NoWhitespaceAfterCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks that there is no whitespace after a token.
- NoWhitespaceAfterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
- NoWhitespaceBeforeCaseDefaultColonCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks that there is no whitespace before the colon in a switch block.
- NoWhitespaceBeforeCaseDefaultColonCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
- NoWhitespaceBeforeCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks that there is no whitespace before a token.
- NoWhitespaceBeforeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
- NPathComplexityCheck - Class in com.puppycrawl.tools.checkstyle.checks.metrics
-
Checks the NPATH complexity against a specified limit.
- NPathComplexityCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
- NPathComplexityCheck.TokenEnd - Class in com.puppycrawl.tools.checkstyle.checks.metrics
-
Coordinates of token end.
- NPathComplexityCheck.Values - Class in com.puppycrawl.tools.checkstyle.checks.metrics
-
Class that store range value and expression value.
- NULL_LOADER_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Exception message when null class loader is given.
- NULL_PACKAGE_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Exception message when null package name is given.
- NUM_DOUBLE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A double precision floating point literal.
- NUM_FLOAT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A single precision floating point literal.
- NUM_INT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An integer literal.
- NUM_LONG - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A long integer literal.
O
- OBJBLOCK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An object block.
- objBlockWithEquals - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
-
Maps OBJ_BLOCK to the method definition of equals().
- objBlockWithHashCode - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
-
Maps OBJ_BLOCKs to the method definition of hashCode().
- ObjectBlockHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for inner classes.
- ObjectBlockHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.ObjectBlockHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- ofBoolean(boolean) - Static method in enum com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler.LineWrappingOptions
-
Builds enum value from boolean.
- OFF - com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.TagType
-
Switch reporting off.
- OFF - com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.SuppressionType
-
Off suppression type.
- offCommentFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Specify comment pattern to trigger filter to begin suppression.
- offCommentFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Specify comment pattern to trigger filter to begin suppression.
- offset - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
-
Specify how many spaces to use for new indentation level.
- offset - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.DescriptiveErrorListener
-
Offset is line number of beginning of the Javadoc comment.
- OMIT - com.puppycrawl.tools.checkstyle.ConfigurationLoader.IgnoredModulesOptions
-
Omit ignored modules.
- omitIgnoredModules - Variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Flags if modules with the severity 'ignore' should be omitted.
- ON - com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.TagType
-
Switch reporting on.
- ON - com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.SuppressionType
-
On suppression type.
- onCommentFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Specify comment pattern to trigger filter to end suppression.
- onCommentFormat - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Specify comment pattern to trigger filter to end suppression.
- OneStatementPerLineCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that there is only one statement per line.
- OneStatementPerLineCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
- OneTopLevelClassCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Checks that each top-level class, interface, enum or annotation resides in a source file of its own.
- OneTopLevelClassCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
- ONLY_TAG_VARIATION_1 - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
-
Case when space separates the tag and the asterisk like in the below example.
- ONLY_TAG_VARIATION_2 - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
-
Case when no space separates the tag and the asterisk like in the below example.
- OnlyCheckstyleLoggersFilter() - Constructor for class com.puppycrawl.tools.checkstyle.Main.OnlyCheckstyleLoggersFilter
- onlyObjectReferences - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
Control whether only explicit initializations made to null for objects should be checked.
- OPEN_ANGLE_BRACKET - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Open angle bracket literal.
- OPEN_ANGLE_BRACKET - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Open angle bracket literal.
- OPEN_CURLY_BRACE - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Open curly brace literal.
- OPEN_PARENTHESIS - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
Open parenthesis literal.
- openFile(File) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
Open file and load it.
- openFile(File) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Open file and load the file.
- OperatorWrapCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks the policy on how to wrap lines on operators.
- OperatorWrapCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
- OPTGROUP - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`optgroup` html tag.
- OPTGROUP_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`optgroup` tag name.
- OPTGROUP_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`optgroup` tag end.
- OPTGROUP_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`optgroup` tag start.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
-
Specify the policy on block contents.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Specify the policy on placement of a left curly brace (
'{'
). - option - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Specify the policy on placement of a right curly brace (
'}'
). - option - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Specify policy on the relative order between type imports and static imports.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
The policy to enforce.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
-
Specify policy on how to pad an empty for iterator.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
-
Specify policy on how to pad an empty for iterator.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
-
Specify policy on how to pad method parameter.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Specify policy on how to wrap lines.
- option - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
-
Specify policy on how to wrap lines.
- OPTION - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Option html tag.
- OPTION_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Option tag name.
- OPTION_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End option tag.
- OPTION_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start option tag.
- optional - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
-
Control what to do when the file is not existing.
- optional - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
-
Control what to do when the file is not existing.
- options - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
The detection options to use.
- options - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
-
The detection options to use.
- Options() - Constructor for enum com.puppycrawl.tools.checkstyle.JavaParser.Options
- ordered - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Control whether type imports within each group should be sorted.
- OrderedPropertiesCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Detects if keys in properties files are in correct order.
- OrderedPropertiesCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Construct the check with default values.
- OrderedPropertiesCheck.SequencedProperties - Class in com.puppycrawl.tools.checkstyle.checks
-
Private property implementation that keeps order of properties like in file.
- orderProperties(Set<String>) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Reorder properties to always have the 'tokens' property last (if present).
- ORDINARY - com.puppycrawl.tools.checkstyle.TreeWalker.AstState
-
Ordinary tree.
- ordinaryChecks - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Registered ordinary checks, that don't use comment nodes.
- OsSpecificUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Class which provides OS related utilities.
- OsSpecificUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.OsSpecificUtil
-
Hiding public and default constructor.
- outerNum - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
-
Tracks the number of outer types found.
- OuterTypeFilenameCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Checks that the outer type name and the file name match.
- OuterTypeFilenameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
- OuterTypeNumberCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Checks for the number of types declared at the outer (or root) level in a file.
- OuterTypeNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
- OUTPUT_FORMAT_OPTION - Static variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Option name for output format.
- outputFile - Variable in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator.CliOptions
-
The command line option to specify the output file.
- OutputFormat() - Constructor for enum com.puppycrawl.tools.checkstyle.Main.OutputFormat
- outputPath - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Output file location.
- OutputStreamOptions() - Constructor for enum com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions
- OutputStreamOptions() - Constructor for enum com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
-
Deprecated.
- OverloadMethodsDeclarationOrderCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that overloaded methods are grouped together.
- OverloadMethodsDeclarationOrderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck
- OVERRIDE - Static variable in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
-
Override
annotation name. - OVERRIDE_ANNOTATIONS - Static variable in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
-
Simple and fully-qualified
Override
annotation names. - overrideProps - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Contains the Properties to override.
- overridePropsResolver - Variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Property resolver.
P
- P_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Paragraph tag name.
- P_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End paragraph tag.
- P_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start paragraph tag.
- PACKAGE - com.puppycrawl.tools.checkstyle.api.Scope
-
Package or default scope.
- PACKAGE - com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Package access modifier.
- PACKAGE_ACCESS_MODIFIER - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Name for implicit 'package' access modifier.
- PACKAGE_CLASS - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
PACKAGE_CLASS represents the package or class which has been referenced in the `@see`, `@link`, `@linkplain` or `@value` javadoc tags.
- PACKAGE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The package declaration.
- PACKAGE_ELEMENT_NAME - Static variable in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
-
Qualified name for element 'package'.
- PACKAGE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Package separator.
- PACKAGE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Character separate package names in qualified name of java class.
- PACKAGE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Character separate package names in qualified name of java class.
- PACKAGE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Package separator.
- packageAllowed - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Control whether package visible members are allowed.
- PackageAnnotationCheck - Class in com.puppycrawl.tools.checkstyle.checks.annotation
-
Checks that all package annotations are in the package-info.java file.
- PackageAnnotationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck
- PackageDeclarationCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Ensures that a class has a package declaration, and (optionally) whether the package name matches the directory name for the source file.
- PackageDeclarationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
- PackageDefHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for package definitions.
- PackageDefHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.PackageDefHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- packageName - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Name of the package.
- packageName - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Full qualified name of the package.
- packageName - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
The package doing the import.
- packageName - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Current file package.
- packageName - Variable in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
Current package.
- packageName - Variable in class com.puppycrawl.tools.checkstyle.Main.OnlyCheckstyleLoggersFilter
-
Name of the package used to filter on.
- PackageNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that package names conform to a specified pattern.
- PackageNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
- packageNames - Variable in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
-
The fully qualified package names.
- PackageNamesLoader - Class in com.puppycrawl.tools.checkstyle
-
Loads a list of package names from a package name XML file.
- PackageNamesLoader() - Constructor for class com.puppycrawl.tools.checkstyle.PackageNamesLoader
-
Creates a new
PackageNamesLoader
instance. - PackageObjectFactory - Class in com.puppycrawl.tools.checkstyle
-
A factory for creating objects from package names and names.
- PackageObjectFactory(String, ClassLoader) - Constructor for class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Creates a new
PackageObjectFactory
instance. - PackageObjectFactory(Set<String>, ClassLoader) - Constructor for class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Creates a new
PackageObjectFactory
instance. - PackageObjectFactory(Set<String>, ClassLoader, PackageObjectFactory.ModuleLoadOption) - Constructor for class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Creates a new
PackageObjectFactory
instance. - PackageObjectFactory.ModuleLoadOption - Enum in com.puppycrawl.tools.checkstyle
-
Enum class to define loading options.
- packages - Variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Package names to prepend to class names.
- packageStack - Variable in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
-
The temporary stack of package name parts.
- PadOption - Enum in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Represents the options for whitespace around parentheses.
- PadOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
- paint(Graphics) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
Subclassed to translate the graphics such that the last visible row will be drawn at 0,0.
- PARAGRAPH - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Paragraph html tag:
<p></p>
. - PARAM - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@param
. - PARAM_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Param tag name.
- PARAM_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@param' literal in
@param
Javadoc tag. - PARAM_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Param html tag.
- PARAMETER_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A parameter declaration.
- PARAMETER_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
First argument in
@param
Javadoc tag. - ParameterAssignmentCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Disallows assignment of parameters.
- ParameterAssignmentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
- parameterDefinition - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
Ast of type
TokenTypes.PARAMETER_DEF
to use it when logging. - ParameterNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that method parameter names conform to a specified pattern.
- ParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
Creates a new
ParameterNameCheck
instance. - parameterNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
Current set of parameters.
- parameterNamesStack - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
Stack of methods' parameters.
- ParameterNumberCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Checks the number of parameters of a method or constructor.
- ParameterNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
- PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Parameters part in
JavadocTokenTypes.REFERENCE
. - PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A list of parameters to a method or constructor.
- ParenPadCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks the policy on the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden.
- ParenPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Initializes acceptableTokens.
- parent - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Parent frame.
- parent - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
-
Parent frame.
- parent - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Parent frame.
- parent - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
-
The parent.
- parent - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
-
Parent frame.
- parent - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Containing AST handler.
- parent - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Parent node.
- parent - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
The parent token.
- parent - Variable in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Parent module.
- parent - Variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
The parent of the current node.
- PARENT_TAG - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Regular expression for module parent location in class-level javadocs.
- PARENT_TOKEN_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
-
Parent token types.
- ParentModuleMacro - Class in com.puppycrawl.tools.checkstyle.site
-
A macro that inserts a link to the parent module.
- ParentModuleMacro() - Constructor for class com.puppycrawl.tools.checkstyle.site.ParentModuleMacro
- parentSectionStartIdx - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Child number of the parent section node, where parent is the class level javadoc root node.
- parentToSkip - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Used to test if logging a warning in a parent node may be skipped because a warning was already logged on an immediate child node.
- parse(FileContents) - Static method in class com.puppycrawl.tools.checkstyle.JavaParser
-
Static helper method to parses a Java source file.
- parse(Reader, Sink, String) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
- PARSE_EXCEPTION_MSG - Static variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Message to use when an exception occurs and should be printed as a violation.
- parseAndPrintJavadocTree(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Parses block comment as javadoc and prints its tree.
- parseClassNames(String...) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Create set of class names and short class names.
- parseDouble(String, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Returns the value represented by the specified string of the specified type.
- parseErrorMessage - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
Parse error message (is null if parsing is successful).
- ParseErrorMessage(int, String, Object...) - Constructor for class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseErrorMessage
-
Initializes parse error message.
- parseFile(File) - Static method in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
Parse a file and return the parse tree.
- parseFile(File, JavaParser.Options) - Static method in class com.puppycrawl.tools.checkstyle.JavaParser
-
Parses Java source file.
- parseFileText(FileText, JavaParser.Options) - Static method in class com.puppycrawl.tools.checkstyle.JavaParser
-
Parse a text and return the parse tree.
- parseInfluence(String, String, String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
Gets influence from suppress filter influence format param.
- parseInputSource(InputSource) - Method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Parses the specified input source loading the configuration information.
- parseInputSource(InputSource) - Method in class com.puppycrawl.tools.checkstyle.XmlLoader
-
Parses the specified input source.
- parseJavadocAsDetailNode(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
Parse block comment DetailAST as Javadoc DetailNode tree.
- parseJavadocAsDetailNode(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
-
Parses Javadoc comment as DetailNode tree.
- parseJavadocAsDetailNode(String) - Static method in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
Parse javadoc comment to DetailNode tree.
- parseJavadocTree(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Parses Javadoc (DetailNode) tree of specified block comments.
- parseMode - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Current mode.
- parseMode - Variable in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Parsing mode.
- ParseMode(String) - Constructor for enum com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
-
Provides description.
- parseNumber(String, int, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Parses the string argument as an integer or a long in the radix specified by the second argument.
- parsePropertyString(String, Collection<String>, Collection<String>) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Parses a string containing
${xxx}
style property references into two collections. - parser - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck.FileContext
-
Parses content of Javadoc comment as DetailNode tree.
- parser - Variable in class com.puppycrawl.tools.checkstyle.XmlLoader
-
Parser to read XML files.
- parseRange(String, String, String) - Static method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
Gets range from suppress filter range format param.
- ParserUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Contains utility methods for parser to use while creating ast.
- ParserUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.ParserUtil
-
Stop instances being created.
- ParseStatus() - Constructor for class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
- parseTag(String[], int, int, TagParser.Point) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Parses the tag and return position after it.
- parseTags(String[], int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Parses the text line for any HTML tags and adds them to the internal List of tags.
- parseTreeTableModel - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Parse tree model.
- ParseTreeTableModel - Class in com.puppycrawl.tools.checkstyle.gui
-
The model that backs the parse tree in the GUI.
- ParseTreeTableModel(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
-
Initialise pModel.
- ParseTreeTablePresentation - Class in com.puppycrawl.tools.checkstyle.gui
-
The model that backs the parse tree in the GUI.
- ParseTreeTablePresentation(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Constructor initialise root node.
- path - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
Specify the regular expression of file paths to which this check should apply.
- path - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
-
Common path of files which are included in the resource bundle.
- PATH_TO_JAVADOC_TOKEN_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The path to the JavadocTokenTypes.html file.
- PATH_TO_TOKEN_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The path to the TokenTypes.html file.
- paths - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Contains the paths to process.
- pattern - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Pattern created from format.
- PATTERN - com.puppycrawl.tools.checkstyle.PropertyType
-
This property is a regular expression pattern.
- PATTERN_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A pattern definition, excluding simple type pattern (pattern variable) definition such as
if (o instanceof Integer i){}
. - PATTERN_VARIABLE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A pattern variable definition; when conditionally matched, this variable is assigned with the defined type.
- PatternArrayConverter() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.PatternArrayConverter
- PatternConverter() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.PatternConverter
- patternForExactMatch - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
-
The regex pattern for exact matches - only not null if regex is true.
- patternForExactMatch - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
The regex pattern for exact matches - only not null if regex is true.
- patternForPartialMatch - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
The regex pattern for partial match (exact and for subpackages) - only not null if regex is true.
- PatternVariableNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that pattern variable names conform to a specified pattern.
- PatternVariableNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.PatternVariableNameCheck
-
Creates a new
PatternVariableNameCheck
instance. - period - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Specify the period symbol.
- PERMITS_CLAUSE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A permits clause.
- persist() - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Cleans up the object and updates the cache file.
- PKG_ATTRIBUTE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Name for attribute 'pkg'.
- PkgImportControl - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Represents a tree of import rules for a specific package.
- PkgImportControl(PkgImportControl, String, boolean, MismatchStrategy) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
Construct a sub-package node.
- PkgImportControl(String, boolean, MismatchStrategy) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
Construct a root, package node.
- PkgImportRule - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Represents whether a package is allowed to be imported or not.
- PkgImportRule(boolean, boolean, String, boolean, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportRule
-
Constructs an instance.
- pkgName - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Name of the package.
- pkgName - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportRule
-
Package to control access to.
- pkgName - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
-
Name of package in file.
- PLAIN - com.puppycrawl.tools.checkstyle.Main.OutputFormat
-
Plain output format.
- PLAIN_JAVA - com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
-
Only Java tokens without comments.
- PLUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
+
(addition) operator. - PLUS_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
+=
(addition assignment) operator. - pModel - Variable in class com.puppycrawl.tools.checkstyle.gui.CodeSelector
-
Presentation model.
- pModel - Variable in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
-
Presentation model.
- Point(int, int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser.Point
-
Creates new
Point
instance. - pop() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
-
Pulls all referenced types up, except those that are declared in this scope.
- popCurrentVariables(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Pops given number of variables from currentVariables.
- populateModule(Element, ModuleDetails) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Populate the module detail object from XML metadata.
- popValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Pops a value off the stack and makes it the current value.
- popValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Pops values from both stack of expression values and stack of range values.
- position - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
The position within the line where this tag was found.
- position - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
Position of the tag in the given comment.
- POST_DEC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
--
(postfix decrement) operator. - POST_INC - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
++
(postfix increment) operator. - postProcessHeaderLines() - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Hook method for post-processing header lines.
- postProcessHeaderLines() - Method in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
- postProcessHeaderLines() - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
- postProcessLiteralNew(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Processes one of the collected "new" tokens when walking tree has finished.
- PrecedingIterator - Class in com.puppycrawl.tools.checkstyle.xpath.iterators
-
Recursive-free implementation of the preceding axis iterator.
- PrecedingIterator(NodeInfo) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.iterators.PrecedingIterator
-
Create an iterator over the "preceding" axis.
- previousSibling - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Previous sibling.
- previousSiblingEnum - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.PrecedingIterator
-
Preceding-sibling axis iterator.
- prevScopeUninitializedVariables - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.ScopeData
-
Contains definitions of previous scope uninitialized variables.
- primitiveDataTypes - Variable in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Contains primitive datatypes.
- PrimordialHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
A default no-op handler.
- PrimordialHandler(IndentationCheck) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.PrimordialHandler
-
Construct an instance of this handler with the given indentation check.
- printAst - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Option that controls whether to print the AST of the file.
- printAst(FileText, JavaParser.Options) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Parse a file and print the parse tree.
- printAstWithComments - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Option that controls whether to print the AST of the file including comments.
- printBranch(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Print branch info from root down to given
node
. - printFileAst(File) - Static method in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
Parse a file and print the parse tree.
- printFileAst(File, JavaParser.Options) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Parse a file and print the parse tree.
- printJavaAndJavadocTree(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Prints full tree (java + comments + javadoc) of the DetailAST.
- printJavaAndJavadocTree(File) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Prints full AST (java + comments + javadoc) of the java file.
- printJavadocTree - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Option that controls whether to print the parse tree of the javadoc comment.
- println() - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink.CustomPrintWriter
-
Enforces Unix-style newline character.
- printSuppressions(File, String, int) - Static method in class com.puppycrawl.tools.checkstyle.SuppressionsStringPrinter
-
Prints generated suppressions.
- printTree(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Print AST.
- printTree(DetailNode, String, String) - Static method in class com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter
-
Print AST.
- printTreeWithJavadoc - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Option that controls whether to print the full AST of the file.
- printXmlHeader() - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
-
Prints XML header if only it was not printed before.
- printXpathBranch(String, File) - Static method in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
-
Returns xpath query results on file as string.
- PRIVATE - com.puppycrawl.tools.checkstyle.api.Scope
-
Private scope.
- PRIVATE - com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Private access modifier.
- PRIVATE_ACCESS_MODIFIER - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Name for 'private' access modifier.
- process(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
- process(File, FileText) - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
-
Request to process a file.
- process(List<File>) - Method in interface com.puppycrawl.tools.checkstyle.api.RootModule
-
Processes a set of files.
- process(List<File>) - Method in class com.puppycrawl.tools.checkstyle.Checker
- processAbstractMethodParameters(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Process validation of parameters for Methods with no definition.
- processAST(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Called to process an AST when visiting it.
- processChildren(DetailAstImpl, List<? extends ParseTree>) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
Adds all the children from the given ParseTree or JavaParserContext list to the parent DetailAstImpl.
- processClassDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Collects classes defined in the source file.
- processConstructor(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Processes constructor.
- processCurrentFile - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
Whether to process the current file.
- processEnd(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Checks the token for the end of Generics.
- processExpression(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
- processField(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Check field in interface.
- processFile(File) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Processes a file with all FileSetChecks.
- processFile(URL, PackageNamesLoader) - Static method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
-
Reads the file provided and parses it with package names loader.
- processFiles(RootModule, SeverityLevelCounter, String) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Scans and processes files by means given root module.
- processFiles(List<File>) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Processes a list of files with all FileSetChecks.
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Called to process a file that matches the specified file extensions.
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Processes the file and check order.
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck
- processFiltered(File, FileText) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Called to process a file that matches the specified file extensions.
- processFrame(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Process CLASS_DEF, METHOD_DEF, LITERAL_IF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, LITERAL_CATCH, LITERAL_TRY, CTOR_DEF, ENUM_DEF, ENUM_CONSTANT_DEF.
- processIdent(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Checks if a given IDENT is method call or field name which requires explicit
this
qualifier. - processIdent(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Collects references made by IDENT.
- processImport(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Perform processing for an import token.
- processImport(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Collects the details of imports.
- processImport(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Process Import.
- processingTokenEnd - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Range of the last processed expression.
- processInterfaceOrAnnotation(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Do validation of interface of annotation.
- processIter(DetailAST, TreeWalker.AstState) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Processes a node calling interested checks at each node.
- processJavadoc - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Control whether to process Javadoc comments.
- processJavadocTag(JavadocTag) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Returns a list of references that found in a javadoc
JavadocTag
. - processLambda(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Process a lambda token.
- processLambdaParameters(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Process lambda parameters.
- processLeft(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
Process a token representing a left parentheses.
- processLines(FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
Processes an entire text file looking for matches.
- processLines(FileText) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
-
Processes a set of lines looking for matches.
- processLinkForTokenTypes(Sink) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a formatted link for "TokenTypes" to the given sink.
- processLiteralNew(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Determine whether LITERAL_NEW is an anonymous class definition and add it as a frame in this case.
- processLiteralNew(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Collects a "new" token.
- processMacroEnd(Sink) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
Execute a macro.
- processMacroStart(XmlPullParser) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
Handle the opening tag of a macro.
- processMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Check method in interface.
- processMethodCall(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Add the method call to the current frame if it should be processed.
- processMethods(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Process validation of Methods.
- processModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Processes modifiers.
- processModifiersState(DetailAST, DeclarationOrderCheck.ScopeState) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Process if given modifiers are appropriate in given state (
STATE_STATIC_VARIABLE_DEF
,STATE_INSTANCE_VARIABLE_DEF
, (STATE_CTOR_DEF
,STATE_METHOD_DEF
), if it is it updates states where appropriate or logs violation. - processModifiersSubState(DetailAST, DeclarationOrderCheck.ScopeState, boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Checks if given modifiers are valid in substate of given state(
Scope
), if it is it updates substate or else it logs violation. - processModule(String, File) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Scrape the Javadocs of the class and its properties setters with ClassAndPropertiesSettersJavadocScraper.
- processMultipleLinesInside(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Log violation in case there are multiple empty lines inside constructor, initialization block or method.
- processNestedGenerics(DetailAST, int[], int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Process Nested generics.
- processNestedType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Check nested types in interface.
- processPackage(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Process Package.
- processPackageDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Perform processing for an package token.
- processParamStart(XmlPullParser, Sink) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
Handle the opening tag of a parameter.
- processRegexpMatches() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Processes the regexp matches and logs the number of errors in the file.
- processResources(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Checks if given resource has redundant modifiers.
- processRight(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
Process a token representing a right parentheses.
- processSingleGeneric(DetailAST, int[], int) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Process Single-generic.
- processSlist(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Determine whether SLIST begins a block, determined by braces, and add it as a frame in this case.
- processStart(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
-
Checks the token for the start of Generics.
- processStaticImport(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Collects the details of static imports.
- processSuperclasses() - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Collect the properties setters javadocs of the superclasses.
- processThrows(Iterable<JavadocMethodCheck.ExceptionInfo>, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Verifies that documented exception is in throws.
- processTree(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Processes JavadocAST tree notifying Check.
- processVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Process a variable token.
- processVariableDef(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Process Variable.
- PROP_DEFAULT_VALUE_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Format for exception message for missing default value for check property.
- PROP_TYPE_MISSING - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Format for exception message for missing type for check property.
- properties - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
The name of the properties file.
- properties - Variable in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
List of properties of the module.
- PROPERTIES_ALLOWED_GET_TYPES_FROM_METHOD - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Properties that can not be gathered from class instance.
- PROPERTIES_TO_NOT_WRITE - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
This set contains faulty property default value which should not be written to the XML metadata files.
- PropertiesExpander - Class in com.puppycrawl.tools.checkstyle
-
Resolves external properties from an underlying
Properties
object. - PropertiesExpander(Properties) - Constructor for class com.puppycrawl.tools.checkstyle.PropertiesExpander
-
Creates a new PropertiesExpander.
- propertiesFile - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Properties file location.
- PropertiesMacro - Class in com.puppycrawl.tools.checkstyle.site
-
A macro that inserts a table of properties for the given checkstyle module.
- PropertiesMacro() - Constructor for class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
- Property() - Constructor for class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
- PROPERTY - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Property element.
- PROPERTY_TAG - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Regular expression for property location in class-level javadocs.
- PROPERTY_TYPES_XML - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Represents the relative path to the property types XML.
- PROPERTY_VARIABLE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.utils.ChainedPropertyUtil
-
Property variable expression pattern, matches property variables such as
${basedir}
. - PropertyCacheFile - Class in com.puppycrawl.tools.checkstyle
-
This class maintains a persistent(on file-system) store of the files that have checked ok(no validation events) and their associated timestamp.
- PropertyCacheFile(Configuration, String) - Constructor for class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Creates a new
PropertyCacheFile
instance. - PropertyCacheFile.ExternalResource - Class in com.puppycrawl.tools.checkstyle
-
Class which represents external resource.
- propertyMap - Variable in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
The map from property names to property values.
- PropertyResolver - Interface in com.puppycrawl.tools.checkstyle
-
Resolves properties in module configurations.
- propertySectionStartIdx - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Child number of the property section node, where parent is the class level javadoc root node.
- PropertyType - Enum in com.puppycrawl.tools.checkstyle
-
Represents the custom property type used in documentation and configuration files.
- PropertyType(String) - Constructor for enum com.puppycrawl.tools.checkstyle.PropertyType
-
Creates a new
PropertyType
instance. - PROTECTED - com.puppycrawl.tools.checkstyle.api.Scope
-
Protected scope.
- PROTECTED - com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Protected access modifier.
- PROTECTED_ACCESS_MODIFIER - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Name for 'protected' access modifier.
- protectedAllowed - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Control whether protected members are allowed.
- PUBLIC - com.puppycrawl.tools.checkstyle.api.Scope
-
Public scope.
- PUBLIC - com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Public access modifier.
- PUBLIC_ACCESS_MODIFIER - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Name for 'public' access modifier.
- PUBLIC_ACCESS_MODIFIER - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Name for 'public' access modifier.
- publicIdToResourceNameMap - Variable in class com.puppycrawl.tools.checkstyle.XmlLoader
-
Maps public id to resolve to resource name for the DTD.
- publicMemberPattern - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Specify pattern for public members that should be ignored.
- push() - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
-
Creates new inner frame.
- pushToStack(AxisIterator) - Method in class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseDescendantIterator
-
Pushes all children to the stack.
- pushValue() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Push the current value on the stack.
- pushValue(Integer) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Pushes the current range value on the range value stack.
- put(Object, Object) - Method in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.SequencedProperties
-
Puts the value into list by its key.
- put(Object, Object) - Method in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck.UniqueProperties
-
Puts the value into properties by the key specified.
- put(String, long) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Records that a file checked ok.
- putExternalResources(Set<String>) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Puts external resources in cache.
Q
- qualifiedName - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
Complete type declaration name with package name and outer type declaration name.
- qualifiedName - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.TypeDeclarationDescription
-
Complete type declaration name with package name and outer type declaration name.
- query - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
-
Specify Xpath query.
- query - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Define a string xpath query.
- QUESTION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
?
(conditional) operator. - queue - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator
-
Queue for sibling nodes.
- queue - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseDescendantIterator
-
Queue for sibling nodes.
- QUOTE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
String used to amend TEXT_BLOCK_CONTENT so that it matches STRING_LITERAL.
- QUOTE - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
String used to amend TEXT_BLOCK_CONTENT so that it matches STRING_LITERAL.
- QUOTE_CHAR - Static variable in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
-
The " quote character.
- QUOTE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Regular expression for quotes.
R
- raiseCounter(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Determine the visibility modifier and raise the corresponding counter.
- rangeValue - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.Values
-
NP value for range.
- rangeValues - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Stack of NP values for ranges.
- RB - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rb` html tag.
- RB_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rb` tag name.
- RB_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rb` tag end.
- RB_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rb` tag start.
- RBRACK - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
]
symbol. - rcurly - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Right curly.
- RCURLY - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A right curly brace (
}
). - read(InputStream, ModuleType) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Read the module details from the supplied input stream of the module's XML metadata file.
- READ_BUFFER_SIZE - Static variable in class com.puppycrawl.tools.checkstyle.api.FileText
-
The number of characters to read in one go.
- readAllModulesIncludingThirdPartyIfAny(String...) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Utility to load all the metadata files present in the checkstyle JAR including third parties' module metadata files.
- readAndCheckFile(File) - Method in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
-
Reads the file provided and checks line separators.
- readerLines - Variable in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
The lines of the header file.
- readFile(File, CharsetDecoder) - Static method in class com.puppycrawl.tools.checkstyle.api.FileText
-
Reads file using specific decoder and returns all its content as a String.
- readFile(String) - Static method in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Read the file at the given path and returns its contents as a list of lines.
- readResource(String) - Static method in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Read string from given resource.
- realExecute(String) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Helper implementation to perform execution.
- RECORD_COMPONENT_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A record component is a variable that comprises the state of a record.
- RECORD_COMPONENTS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Record components are a (possibly empty) list containing the components of a record, which are the variables that make up its state.
- RECORD_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A declaration of a record specifies a name, a header, and a body.
- RECORD_MAX_NCSS - Static variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Default constant for max record ncss.
- RECORD_PATTERN_COMPONENTS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A (possibly empty) record component pattern list which is used to match against the corresponding record components.
- RECORD_PATTERN_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A
record
pattern definition. - RecordComponentNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that record component names conform to a specified pattern.
- RecordComponentNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.RecordComponentNameCheck
-
Creates a new
RecordComponentNameCheck
instance. - RecordComponentNumberCheck - Class in com.puppycrawl.tools.checkstyle.checks.sizes
-
Checks the number of record components in the header of a record definition.
- RecordComponentNumberCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
- recordMaximum - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Specify the maximum allowed number of non commenting lines in a record.
- RecordTypeParameterNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that record type parameter names conform to a specified pattern.
- RecordTypeParameterNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.RecordTypeParameterNameCheck
-
Creates a new
RecordTypeParameterNameCheck
instance. - recoverInline(Parser) - Method in class com.puppycrawl.tools.checkstyle.CheckstyleParserErrorStrategy
- RedundantImportCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Checks for redundant import statements.
- RedundantImportCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
- RedundantModifierCheck - Class in com.puppycrawl.tools.checkstyle.checks.modifier
-
Checks for redundant modifiers.
- RedundantModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
- REFERENCE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Parameter of the Javadoc tags listed below.
- referencedClassNames - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
-
Set of referenced classes.
- referencedTypes - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.Frame
-
Set of references - possibly to imports or locally declared types.
- regex - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.FileImportControl
-
If this file name represents a regular expression.
- regex - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
If this package represents a regular expression.
- regexp - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Control whether the
illegalPkgs
andillegalClasses
should be interpreted as regular expressions. - regExp - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
-
Indicates if the name is to be interpreted as a regular expression.
- REGEXP_FORMAT_TO_CHECK_DEFAULT_TRANSLATIONS - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Formatting string to form regexp to validate default translations file names.
- REGEXP_FORMAT_TO_CHECK_REQUIRED_TRANSLATIONS - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Formatting string to form regexp to validate required translations file names.
- REGEXP_HEADER_CHECK_HEADER - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Check and property name.
- RegexpCheck - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
Checks that a specified pattern exists, exists less than a set number of times, or does not exist in the file.
- RegexpCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
- RegexpHeaderCheck - Class in com.puppycrawl.tools.checkstyle.checks.header
-
Checks the header of a source file against a header that contains a pattern for each line of the source header.
- RegexpHeaderCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
- RegexpMultilineCheck - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
Checks that a specified pattern matches across multiple lines in any file type.
- RegexpMultilineCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
- RegexpOnFilenameCheck - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
Checks that a specified pattern matches based on file and/or folder path.
- RegexpOnFilenameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
- RegexpSinglelineCheck - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
Checks that a specified pattern matches a single-line in any file type.
- RegexpSinglelineCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
- RegexpSinglelineJavaCheck - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
Checks that a specified pattern matches a single-line in Java files.
- RegexpSinglelineJavaCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
- register(int, Class<T>) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
-
Registers a handler.
- registerAlias(String, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Registers an alias for the source name of a check.
- registerAnonymousInnerClassToSuperClass(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Register to the super class of anonymous inner class that the given class is instantiated by an anonymous inner class.
- registerAsInstOrClassVar() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Register the variable as an instance variable or class variable.
- registerAsUsed() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
Register the catch parameter as used.
- registerAsUsed() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Register the lambda parameter as used.
- registerAsUsed() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Register the variable as used.
- registerCheck(int, AbstractCheck) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Register a check for a specified token id.
- registerCheck(AbstractCheck) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Register a check for a given configuration.
- registerCustomTypes(ConvertUtilsBean) - Static method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
Register custom types of JDK like URI and Checkstyle specific classes to use with BeanUtils.
- registerExtendedClass(String, FinalClassCheck.ClassDesc) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Register to outer super class of given classAst that given classAst is extending them.
- registerImport(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Registers given import.
- registerIntegralTypes(ConvertUtilsBean) - Static method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
Register basic types of JDK like boolean, int, and String to use with BeanUtils.
- registerNestedSubclass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Adds nested subclass.
- registerNonPrivateCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Adds non-private ctor.
- registerSuperClassOfAnonymousInnerClass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Adds anonymous inner class.
- reinitializeMacroFields() - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
Reinitialize the macro fields.
- RELATIONAL_OPERATOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Token types for relation operator.
- relativizePath(String, String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Constructs a relative path between base directory and a given path.
- RelaxedAccessModifierArrayConverter() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.RelaxedAccessModifierArrayConverter
- RelaxedStringArrayConverter() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.RelaxedStringArrayConverter
- reliefPattern - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
Define the RegExp to match the relief comment that suppresses the warning about a fall through.
- reloadAction - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
Reload action.
- ReloadAction() - Constructor for class com.puppycrawl.tools.checkstyle.gui.MainFrame.ReloadAction
- reloadActionEnabled - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Whether the reload action is enabled.
- remove(String) - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Removed a specific file from the cache.
- removeBeforeExecutionFileFilter(BeforeExecutionFileFilter) - Method in class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
-
Removes filter.
- removeBeforeExecutionFileFilter(BeforeExecutionFileFilter) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Removes before execution file filter.
- removeCellEditorListener(CellEditorListener) - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
- removeCheckstylePrefixIfExists(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Method removes checkstyle prefix (checkstyle:) from check name if exists.
- removeChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
Removes a child of this configuration.
- removeChildren() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Removes all children of this AST.
- removeFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
-
Removes filter.
- removeFilter(Filter) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Removes filter.
- removeFinalVariableCandidateFromStack(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Removes the final variable candidate from the Stack.
- removeLeadingJavaDoc(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Remove leading JavaDoc.
- removeListener(AuditListener) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Removes a given listener.
- removeMatchingParam(Iterable<DetailAST>, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Remove parameter from params collection by name.
- removeQuotes(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
-
Strips a single double quote from the front and back of a string.
- removeSquareBrackets(String) - Static method in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Removes square brackets [ and ] from the given string.
- removeTreeModelListener(TreeModelListener) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
- renderSeverityLevel(SeverityLevel) - Static method in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Render the severity level into SARIF severity level.
- replaceProperties(String, PropertyResolver, String) - Static method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Replaces
${xxx}
style constructions in the given value with the string value of the corresponding data types. - report - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Content for the entire report.
- reportBlockComment(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Report the location of a block comment.
- reportBlockComment(String, int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
- reportBlockComment(String, int, int, int, int) - Method in interface com.puppycrawl.tools.checkstyle.grammar.CommentListener
-
Report the location of a block comment that can span multiple lines.
- reporter - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Used for reporting violations.
- reporter(AbstractViolationReporter) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
-
Specifies the violation reporter and returns Builder object.
- reportMagicNumber(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Reports aAST as a magic number, includes unary operators as needed.
- reportSingleLineComment(int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
-
Report the location of a single-line comment.
- reportSingleLineComment(String, int, int) - Method in class com.puppycrawl.tools.checkstyle.api.FileContents
- reportSingleLineComment(String, int, int) - Method in interface com.puppycrawl.tools.checkstyle.grammar.CommentListener
-
Report the location of a single-line comment that extends from the given point to the end of the line.
- requiredJavadocPhrase - Variable in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Specify the comment text pattern which qualifies a method as designed for extension.
- requiredTranslations - Variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Specify language codes of required translations which must exist in project.
- RequireEmptyLineBeforeBlockTagGroupCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that one blank line before the block tag if it is present in Javadoc.
- RequireEmptyLineBeforeBlockTagGroupCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
- RequireThisCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that references to instance variables and methods of the present object are explicitly of the form "this.varName" or "this.methodName(args)" and that those references don't rely on the default behavior when "this." is absent.
- RequireThisCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
- RequireThisCheck.AbstractFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A declaration frame.
- RequireThisCheck.AnonymousClassFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
An anonymous class frame; holds instance variable names.
- RequireThisCheck.BlockFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A frame initiated on entering a statement list; holds local variable names.
- RequireThisCheck.CatchFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A frame initiated on entering a catch block; holds local catch variable names.
- RequireThisCheck.ClassFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A frame initiated at class, enum or interface definition; holds instance variable names.
- RequireThisCheck.ConstructorFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A frame initiated at constructor definition.
- RequireThisCheck.ForFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A frame initiated on entering a for block; holds local for variable names.
- RequireThisCheck.FrameType - Enum in com.puppycrawl.tools.checkstyle.checks.coding
-
An AbstractFrame type.
- RequireThisCheck.MethodFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A frame initiated at method definition; holds a method definition token.
- RequireThisCheck.TryWithResourcesFrame - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
A frame initiated on entering a try-with-resources construct; holds local resources for the try block.
- reset() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.TokenEnd
-
Sets end token coordinates to the start of the file.
- reset() - Method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Resets the cache to be empty except for the configuration hash.
- resetModuleDetailsStore() - Static method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Reset the module detail store of any previous information.
- resetRowSelection() - Method in class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
This is overridden to set
updatingListSelectionModel
and message super. - resetState() - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
Reset the state of the detector.
- resolve(String) - Method in class com.puppycrawl.tools.checkstyle.PropertiesExpander
- resolve(String) - Method in interface com.puppycrawl.tools.checkstyle.PropertyResolver
-
Resolves a property name to its value.
- resolveEntity(String, String) - Method in class com.puppycrawl.tools.checkstyle.XmlLoader
- resolveName(String) - Method in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
Resolves the module name according to the thread settings.
- RESOURCE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A resource in the Java 7 try-with-resources construct.
- RESOURCE_SPECIFICATION - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The Java 7 try-with-resources construct.
- ResourceBundle(String, String, String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.TranslationCheck.ResourceBundle
-
Creates a ResourceBundle object with specific base name, common files extension.
- RESOURCES - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A list of resources in the Java 7 try-with-resources construct.
- resultErrorOnly - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Content for result representing an error without filename or location.
- resultFileOnly - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Content for result representing an error with filename only and without source location.
- resultLineColumn - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Content for result representing an error with source line and column.
- resultLineOnly - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Content for result representing an error with source line only.
- results - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The results.
- RESULTS_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The placeholder for results.
- retrieveAllScannedFiles(DirectoryScanner, int) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Retrieves all matched files from the given scanner.
- RETURN - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@return
. - RETURN - Static variable in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Return pattern.
- RETURN - Static variable in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Return pattern.
- RETURN_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@return' literal in
@return
Javadoc tag. - RETURN_TEXT - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Return tag text.
- ReturnCountCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Restricts the number of return statements in methods, constructors and lambda expressions.
- ReturnCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
- ReturnCountCheck.Context - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Class to encapsulate information about one method.
- ReverseDescendantIterator - Class in com.puppycrawl.tools.checkstyle.xpath.iterators
-
Recursive-free implementation of the descendant axis iterator.
- ReverseDescendantIterator(NodeInfo) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseDescendantIterator
-
Create an iterator over the "descendant" axis in reverse order.
- ReverseListIterator - Class in com.puppycrawl.tools.checkstyle.xpath.iterators
-
Iterates list in backward direction.
- ReverseListIterator(Collection<? extends NodeInfo>) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseListIterator
-
Constructor for
ReverseListIterator
class. - RIGHT_BRACE - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Right brace in
JavadocTokenTypes.PARAMETERS
part ofJavadocTokenTypes.REFERENCE
. - RIGHT_SHIFT - Static variable in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
String representation of the right shift operator.
- RightCurlyCheck - Class in com.puppycrawl.tools.checkstyle.checks.blocks
-
Checks the placement of right curly braces (
'}'
) for code blocks. - RightCurlyCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
- RightCurlyCheck.Details - Class in com.puppycrawl.tools.checkstyle.checks.blocks
-
Structure that contains all details for validation.
- RightCurlyOption - Enum in com.puppycrawl.tools.checkstyle.checks.blocks
-
Represents the options for placing the right curly brace
'}'
. - RightCurlyOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
- root - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
The root package controller.
- root - Variable in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
The root node of the tree table model.
- root - Variable in class com.puppycrawl.tools.checkstyle.JavaAstVisitor.DetailAstPair
-
The root DetailAstImpl of this pair.
- root - Variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
The root node.
- ROOT_NAME - Static variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Name of the root element.
- rootAst - Variable in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Root ast element.
- rootAst - Variable in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
The root ast.
- rootClass - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
-
Meet a root class.
- RootModule - Interface in com.puppycrawl.tools.checkstyle.api
-
The first module that is run as part of Checkstyle and controls its entire behavior and children.
- rootNode - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
DetailNode pointing to the root node of the class level javadoc of the class.
- RootNode - Class in com.puppycrawl.tools.checkstyle.xpath
-
Represents DetailAST's root node of Xpath-tree.
- RootNode(DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.RootNode
-
Creates a new
RootNode
instance. - RP - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rp` html tag.
- RP_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rp` tag name.
- RP_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rp` tag end.
- RP_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rp` tag start.
- RPAREN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A right parenthesis (
)
). - RT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rt` html tag.
- RT_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rt` tag name.
- RT_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rt` tag end.
- RT_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rt` tag start.
- RTC - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rtc` html tag.
- RTC_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rtc` tag name.
- RTC_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rtc` tag end.
- RTC_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
`rtc` tag start.
- RULE_ID_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The placeholder for rule id.
- RULE_TYPES_OFFSET - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Rule types offset.
- RuleMatchForImport(String, int, int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.RuleMatchForImport
-
Constructor to initialize the fields.
- rules - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
-
List of
AbstractImportRule
objects to check. - runCheckstyle(Main.CliOptions, List<File>) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Executes required Checkstyle actions based on passed parameters.
- runCli(Main.CliOptions, List<File>) - Static method in class com.puppycrawl.tools.checkstyle.Main
-
Do execution of CheckStyle based on Command line options.
S
- safeGet(Attributes, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Utility to safely get an attribute.
- SAME - com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
-
Represents the policy that the brace should follow
RightCurlyOption.ALONE_OR_SINGLELINE
policy but the brace should be on the same line as the next part of a multi-block statement (one that directly contains multiple blocks: if/else-if/else or try/catch/finally). - SAME_PACKAGE_RULE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
SAME_PACKAGE group name.
- samePackageDomainsRegExp - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Specify RegExp for SAME_PACKAGE group imports.
- samePackageMatchingDepth - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Number of first domains for SAME_PACKAGE group.
- SARIF - com.puppycrawl.tools.checkstyle.Main.OutputFormat
-
SARIF output format.
- SarifLogger - Class in com.puppycrawl.tools.checkstyle
-
Simple SARIF logger.
- SarifLogger(OutputStream, AbstractAutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.SarifLogger
-
Creates a new
SarifLogger
instance. - SarifLogger(OutputStream, AutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.SarifLogger
-
Creates a new
SarifLogger
instance. - saveLocation() - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Returns location.
- SAX_PARSE_EXCEPTION_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Format of message for sax parse exception.
- saxHandler - Variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
The SAX document handler.
- scanFileSets() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Returns the list of files (full path name) to process.
- scanPath(Path, int) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Scans the given path and retrieves all files for the given path.
- scanPaths() - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Retrieves all files from the defined paths.
- scope - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.ScopeData
-
Contains variable definitions.
- scope - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
The scope of variable is determined by the ast of type
TokenTypes.SLIST
orTokenTypes.LITERAL_FOR
orTokenTypes.OBJBLOCK
which is enclosing the variable. - scope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Specify the visibility scope where Javadoc comments are checked.
- scope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Specify the visibility scope where Javadoc comments are checked.
- scope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
Specify the visibility scope where Javadoc comments are checked.
- scope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Specify the visibility scope where Javadoc comments are checked.
- scope - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
-
Specify the visibility scope where Javadoc comments are checked.
- Scope - Enum in com.puppycrawl.tools.checkstyle.api
-
Represents a Java visibility scope.
- Scope() - Constructor for enum com.puppycrawl.tools.checkstyle.api.Scope
- ScopeConverter() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.ScopeConverter
- ScopeData() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.ScopeData
- scopeDefinition - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
-
The surrounding scope definition (class, enum, etc.) which the method counts are connected to.
- SCOPES - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
An array of scope tokens.
- scopeStack - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Scope Deque.
- ScopeState() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.ScopeState
- scopeStates - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
List of Declaration States.
- ScopeUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Contains utility methods for working on scope.
- ScopeUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.ScopeUtil
-
Prevent instantiation.
- scrapeContent(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Method containing the core logic of scraping.
- scrapingViolationMessageList - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Boolean variable which lets us know whether violation message section is being scraped currently.
- SealedShouldHavePermitsListCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Checks that sealed classes and interfaces have a permits list.
- SealedShouldHavePermitsListCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.SealedShouldHavePermitsListCheck
- SEARCH_REGISTERED_PACKAGES - com.puppycrawl.tools.checkstyle.PackageObjectFactory.ModuleLoadOption
-
Searching from registered checkstyle modules and from packages given in constructor.
- searchMatchingTypeParameter(Iterable<DetailAST>, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Returns true if required type found in type parameters.
- searchVariableUsageExpressions(DetailAST, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Searches variable usages starting from specified statement.
- SECOND_LINE - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption
-
Represents a policy for the location of content starting from the next line after
/**
. - SEE - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@see
. - SEE_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@see' literal in
@see
Javadoc tag. - seenFirstToken - Variable in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
-
Indicates whether the first token has been seen in the file.
- select() - Method in class com.puppycrawl.tools.checkstyle.gui.CodeSelector
-
Set selection.
- selectionEnd - Variable in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
-
Selection end position.
- selectionStart - Variable in class com.puppycrawl.tools.checkstyle.gui.CodeSelectorPresentation
-
Selection start position.
- selectNodeByXpath() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Select Node by Xpath.
- SEMI - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The statement terminator (
;
). - SEMICOLON - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
-
Semicolon literal.
- SEMICOLON - Static variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
-
Semicolon literal.
- SENTENCE_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Specify the format for first word in javadoc.
- separated - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Control whether type import groups should be separated by, at least, one blank line or comment and aren't separated internally.
- separatedStaticGroups - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Control whether static import groups should be separated by, at least, one blank line or comment and aren't separated internally.
- separateLineBetweenGroups - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Force empty line separator between import groups.
- SeparatorWrapCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks line wrapping with separators.
- SeparatorWrapCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
- SequencedProperties() - Constructor for class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.SequencedProperties
- SERIAL - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@serial
. - SERIAL_DATA - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@serialData
. - SERIAL_DATA_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@serialData' literal in
@serialData
Javadoc tag. - SERIAL_FIELD - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@serialField
. - SERIAL_FIELD_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@serialField' literal in
@serialField
Javadoc tag. - SERIAL_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@serial' literal in
@serial
Javadoc tag. - serialize(Serializable, OutputStream) - Static method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Serializes object to output stream.
- serialVersionUID - Static variable in exception com.puppycrawl.tools.checkstyle.api.CheckstyleException
-
For serialization that will never happen.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.SequencedProperties
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck.UniqueProperties
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame.ExpandCollapseAction
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame.FileSelectionAction
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame.FindNodeByXpathAction
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame.ReloadAction
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
A unique serial version identifier.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
Serial ID.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
-
A unique serial version identifier.
- serialVersionUID - Static variable in exception com.puppycrawl.tools.checkstyle.meta.MetadataGenerationException
-
For serialization that will never happen.
- serialVersionUID - Static variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
A unique serial version identifier.
- setAcceptOnMatch(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
-
Setter to 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.
- setAccessModifiers(AccessModifierOption...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Setter to specify the access modifiers where Javadoc comments are checked.
- setAccessModifiers(AccessModifierOption...) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
Setter to access modifiers of methods where parameters are checked.
- setAccessModifiers(AccessModifierOption...) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
-
Setter to access modifiers of record definitions where the number of record components should be checked.
- setAliasList(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Setter to specify aliases for check names that can be used in code within
SuppressWarnings
in a format of comma separated attribute=value entries. - setAllowByTailComment(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Setter to allow use escapes if trail comment is present.
- setAllowClassImports(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
-
Setter to control whether to allow starred class imports like
import java.util.*;
. - setAllowClassName(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
-
Setter to control whether to allow a method name to have the same name as the enclosing class name.
- setAllowedAbbreviationLength(int) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Setter to indicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ... ).
- setAllowedAbbreviations(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Setter to specify abbreviations that must be skipped for checking.
- setAllowedAnnotations(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Setter to specify annotations that allow missed documentation.
- setAllowedAnnotations(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Setter to specify annotations that allow skipping validation at all.
- setAllowedAnnotations(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Setter to configure annotations that allow missed documentation.
- setAllowedDistance(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Setter to specify distance between declaration of variable and its first usage.
- setAllowedDuplicates(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
Setter to specify the maximum number of occurrences to allow without generating a warning.
- setAllowEmptyCatches(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to allow empty catch bodies.
- setAllowEmptyConstructors(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to allow empty constructor bodies.
- setAllowEmptyLambdas(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to allow empty lambda bodies.
- setAllowEmptyLoopBody(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Setter to allow loops with empty bodies.
- setAllowEmptyLoops(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to allow empty loop bodies.
- setAllowEmptyMethods(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to allow empty method bodies.
- setAllowEmptySwitchBlockStatements(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to allow empty switch blocks and block statements.
- setAllowEmptyTypes(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to allow empty class, interface and enum bodies.
- setAllowEscapesForControlCharacters(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Setter to allow use escapes for non-printable, control characters.
- setAllowIfAllCharactersEscaped(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Setter to allow if all characters in literal are escaped.
- setAllowInSwitchCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
-
Setter to allow nested blocks if they are the only child of a switch case.
- setAllowLegacy(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
-
Setter to allow legacy
package.html
file to be used. - setAllowLineBreaks(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
-
Setter to allow a line break between the identifier and left parenthesis.
- setAllowLineBreaks(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Setter to control whether whitespace is allowed if the token is at a linebreak.
- setAllowLineBreaks(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
-
Setter to control whether whitespace is allowed if the token is at a linebreak.
- setAllowMarkerInterfaces(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
-
Setter to control whether marker interfaces like Serializable are allowed.
- setAllowMissingParamTags(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Setter to control whether to ignore violations when a method has parameters but does not have matching
param
tags in the javadoc. - setAllowMissingParamTags(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Setter to control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc.
- setAllowMissingPropertyJavadoc(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Setter to control whether to allow missing Javadoc on accessor methods for properties (setters and getters).
- setAllowMissingReturnTag(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Setter to control whether to ignore violations when a method returns non-void type and does not have a
return
tag in the javadoc. - setAllowMultipleEmptyLines(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Setter to allow multiple empty lines between class members.
- setAllowMultipleEmptyLinesInsideClassMembers(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Setter to allow multiple empty lines inside class members.
- setAllowNewlineParagraph(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
-
Setter to control whether the <p> tag should be placed immediately before the first word.
- setAllowNoEmptyLineBetweenFields(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
-
Setter to allow no empty line between fields.
- setAllowNonPrintableEscapes(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Setter to allow use escapes for non-printable, whitespace characters.
- setAllowOneCharVarInForLoop(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
-
Setter to allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by
format
regexp. - setAllowPublicFinalFields(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Setter to allow final fields to be declared as public.
- setAllowPublicImmutableFields(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Setter to allow immutable fields to be declared as public if defined in final class.
- setAllowSamelineMultipleAnnotations(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Setter to allow annotation(s) to be located on the same line as target element.
- setAllowSamelineParameterizedAnnotation(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Setter to allow one and only parameterized annotation to be located on the same line as target element.
- setAllowSamelineSingleParameterlessAnnotation(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
-
Setter to allow single parameterless annotation to be located on the same line as target element.
- setAllowSingleLineStatement(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
-
Setter to allow single-line statements without braces.
- setAllowStaticMemberImports(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
-
Setter to control whether to allow starred static member imports like
import static org.junit.Assert.*;
. - setAllowUnknownTags(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Setter to control whether to ignore violations when a Javadoc tag is not recognised.
- setAllowUnnamedVariables(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Setter to allow variables named with a single underscore (known as unnamed variables in Java 21+).
- setAllowWhenNoBraceAfterSemicolon(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
-
Setter to allow unnecessary semicolon if closing parenthesis is not on the same line.
- setAlwaysDemandTrailingComma(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
-
Setter to control whether to always check for a trailing comma, even when an array is inline.
- setApplyToPackage(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
-
Setter to control if check should apply to package-private members.
- setApplyToPrivate(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
-
Setter to control if check should apply to private members.
- setApplyToProtected(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
-
Setter to control if check should apply to protected members.
- setApplyToPublic(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
-
Setter to control if check should apply to public members.
- setArrayInitIndent(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Setter to specify how far an array initialization should be indented when on next line.
- setAuthorFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Setter to specify the pattern for
@author
tag. - setBasedir(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets base directory.
- setBaseName(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Setter to specify Base name of resource bundles which contain message resources.
- setBasicOffset(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Setter to specify how far new indentation level should be indented when on the next line.
- setBounds(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
This is overridden to set the height to match that of the JTable.
- setBraceAdjustment(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Setter to specify how far a braces should be indented when on the next line.
- setCacheFile(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets cache file.
- setCallingSuper() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck.MethodNode
-
Records that the overriding method has a call to the super method.
- setCaseIndent(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Setter to specify how far a case label should be indented when on next line.
- setCaseSensitive(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to control whether string comparison should be case-sensitive or not.
- setCharset(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets a named charset.
- setCharset(String) - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Setter to specify the character encoding to use when reading the headerFile.
- setCheckC(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Setter to control whether to check C style comments (
/* ... */
). - setCheckC(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Setter to control whether to check C style comments (
/* ... */
). - setCheckCPP(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Setter to control whether to check C++ style comments (
//
). - setCheckCPP(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Setter to control whether to check C++ style comments (
//
). - setCheckEmptyJavadoc(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Setter to control whether to check if the Javadoc is missing a describing text.
- setCheckFields(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Setter to control whether to check references to fields.
- setCheckFirstSentence(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Setter to control whether to check the first sentence for proper end of sentence.
- setCheckFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Setter to specify check pattern to suppress.
- setCheckFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Setter to specify check pattern to suppress.
- setCheckFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Setter to specify check pattern to suppress.
- setCheckHtml(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Setter to control whether to check for incomplete HTML tags.
- setCheckLastCaseGroup(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
Setter to control whether the last case group must be checked.
- setCheckMethods(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Setter to control whether to check references to methods.
- setCheckPattern(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Setter to specify check name pattern to suppress.
- setChecks(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Setter to define the RegExp for matching against the name of the check associated with an audit event.
- setChecks(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Setter to define a Regular Expression matched against the name of the check associated with an audit event.
- setChildren(DetailNode...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Sets array of child nodes.
- setClasses(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
-
Setter to specify fully qualified class names that should not be instantiated.
- setClassMaximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Setter to specify the maximum allowed number of non commenting lines in a class.
- setClassOrEnumOrRecordDef(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Sets isClassOrEnumOrRecordDef.
- setClosingParens(String) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
Setter to define the policy for ending parenthesis.
- setColumnNo(int) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Set column number.
- setColumnNumber(int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Sets column number.
- setColumns(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Setter to specify a comma-separated list of values, where each value is an integer or a range of integers denoted by integer-integer.
- setColumnsInitialWidth() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Set initial value of width for columns in table.
- setCommentFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
Setter to specify the RegExp for the first comment inside empty catch block.
- setCommentFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Setter to specify comment pattern to trigger filter to begin suppression.
- setConfig(String) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Sets configuration file.
- setConstantWaiverParentToken(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Setter to specify tokens that are allowed in the AST path from the number literal to the enclosing constant definition.
- setCountEmpty(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
-
Setter to control whether to count empty lines and comments.
- setCustomImportOrderRules(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Setter to specify ordered list of import groups.
- setDefaultValue(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Set default value of property.
- setDescription(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Set description of module.
- setDescription(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Set description of property.
- setDuplicateLimit(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Setter to 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.
- setEachLine(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck
-
Setter to control whether to report on each line containing a tab, or just the first instance.
- setEditor(JTextArea) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Sets text area editor.
- setElementStyle(String) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
Setter to define the annotation element styles.
- setEndOfSentenceFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Setter to specify the format for matching the end of a sentence.
- setErrorLimit(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Setter to specify the maximum number of violations before the check will abort.
- setExceptionVariableName(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
Setter to specify the RegExp for the name of the variable associated with exception.
- setExcludeClassesRegexps(Pattern...) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Setter to specify user-configured regular expressions to ignore classes.
- setExcludedClasses(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Setter to specify user-configured class names to ignore.
- setExcludedClasses(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
Setter to specify pattern for qualified names of classes which are allowed to have a
main
method. - setExcludedPackages(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Setter to specify user-configured packages to ignore.
- setExcludes(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
-
Setter to specify packages where starred class imports are allowed and classes where starred static member imports are allowed.
- setExcludes(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
-
Setter to 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 likejava.lang.System.out
for a variable orjava.lang.Math.random
for a method. - setExcludeScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Setter to specify the visibility scope where Javadoc comments are not checked.
- setExcludeScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Setter to specify the visibility scope where Javadoc comments are not checked.
- setExcludeScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
Setter to specify the visibility scope where Javadoc comments are not checked.
- setExcludeScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Setter to specify the visibility scope where Javadoc comments are not checked.
- setExcludeScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
-
Setter to specify the visibility scope where Javadoc comments are not checked.
- setExecuteIgnoredModules(boolean) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Sets flag - whether to execute ignored modules.
- setExtendedClassNameFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
Setter to specify pattern for extended class names.
- setFailOnViolation(boolean) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Sets flag - whether to fail if a violation is found.
- setFailureProperty(String) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Tells this task to write failure message to the named property when there is a violation.
- setFeaturesBySystemProperty(SAXParserFactory) - Static method in class com.puppycrawl.tools.checkstyle.XmlLoader.LoadExternalDtdFeatureProvider
-
Configures SAXParserFactory with features required to use external DTD file loading, this is not activated by default to no allow usage of schema files that checkstyle do not know it is even security problem to allow files from outside.
- setFile(File) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
-
Sets the property value from a File.
- setFile(File) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Sets file to be checked.
- setFile(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
-
Setter to specify the location of the suppressions XML document file.
- setFile(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
-
Setter to specify the location of the suppressions XML document file.
- setFile(URI) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
Setter to specify the location of the file containing the import control configuration.
- setFileContents(FileContents) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Set the file contents associated with the tree.
- setFileContents(FileContents) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Set the file contents associated with the tree.
- setFileContents(FileContents) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Set the FileContents for this filter.
- setFileContents(FileContents) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Set the FileContents for this filter.
- setFileExtensions(String...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Setter to specify the file extensions of the files to process.
- setFileExtensions(String...) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets the file extensions that identify the files that pass the filter of this FileSetCheck.
- setFileMaximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Setter to specify the maximum allowed number of non commenting lines in a file including all top level and nested classes.
- setFileNamePattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Setter to specify the regular expression to match the file name against.
- setFileNamePattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filefilters.BeforeExecutionExclusionFileFilter
-
Setter to define regular expression to match the file name against.
- setFiles(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Setter to define a Regular Expression matched against the file name associated with an audit event.
- setFiles(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Setter to define the RegExp for matching against the file name associated with an audit event.
- setFirstChild(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Sets the first child of this AST.
- setFolderPattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Setter to specify the regular expression to match the folder path against.
- setForbiddenSummaryFragments(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Setter to specify the regexp for forbidden summary fragments.
- setForceStrictCondition(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Setter to force strict indent level in line wrapping case.
- setFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
-
Setter to define the RegExp for illegal pattern.
- setFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Setter to specify the format of the regular expression to match.
- setFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Setter to specify the format of the regular expression to match.
- setFormat(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Setter to specify the format of the regular expression to match.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
-
Setter to specify the RegExp to match against warnings.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Setter to specify method names to ignore.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
Setter to specify pattern for exception class names.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Setter to specify valid identifiers.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
-
Sets the pattern to match valid identifiers.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
-
Setter to control the pattern to match valid identifiers.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Setter to specify the pattern to match against.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
-
Setter to specify pattern to match comments against.
- setFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
-
Setter to specify pattern for strings allowed before the comment.
- setFound() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
-
Mark that the exception has associated throws tag.
- setFrameName(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame
-
Set the frame name.
- setFullQualifiedName(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Set fully qualified name of module.
- setGroups(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to specify list of type import groups.
- setHaltOnException(boolean) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets the field haltOnException.
- setHeader(String) - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Specify the required header specified inline.
- setHeader(String) - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
Setter to define the required header specified inline.
- setHeaderFile(URI) - Method in class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
-
Setter to specify the name of the file containing the required header.
- setHiddenAfter(List<Token>) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Sets the hiddenAfter token field.
- setHiddenBefore(List<Token>) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Sets the hiddenBefore token field.
- setId(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Sets the identifier of the reporter.
- setId(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Setter to specify a string matched against the ID of the check associated with an audit event.
- setId(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Setter to define a string matched against the ID of the check associated with an audit event.
- setIdFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Setter to specify check ID pattern to suppress.
- setIdFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Setter to specify check ID pattern to suppress.
- setIdFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Setter to specify check ID pattern to suppress.
- setIdPattern(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Setter to specify check ID pattern to suppress.
- setIgnoreAbstractMethods(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Setter to control whether to ignore parameters of abstract methods.
- setIgnoreAnnotatedBy(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
-
Setter to ignore classes annotated with the specified annotation(s).
- setIgnoreAnnotatedBy(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Setter to ignore methods and constructors annotated with the specified annotation(s).
- setIgnoreAnnotation(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Setter to ignore magic numbers in annotation declarations.
- setIgnoreAnnotationCanonicalNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Setter to specify annotations canonical names which ignore variables in consideration.
- setIgnoreAnnotationElementDefaults(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Setter to ignore magic numbers in annotation elements defaults.
- setIgnoreCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
-
Setter to control whether to ignore case when matching.
- setIgnoreCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Setter to control whether to ignore case when searching.
- setIgnoreCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Setter to control whether to ignore case when searching.
- setIgnoreCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Setter to control whether to ignore case when searching.
- setIgnoreComments(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Setter to control whether to ignore matches found within comments.
- setIgnoreComments(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Setter to control whether to ignore text in comments when searching.
- setIgnoreConstructorParameter(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Setter to control whether to ignore constructor parameters.
- setIgnoreConstructors(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Setter to control whether to ignore constructors.
- setIgnoredAnnotations(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Setter to specify annotations which allow the check to skip the method from validation.
- setIgnoredMethodNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Setter to specify names of methods to ignore.
- setIgnoredMethodNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Setter to specify methods that should not be checked.
- setIgnoredTags(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Setter to specify block tags which are ignored by the check.
- setIgnoreEnhancedForColon(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Setter to ignore whitespace around colon in enhanced for loop.
- setIgnoreEnums(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Setter to allow to ignore enums when left curly brace policy is EOL.
- setIgnoreEqualsIgnoreCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Setter to control whether to ignore
String.equalsIgnoreCase(String)
invocations. - setIgnoreFieldDeclaration(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Setter to ignore magic numbers in field declarations.
- setIgnoreFileNameExtensions(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Setter to control whether to ignore the file extension for the file name match.
- setIgnoreFinal(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Setter to allow to ignore variables with a 'final' modifier.
- setIgnoreFinal(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Setter to allow to skip variables with
final
modifier. - setIgnoreFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Setter to define the RegExp for names of variables and parameters to ignore.
- setIgnoreHashCodeMethod(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Setter to ignore magic numbers in hashCode methods.
- setIgnoreInlineTags(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
-
Setter to control whether inline tags must be ignored.
- setIgnoreLines(int...) - Method in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
-
Setter to specify the line numbers to ignore.
- setIgnoreMethodNamesRegex(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Setter to ignore method whose names are matching specified regex.
- setIgnoreModifier(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Setter to control whether to ignore checking for the
abstract
modifier on classes that match the name. - setIgnoreModifiers(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
Setter to control whether to ignore modifiers (fields, ...).
- setIgnoreName(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Setter to control whether to ignore checking the name.
- setIgnoreNamePattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
Setter to specify the regexp to define variable names to ignore.
- setIgnoreNumbers(double...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Setter to specify non-magic numbers.
- setIgnoreOccurrenceContext(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
Setter to specify token type names where duplicate strings are ignored even if they don't match ignoredStringsRegexp.
- setIgnoreOverridden(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
Setter to allows to skip methods with Override annotation from validation.
- setIgnoreOverriddenMethods(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Setter to allow to ignore checking overridden methods (marked with
Override
orjava.lang.Override
annotation). - setIgnoreOverriddenMethods(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Setter to allow to ignore methods tagged with
@Override
annotation (that usually mean inherited name). - setIgnoreOverriddenMethods(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Setter to ignore number of parameters for methods with
@Override
annotation. - setIgnorePattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
-
Setter to specify pattern for lines to ignore.
- setIgnorePrimitiveTypes(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Setter to ignore primitive types as parameters.
- setIgnorePrivateMethods(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Setter to allow private methods to be ignored.
- setIgnoreSetter(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Setter to allow to ignore the parameter of a property setter method.
- setIgnoreStatic(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Setter to allow to skip variables with
static
modifier. - setIgnoreStaticFinal(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
-
Setter to allow to skip variables with both
static
andfinal
modifiers. - setIgnoreStringsRegexp(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
Setter to specify RegExp for ignored strings (with quotation marks).
- setIgnoreUnnamedParameters(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Setter to ignore unnamed parameters.
- setIgnoreVariablePattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Setter to define RegExp to ignore distance calculation for variables listed in this pattern.
- setIllegalAbstractClassNameFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Setter to specify RegExp for illegal abstract class names.
- setIllegalClasses(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Setter to specify class names to reject, if regexp property is not set, checks if import equals class name.
- setIllegalClassNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
-
Setter to specify exception class names to reject.
- setIllegalClassNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Setter to specify throw class names to reject.
- setIllegalClassNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Setter to specify classes that should not be used as types in variable declarations, return values or parameters.
- setIllegalPattern(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Setter to control whether the pattern is required or illegal.
- setIllegalPkgs(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Setter to specify packages to reject, if regexp property is not set, checks if import is the part of package.
- setImmutableClassCanonicalNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Setter to specify immutable classes canonical names.
- setIndex(int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Sets node's index among parent's children.
- setInfluenceFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Setter to specify negative/zero/positive value that defines the number of lines preceding/at/following the suppression comment.
- setJavadocTokens(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Adds a set of tokens the check is interested in.
- setJavaFiveCompatibility(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
-
Setter to enable java 5 compatibility mode.
- setJavaParseExceptionSeverity(SeverityLevel) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Setter to specify the severity level to log Java parsing exceptions when they are skipped.
- setJavaStyle(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
-
Setter to control whether to enforce Java style (true) or C style (false).
- setJdkVersion(String) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
Setter to set the JDK version that you are using.
- setKey(String) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
-
Sets key.
- setLegalAbstractClassNames(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Setter to define abstract classes that may be used as types.
- setLegalComment(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
-
Setter to define pattern for text allowed in trailing comments.
- setLimitedTokens(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to specify set of tokens with limited occurrences as descendants.
- setLineNo(int) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Set line number.
- setLineNumber(int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Sets line number.
- setLinePositionList(Collection<Integer>) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Sets line positions.
- setLineRange(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Setter to specify negative/zero/positive value that defines the number of lines preceding/at/following the suppressing nearby text.
- setLines(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Setter to specify a comma-separated list of values, where each value is an integer or a range of integers denoted by integer-integer.
- setLineSeparator(String) - Method in class com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
-
Setter to specify the type of line separator.
- setLineWrappingIndentation(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Setter to specify how far continuation line should be indented when line-wrapping is present.
- setLocale(Locale) - Static method in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Sets a locale to use for localization.
- setLocaleCountry(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets locale country.
- setLocaleLanguage(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets locale language.
- setLocation(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
-
Setter to specify the policy on placement of the Javadoc content.
- setMatch(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
-
Setter to control whether to look for a match or mismatch on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern.
- setMatchAcrossLines(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Setter to control whether to match expressions across multiple lines.
- setMatchDirectoryStructure(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
-
Setter to control whether to check for directory and package name match.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
-
Setter to specify maximum allowed nesting depth.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
-
Setter to specify maximum allowed nesting depth.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
-
Setter to specify maximum allowed nesting depth.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Setter to specify maximum allowed number of return statements in non-void methods/lambdas.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Setter to specify maximum allowed number of throws statements.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Setter to specify the maximum threshold allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Setter to specify the maximum number of boolean operations allowed in one expression.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Setter to specify the maximum threshold allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Setter to specify the maximum threshold allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
-
Setter to specify the maximum number of lines allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
-
Setter to specify the maximum threshold allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck
-
Setter to specify the maximum number of lines allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
-
Setter to specify the maximum number of lines allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
-
Setter to specify the maximum line length allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
-
Setter to specify the maximum number of lines allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
-
Setter to specify the maximum number of outer types allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Setter to specify the maximum number of parameters allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
-
Setter to specify the maximum number of components allowed in the header of a record definition.
- setMaxErrors(int) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Sets the maximum number of errors allowed.
- setMaxForVoid(int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Setter to specify maximum allowed number of return statements in void methods/constructors/lambdas.
- setMaximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Setter to specify the maximum number of matches required in each file.
- setMaximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Setter to specify the maximum number of matches required in each file.
- setMaximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Setter to specify the maximum number of matches required in each file.
- setMaximumDepth(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to specify the maximum depth for descendant counts.
- setMaximumMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to define the violation message when the maximum count is exceeded.
- setMaximumNumber(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to specify a maximum count for descendants.
- setMaxPackage(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Setter to specify the maximum number of
package
methods allowed. - setMaxPrivate(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Setter to specify the maximum number of
private
methods allowed. - setMaxProtected(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Setter to specify the maximum number of
protected
methods allowed. - setMaxPublic(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Setter to specify the maximum number of
public
methods allowed. - setMaxTotal(int) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
-
Setter to specify the maximum number of methods allowed at all scope levels.
- setMaxWarnings(int) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Sets the maximum number of warnings allowed.
- setMemberModifiers(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Setter to control whether to check only methods and fields with any of the specified modifiers.
- setMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
-
Setter to define the message which is used to notify about violations; if empty then the default message is used.
- setMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
-
Setter to specify message which is used to notify about violations, if empty then the default (hard-coded) message is used.
- setMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Setter to specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.
- setMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Setter to specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.
- setMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Setter to specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.
- setMessage(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Setter to define a Regular Expression matched against the message of the check associated with an audit event.
- setMessage(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
-
Setter to define the RegExp for matching against the message of the check associated with an audit event.
- setMessageDispatcher(MessageDispatcher) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
- setMessageDispatcher(MessageDispatcher) - Method in interface com.puppycrawl.tools.checkstyle.api.FileSetCheck
-
Sets the MessageDispatcher that is used to dispatch audit events to AuditListeners during processing.
- setMessageFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Setter to specify message pattern to suppress.
- setMessageFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Setter to define message pattern to suppress.
- setMessageFormat(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Setter to specify message pattern to suppress.
- setMessagePattern(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Setter to specify check violation message pattern to suppress.
- setMethodMaximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Setter to specify the maximum allowed number of non commenting lines in a method.
- setMinimum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck
-
Setter to specify the minimum number of matches required in each file.
- setMinimum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck
-
Setter to specify the minimum number of matches required in each file.
- setMinimum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck
-
Setter to specify the minimum number of matches required in each file.
- setMinimumDepth(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to specify the minimum depth for descendant counts.
- setMinimumMessage(String) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to define the violation message when the minimum count is not reached.
- setMinimumNumber(int) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to specify a minimum count for descendants.
- setMinLineCount(int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Setter to control the minimal amount of lines in method to allow no documentation.
- setModuleClassLoader(ClassLoader) - Method in interface com.puppycrawl.tools.checkstyle.api.RootModule
-
Sets the classloader used to load Checkstyle core and custom module classes when the module tree is being built up.
- setModuleClassLoader(ClassLoader) - Method in class com.puppycrawl.tools.checkstyle.Checker
- setModuleFactory(ModuleFactory) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets the factory for creating submodules.
- setModuleFactory(ModuleFactory) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Sets the module factory for creating child modules (Checks).
- setModuleType(ModuleType) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Set type of module.
- setMultiLines(int...) - Method in class com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck
-
Setter to specify the line numbers to repeat (zero or more times).
- setName(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Set name of module.
- setName(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Set name of property.
- setNearbyTextPattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Setter to specify nearby text pattern to trigger filter to begin suppression.
- setNextSibling(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Sets the next sibling of this AST.
- setOffCommentFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Setter to specify comment pattern to trigger filter to begin suppression.
- setOffCommentFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Setter to specify comment pattern to trigger filter to begin suppression.
- setOffset(int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
-
Setter to specify how many spaces to use for new indentation level.
- setOffset(int) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.DescriptiveErrorListener
-
Sets offset.
- setOnCommentFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Setter to specify comment pattern to trigger filter to end suppression.
- setOnCommentFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
-
Setter to specify comment pattern to trigger filter to end suppression.
- setOnlyObjectReferences(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
Setter to control whether only explicit initializations made to null for objects should be checked.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
-
Setter to specify the policy on block contents.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Setter to specify the policy on placement of a left curly brace (
'{'
). - setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Setter to specify the policy on placement of a right curly brace (
'}'
). - setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to specify policy on the relative order between type imports and static imports.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
-
Specify policy on how to pad parentheses.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
-
Setter to specify policy on how to pad an empty for iterator.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
-
Setter to specify policy on how to pad an empty for iterator.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
-
Setter to specify policy on how to pad method parameter.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
-
Setter to specify policy on how to wrap lines.
- setOption(String) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
-
Setter to specify policy on how to wrap lines.
- setOptional(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
-
Setter to control what to do when the file is not existing.
- setOptional(boolean) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
-
Setter to control what to do when the file is not existing.
- setOrdered(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to control whether type imports within each group should be sorted.
- setPackageAllowed(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Setter to control whether package visible members are allowed.
- setParent(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Sets parent node.
- setParent(DetailAstImpl) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Set the parent token.
- setParent(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
Set parent of module.
- setParseErrorMessage(JavadocDetailNodeParser.ParseErrorMessage) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
Sets parse error message.
- setParseMode(MainFrameModel.ParseMode) - Method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Set current parse mode.
- setParseMode(MainFrameModel.ParseMode) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
-
Set parse mode.
- setParseMode(MainFrameModel.ParseMode) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Set parse mode.
- setParseTree(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
-
Sets parse tree.
- setPath(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
Setter to specify the regular expression of file paths to which this check should apply.
- setPeriod(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Setter to specify the period symbol.
- setProcessJavadoc(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Setter to control whether to process Javadoc comments.
- setProperties(File) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Sets a properties file for use instead of individually setting them.
- setProtectedAllowed(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Setter to control whether protected members are allowed.
- setPublicMemberPattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Setter to specify pattern for public members that should be ignored.
- setQuery(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
-
Setter to specify Xpath query.
- setQuery(String) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
Setter to define a string xpath query.
- setRecordMaximum(int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
-
Setter to specify the maximum allowed number of non commenting lines in a record.
- setRegexp(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
Setter to control whether the
illegalPkgs
andillegalClasses
should be interpreted as regular expressions. - setReliefPattern(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
Setter to define the RegExp to match the relief comment that suppresses the warning about a fall through.
- setRequiredJavadocPhrase(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
-
Setter to specify the comment text pattern which qualifies a method as designed for extension.
- setRequiredTranslations(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Setter to specify language codes of required translations which must exist in project.
- setRoot(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Set parse tree.
- setRowHeight(int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Overridden to pass the new rowHeight to the tree.
- setRowHeight(int) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
Sets the row height of the tree, and forwards the row height to the table.
- setScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Setter to specify the visibility scope where Javadoc comments are checked.
- setScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Setter to specify the visibility scope where Javadoc comments are checked.
- setScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
Setter to specify the visibility scope where Javadoc comments are checked.
- setScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Setter to specify the visibility scope where Javadoc comments are checked.
- setScope(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
-
Setter to specify the visibility scope where Javadoc comments are checked.
- setSeparated(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to control whether type import groups should be separated by, at least, one blank line or comment and aren't separated internally.
- setSeparatedStaticGroups(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to control whether static import groups should be separated by, at least, one blank line or comment and aren't separated internally.
- setSeparateLineBetweenGroups(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Setter to force empty line separator between import groups.
- setSetterCanReturnItsClass(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Setter to allow to expand the definition of a setter method to include methods that return the class' instance.
- setSeverity(SeverityLevel) - Method in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
-
Setter to specify the severity level of this filter.
- setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
Sets the severity level.
- setSeverity(String) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Sets the severity level.
- setSkipAnnotations(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
-
Setter to specify annotations that allow missed documentation.
- setSkipEnhancedForLoopVariable(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Setter to control whether to check enhanced for-loop variable.
- setSkipFileOnJavaParseException(boolean) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Setter to control whether to skip files with Java parsing exceptions.
- setSkipIfLastAndSharedWithCase(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
-
Setter to control whether to allow
default
along withcase
if they are not last. - setSortImportsInGroupAlphabetically(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Setter to force grouping alphabetically, in ASCII sort order.
- setSortStaticImportsAlphabetically(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to control whether static imports located at top or bottom are sorted within the group.
- setSpecialImportsRegExp(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Setter to specify RegExp for SPECIAL_IMPORTS group imports.
- setStandardPackageRegExp(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Setter to specify RegExp for STANDARD_JAVA_PACKAGE group imports.
- setStaticGroups(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to specify list of static import groups.
- setSumTokenCounts(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Setter to control whether the number of tokens found should be calculated from the sum of the individual token counts.
- setSwitchBlockAsSingleDecisionPoint(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Setter to control whether to treat the whole switch block as a single decision point.
- setSystemId(String) - Method in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
Sets system id.
- setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Set the tab width to report audit events with.
- setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
Set the tab width to report audit events with.
- setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Set the tab width to report audit events with.
- setTabWidth(int) - Method in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
-
Sets tab width.
- setTag(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Setter to specify the name of tag.
- setTagFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Setter to specify the regexp to match tag content.
- setTagOrder(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
-
Setter to specify the order by tags.
- setTags(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
-
Setter to specify the javadoc tags to process.
- setTagSeverity(SeverityLevel) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Setter to specify the severity level when tag is found and printed.
- setTarget(String...) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
-
Setter to specify block tags targeted.
- SETTER_BODY_SIZE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Maximum nodes allowed in a body of setter.
- SETTER_GETTER_MAX_CHILDREN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Maximum children allowed in setter/getter.
- SETTER_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Pattern matching names of setter methods.
- SETTER_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Precompiled regex pattern to remove the "Setter to " prefix from strings.
- setterCanReturnItsClass - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Allow to expand the definition of a setter method to include methods that return the class' instance.
- setText(String) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Sets node's text content.
- setText(String) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Sets the text for this DetailAstImpl.
- setThirdPartyPackageRegExp(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Setter to specify RegExp for THIRD_PARTY_PACKAGE group imports.
- setThrowsIndent(int) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Setter to specify how far a throws clause should be indented when on next line.
- setTofile(File) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
Set the file to output to.
- setToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.TokenEnd
-
Sets end coordinates from given token.
- setTokens(String...) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Adds a set of tokens the check is interested in.
- setTrailingArrayComma(String) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
Setter to define the policy for trailing comma in arrays.
- setTreatTryResourcesAsStatement(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Setter to enable resources processing.
- setTree(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
Sets DetailNode tree.
- setType(int) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Sets node's type.
- setType(int) - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Sets the type of this AST.
- setType(CheckstyleAntTask.FormatterType) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
Set the type of the formatter.
- setType(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Set property type.
- setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
Called by configure() for every child of this component's Configuration.
- setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.Checker
-
Called by configure() for every child of this component's Configuration.
- setupChild(Configuration) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Called by configure() for every child of this component's Configuration.
- setUseContainerOrderingForStatic(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Setter to control whether to use container ordering (Eclipse IDE term) for static imports or not.
- setUseFile(boolean) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
Sets whether or not we write to a file if it is provided.
- setValidateAbstractClassNames(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Setter to control whether to validate abstract class names.
- setValidateBetweenScopes(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Setter to allow to calculate the distance between declaration of variable and its first usage in the different scopes.
- setValidateComments(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Setter to control whether to validate whitespaces surrounding comments.
- setValidateEnhancedForLoopVariable(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Setter to control whether to check enhanced for-loop variable.
- setValidateOnlyOverlapping(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Setter to control whether to check only overlapping by variables or arguments.
- setValidateThrows(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Setter to control whether to validate
throws
tags. - setValidateUnnamedVariables(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Setter to control whether to check unnamed variables.
- setValidationType(String) - Method in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Set validation type of property.
- setValue(String) - Method in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
-
Sets value.
- setVersionFormat(Pattern) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Setter to specify the pattern for
@version
tag. - setViolateExecutionOnNonTightHtml(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Setter to control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules.
- setViolateImpliedAbstractMethod(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Setter to control whether to enforce that
abstract
is explicitly coded on interface methods. - setViolateImpliedFinalField(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Setter to control whether to enforce that
final
is explicitly coded on interface fields. - setViolateImpliedPublicField(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Setter to control whether to enforce that
public
is explicitly coded on interface fields. - setViolateImpliedPublicMethod(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Setter to control whether to enforce that
public
is explicitly coded on interface methods. - setViolateImpliedPublicNested(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Setter to control whether to enforce that
public
is explicitly coded on interface nested types. - setViolateImpliedStaticField(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Setter to control whether to enforce that
static
is explicitly coded on interface fields. - setViolateImpliedStaticNested(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Setter to control whether to enforce that
static
is explicitly coded on interface nested types. - setViolateImpliedStaticOnNestedEnum(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Setter to control whether to enforce that
static
is explicitly coded on nested enums in classes and records. - setViolateImpliedStaticOnNestedInterface(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Setter to control whether to enforce that
static
is explicitly coded on nested interfaces in classes and records. - setViolateImpliedStaticOnNestedRecord(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Setter to control whether to enforce that
static
is explicitly coded on nested records in classes and records. - setWriteXmlOutput(boolean) - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Setter to control whether to write XML output or not.
- setXpathEditor(JTextArea) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Sets text area xpathEditor.
- severity - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
The severity level of any violations found by submodules.
- severity - Variable in class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
-
Specify the severity level of this filter.
- SEVERITY - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Name of the severity property.
- SEVERITY_LEVEL_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The placeholder for severity level.
- severityLevel - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
The severity level of any violations found.
- severityLevel - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
The severity level.
- SeverityLevel - Enum in com.puppycrawl.tools.checkstyle.api
-
Severity level for a check violation.
- SeverityLevel() - Constructor for enum com.puppycrawl.tools.checkstyle.api.SeverityLevel
- SeverityLevelConverter() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.SeverityLevelConverter
- SeverityLevelCounter - Class in com.puppycrawl.tools.checkstyle.api
-
An audit listener that counts how many
AuditEvents
of a given severity have been generated. - SeverityLevelCounter(SeverityLevel) - Constructor for class com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter
-
Creates a new counter.
- SeverityMatchFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SeverityMatchFilter
decides audit events according to the severity level of the event. - SeverityMatchFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SeverityMatchFilter
- shouldAcceptFile(File) - Static method in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Whether a file chooser should accept the file as a source file.
- shouldBeAloneOnLine(RightCurlyOption, RightCurlyCheck.Details, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Checks that a right curly should be alone on a line.
- shouldBeAloneOnLineWithAloneOption(RightCurlyCheck.Details, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Whether right curly should be alone on line when ALONE option is used.
- shouldBeAloneOnLineWithNotAloneOption(RightCurlyCheck.Details, String) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Whether right curly should be alone on line when ALONE_OR_SINGLELINE or SAME option is used.
- shouldBeDeclaredAsFinal(FinalClassCheck.ClassDesc) - Static method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Checks whether a class should be declared as final or not.
- shouldBeOnSameLine(RightCurlyOption, RightCurlyCheck.Details) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Checks that a right curly should be on the same line as the next statement.
- shouldBeProcessed(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Checks whether the current node should be processed by the check.
- shouldCheck(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Whether we should check this node.
- shouldCheck(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Whether we should check this node.
- shouldCheck(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Whether we should check this node.
- shouldCheck(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
-
Whether we should check this node.
- shouldCheck(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
-
Whether we should check this node.
- shouldCheck(DetailAST, Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
-
Whether we should check this node.
- shouldCheckEnhancedForLoopVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Determines whether enhanced for-loop variable should be checked or not.
- shouldCheckIdentTokenNestedUnderDot(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Whether to check identifier token nested under dotAst.
- shouldCheckInScope(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
-
Should we check member with given modifiers.
- shouldCheckLastRcurly - Variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Should check last right curly.
- shouldCheckSeparationFromNextToken(DetailAST, char) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Check if it should be checked if next token is separated from current by whitespace.
- shouldCheckSeparationFromPreviousToken(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
-
Check if it should be checked if previous token is separated from current by whitespace.
- shouldCheckUnnamedVariable(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Determines whether unnamed variable should be checked or not.
- shouldCheckWhitespaceAfter(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
-
Returns whether whitespace after a visited node should be checked.
- shouldHaveLineBreakBefore(RightCurlyOption, RightCurlyCheck.Details) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Checks whether a right curly should have a line break before.
- shouldIgnoreClass(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
-
Checks if class is annotated by specific annotation(s) to skip.
- shouldIgnoreMethod(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
-
Check if the method is specified in the ignore method list.
- shouldIgnoreNumberOfParameters(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
-
Determine whether to ignore number of parameters.
- shouldIncreaseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Checks that indentation should be increased after first line in checkLinesIndent().
- shouldIncreaseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.MethodCallHandler
- shouldIncreaseIndent() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.NewHandler
- shouldRemoveFinalVariableCandidate(FinalLocalVariableCheck.ScopeData, DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Whether the final variable candidate should be removed from the list of final local variable candidates.
- shouldSelectCell(EventObject) - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
- shouldSuppress(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.CommentSuppressor
- shouldSuppress(int, int, int, int) - Method in interface com.puppycrawl.tools.checkstyle.checks.regexp.MatchSuppressor
-
Checks if the specified selection should be suppressed.
- shouldSuppress(int, int, int, int) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.NeverSuppress
- shouldTestAnnotationArgs(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Checks if ast is annotation argument and should be checked.
- shouldTestAnnotationDefaults(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
-
Checks if ast is annotation element default value and should be checked.
- shouldUpdateUninitializedVariables(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
If there is an
else
following or token is CASE_GROUP or SWITCH_RULE and there is anothercase
following, then update the uninitialized variables. - siblingEnum - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.FollowingIterator
-
Following-sibling axis iterator.
- SimplifyBooleanExpressionCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks for over-complicated boolean expressions.
- SimplifyBooleanExpressionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
- SimplifyBooleanReturnCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks for over-complicated boolean return or yield statements.
- SimplifyBooleanReturnCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
- SINCE - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@since
. - SINCE_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@since' literal in
@since
Javadoc tag. - SINCE_VERSION_FOR_INHERITED_PROPERTY - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Map of properties whose since version is different from module version but are not specified in code because they are inherited from their super class(es).
- SINGLE_LINE_COMMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Beginning of single-line comment: '//'.
- SINGLE_TAGS - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
HTML tags that do not require a close tag.
- SINGLE_THREAD_MODE_INSTANCE - Static variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
A single thread mode settings instance.
- singlelineComments - Variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Cpp style comments.
- SinglelineDetector - Class in com.puppycrawl.tools.checkstyle.checks.regexp
-
A detector that matches individual lines.
- SinglelineDetector(DetectorOptions) - Constructor for class com.puppycrawl.tools.checkstyle.checks.regexp.SinglelineDetector
-
Creates an instance.
- SingleLineJavadocCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that a Javadoc block can fit in a single-line and doesn't contain block tags.
- SingleLineJavadocCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
- SingleSpaceSeparatorCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks that non-whitespace characters are separated by no more than one whitespace.
- SingleSpaceSeparatorCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
- singleton(T) - Static method in class com.puppycrawl.tools.checkstyle.utils.UnmodifiableCollectionUtil
-
Returns an immutable set containing only the specified object.
- SINGLETON_ELEMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Parent node for all singleton html tags.
- SiteUtil - Class in com.puppycrawl.tools.checkstyle.site
-
Utility class for site generation.
- SiteUtil() - Constructor for class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Private utility constructor.
- SiteUtil.DescriptionExtractor - Class in com.puppycrawl.tools.checkstyle.site
-
Utility class for extracting description from a method's Javadoc.
- size() - Method in class com.puppycrawl.tools.checkstyle.api.FileText
-
Counts the lines of the text.
- skipAnnotations - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
-
Specify annotations that allow missed documentation.
- skipAnnotations(Iterator<DetailAST>) - Static method in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
-
Skip all annotations in modifier block.
- skipDoubleBraceInstInit(RightCurlyCheck.Details) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
This method determines if the double brace initialization should be skipped over by the check.
- skipEnhancedForLoopVariable - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Control whether to check enhanced for-loop variable.
- skipFileOnJavaParseException - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Control whether to skip files with Java parsing exceptions.
- skipHtmlComment(String[], TagParser.Point) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Skips HTML comments.
- skipIfLastAndSharedWithCase - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
-
Control whether to allow
default
along withcase
if they are not last. - skipModifierAnnotations(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Skip all
TokenTypes.ANNOTATION
s to the first non-annotation. - skipUnnamedVariables(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Check for skip current
TokenTypes.VARIABLE_DEF
due to allowUnnamedVariable option. - skipVariableAssign(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Skips over an inner assign portion of an argument expression.
- SL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
<<
(shift left) operator. - SL_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
<<=
(left shift assignment) operator. - SLASH - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Slash html tag component:
'/'
. - SLASH_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Slash close html tag component:
'/>'
. - SLIST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A list of statements.
- SlistHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for a list of statements.
- SlistHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.SlistHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- sLocale - Static variable in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
The locale to localise messages to.
- sortImportsInGroupAlphabetically - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Force grouping alphabetically, in ASCII sort order.
- sortStaticImportsAlphabetically - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Control whether static imports located at top or bottom are sorted within the group.
- source - Variable in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
The object on which the Event initially occurred.
- SOURCE_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
"source" tag name.
- SOURCE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
HTML void element
<source>
. - sourceClass - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
Class of the source for this Violation.
- sourceClass - Variable in class com.puppycrawl.tools.checkstyle.LocalizedMessage
-
Class of the source for this message.
- sourceContent - Variable in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
The source content of the input reader.
- sourceFromFilename(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Creates an input source from a file.
- SPACE - com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
-
Represents mandatory spacing following a left parenthesis and preceding a right one.
- SPACE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Space literal.
- SPACE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck
-
Pattern matching single space.
- SPACE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck
-
Pattern matching single space.
- SPECIAL_IMPORTS_RULE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
SPECIAL_IMPORTS group name.
- specialImportsRegExp - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Specify RegExp for SPECIAL_IMPORTS group imports.
- SR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
>>
(signed shift right) operator. - SR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
>>=
(signed right shift assignment) operator. - SRC - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'src'.
- stack - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Used to hold the
AbstractImportControl
objects. - stack - Variable in class com.puppycrawl.tools.checkstyle.xpath.iterators.ReverseDescendantIterator
-
Stack for child nodes, to represent them in reverse order.
- STANDARD_JAVA_PACKAGE_RULE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
STANDARD_JAVA_PACKAGE group name.
- standardPackageRegExp - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Specify RegExp for STANDARD_JAVA_PACKAGE group imports.
- STAR - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
*
(multiplication or wildcard) operator. - STAR_ASSIGN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
*=
(multiplication assignment) operator. - STAR_IMPORT_SUFFIX - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
-
Suffix for the star import.
- STAR_IMPORT_SUFFIX - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
Suffix for the star import.
- START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start html tag component:
'<'
. - startColNo - Variable in class com.puppycrawl.tools.checkstyle.api.Comment
-
Number of first column of the comment.
- startElement(String, String, String, Attributes) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
- startElement(String, String, String, Attributes) - Method in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
- startElement(String, String, String, Attributes) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
- startElement(String, String, String, Attributes) - Method in class com.puppycrawl.tools.checkstyle.PackageNamesLoader
- startLineNo - Variable in class com.puppycrawl.tools.checkstyle.api.Comment
-
Number of first line of the comment.
- startsWithInheritDoc(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks if the node starts with an {@inheritDoc}.
- StartWith() - Constructor for enum com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith
- STATE_CTOR_DEF - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
State for the CTOR_DEF.
- STATE_INSTANCE_VARIABLE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
State for the VARIABLE_DEF.
- STATE_METHOD_DEF - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
State for the METHOD_DEF.
- STATE_STATIC_VARIABLE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
-
State for the VARIABLE_DEF.
- StatelessCheck - Annotation Type in com.puppycrawl.tools.checkstyle
-
This annotation means that the check does not contain mutable state and may be safely used from others threads at the same time.
- STATEMENT - com.puppycrawl.tools.checkstyle.checks.blocks.BlockOption
-
Represents the policy that there is a statement in the block.
- STATIC_IMPORT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A static import declaration.
- STATIC_INIT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A static initialization block.
- STATIC_KEYWORD - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Name for 'static' keyword.
- STATIC_KEYWORD - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Name for 'static' keyword.
- STATIC_KEYWORD - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Name for 'static' keyword.
- STATIC_RULE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
STATIC group name.
- staticFields - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
-
Set of static field names.
- staticGroups - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Specify list of static import groups.
- staticGroupsReg - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Complied array of patterns for property
staticGroups
. - staticImport - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck.ImportDetails
-
Is static import.
- staticImports - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
-
Set of static imports.
- staticImportsApart - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Whether static and type import groups should be split apart.
- StaticInitHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for static initialization blocks.
- StaticInitHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.StaticInitHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- staticMembers - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Set of idents of variables declared in this frame.
- staticMethods - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.ClassFrame
-
Set of idents of static methods declared in this frame.
- staticType - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.FieldFrame
-
Is this a static inner type.
- StaticVariableNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that
static
, non-final
variable names conform to a specified pattern. - StaticVariableNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck
-
Creates a new
StaticVariableNameCheck
instance. - stopCellEditing() - Method in class com.puppycrawl.tools.checkstyle.gui.BaseCellEditor
- storePrevScopeUninitializedVariableData() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Store un-initialized variables in a temporary stack for future use.
- STRATEGY_ON_MISMATCH_ALLOWED_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Value "allowed" for attribute 'strategyOnMismatch'.
- STRATEGY_ON_MISMATCH_ATTRIBUTE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Name for attribute 'strategyOnMismatch'.
- STRATEGY_ON_MISMATCH_DISALLOWED_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Value "disallowed" for attribute 'strategyOnMismatch'.
- strategyOnMismatch - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl
-
Strategy in a case if matching allow/disallow rule was not found.
- streamTextParts(DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Streams through all the text under the given node.
- STRICTFP - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
strictfp
keyword. - STRING - com.puppycrawl.tools.checkstyle.PropertyType
-
This property is a string.
- STRING - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Quoted text.
- STRING - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Type name for comparison.
- STRING_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A string literal.
- STRING_PARAMETER_NAMES - Static variable in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
Set of possible String array types.
- STRING_SEPARATOR - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Separator to use in strings.
- StringLiteralEqualityCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that string literals are not used with
==
or!=
. - StringLiteralEqualityCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
- stringMap - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
-
The found strings and their tokens.
- stripIndentAndInitialNewLineFromTextBlock(String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Strip initial newline and preceding whitespace on each line from text block content.
- stripIndentAndTrailingWhitespaceFromLine(String, int) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Helper method for stripIndentAndInitialNewLineFromTextBlock, strips correct indent from string, and trailing whitespace, or returns empty string if no text.
- stripTrailing(int...) - Static method in class com.puppycrawl.tools.checkstyle.utils.CodePointUtil
-
Removes trailing whitespaces.
- SUBPACKAGE_ELEMENT_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlLoader
-
Qualified name for element 'subpackage'.
- SUFFIX - Static variable in class com.puppycrawl.tools.checkstyle.AuditEventDefaultFormatter
-
Suffix of module names like XXXXCheck.
- SUMMARY_TEXT - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Summary tag text.
- SummaryJavadocCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Checks that Javadoc summary sentence does not contain phrases that are not recommended to use.
- SummaryJavadocCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
- sumTokenCounts - Variable in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
-
Control whether the number of tokens found should be calculated from the sum of the individual token counts.
- SUPER_CLASS_PROPERTIES_JAVADOCS - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Map of all superclasses properties and their javadocs.
- SUPER_CTOR_CALL - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A super constructor call.
- superClassOfAnonymousInnerClass - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Whether the class is the super class of an anonymous inner class.
- SuperCloneCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that an overriding
clone()
method invokessuper.clone()
. - SuperCloneCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.SuperCloneCheck
- SuperFinalizeCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that an overriding
finalize()
method invokessuper.finalize()
. - SuperFinalizeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.SuperFinalizeCheck
- supportsTextAttribute(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
-
Checks, if specified node can have
@text
attribute. - SUPPRESS_WARNINGS - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
-
SuppressWarnings
annotation name. - SuppressFilterElement - Class in com.puppycrawl.tools.checkstyle.filters
-
This filter element is immutable and processes
AuditEvent
objects based on the criteria of file, check, module id, line, and column. - SuppressFilterElement(String, String, String, String, String, String) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Constructs a
SuppressFilterElement
for a file name pattern. - SuppressFilterElement(Pattern, Pattern, Pattern, String, String, String) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
Creates a
SuppressFilterElement
instance. - Suppression(String, int, SuppressWithNearbyTextFilter) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter.Suppression
-
Constructs new
Suppression
instance. - Suppression(String, int, SuppressWithPlainTextCommentFilter.SuppressionType, SuppressWithPlainTextCommentFilter) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Creates new suppression instance.
- SuppressionCommentFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressionCommentFilter
uses pairs of comments to suppress audit events. - SuppressionCommentFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
- SuppressionCommentFilter.Tag - Class in com.puppycrawl.tools.checkstyle.filters
-
A Tag holds a suppression comment and its location, and determines whether the suppression turns checkstyle reporting on or off.
- SuppressionCommentFilter.TagType - Enum in com.puppycrawl.tools.checkstyle.filters
-
Enum to be used for switching checkstyle reporting for tags.
- SuppressionFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressionFilter
rejects audit events for Check violations according to a suppressions XML document in a file. - SuppressionFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
- suppressionLineColumnNumber - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
LineNo and columnNo for the suppression.
- suppressions - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
-
Suppressions encountered in current file.
- SuppressionSingleFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressionSingleFilter
suppresses audit events for Checks violations in the specified file, class, checks, message, module id, lines, and columns. - SuppressionSingleFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionSingleFilter
- SuppressionsLoader - Class in com.puppycrawl.tools.checkstyle.filters
-
Loads a filter chain of suppressions.
- SuppressionsLoader() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
Creates a new
SuppressionsLoader
instance. - SuppressionsStringPrinter - Class in com.puppycrawl.tools.checkstyle
-
Class for constructing xpath queries to suppress nodes with specified line and column number.
- SuppressionsStringPrinter() - Constructor for class com.puppycrawl.tools.checkstyle.SuppressionsStringPrinter
-
Prevent instances.
- suppressionType - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression
-
Suppression type.
- SuppressionType() - Constructor for enum com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.SuppressionType
- SuppressionXpathFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressionXpathFilter
works as SuppressionFilter. - SuppressionXpathFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter
- SuppressionXpathSingleFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressionXpathSingleFilter
suppresses audit events for Checks violations in the specified file, class, checks, message, module id, and xpath. - SuppressionXpathSingleFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
- suppressor - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions
-
Used to determine whether to suppress a detected match.
- suppressor(MatchSuppressor) - Method in class com.puppycrawl.tools.checkstyle.checks.regexp.DetectorOptions.Builder
-
Specifies the suppressor to use and returns Builder object.
- SuppressWarningsCheck - Class in com.puppycrawl.tools.checkstyle.checks.annotation
-
Allows to specify what warnings that
@SuppressWarnings
is not allowed to suppress. - SuppressWarningsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
- SuppressWarningsFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressWarningsFilter
uses annotation@SuppressWarnings
to suppress audit events. - SuppressWarningsFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressWarningsFilter
- SuppressWarningsHolder - Class in com.puppycrawl.tools.checkstyle.checks
-
Maintains a set of check suppressions from
@SuppressWarnings
annotations. - SuppressWarningsHolder() - Constructor for class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
- SuppressWarningsHolder.Entry - Class in com.puppycrawl.tools.checkstyle.checks
-
Records a particular suppression for a region of a file.
- SuppressWithNearbyCommentFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressWithNearbyCommentFilter
uses nearby comments to suppress audit events. - SuppressWithNearbyCommentFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
- SuppressWithNearbyCommentFilter.Tag - Class in com.puppycrawl.tools.checkstyle.filters
-
A Tag holds a suppression comment and its location.
- SuppressWithNearbyTextFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressWithNearbyTextFilter
uses plain text to suppress nearby audit events. - SuppressWithNearbyTextFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyTextFilter
- SuppressWithNearbyTextFilter.Suppression - Class in com.puppycrawl.tools.checkstyle.filters
-
The class which represents the suppression.
- SuppressWithPlainTextCommentFilter - Class in com.puppycrawl.tools.checkstyle.filters
-
Filter
SuppressWithPlainTextCommentFilter
uses plain text to suppress audit events. - SuppressWithPlainTextCommentFilter() - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter
- SuppressWithPlainTextCommentFilter.Suppression - Class in com.puppycrawl.tools.checkstyle.filters
-
The class which represents the suppression.
- SuppressWithPlainTextCommentFilter.SuppressionType - Enum in com.puppycrawl.tools.checkstyle.filters
-
Enum which represents the type of the suppression.
- SWITCH_RULE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Switch Expressions.
- SWITCH_RULE_CHILDREN - Static variable in class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchRuleHandler
-
The child elements of a switch rule.
- SWITCH_STATEMENT_PARENTS - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
-
Represents the possible parent tokens of a switch statement.
- switchBlockAsSingleDecisionPoint - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Control whether to treat the whole switch block as a single decision point.
- SwitchHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for switch statements.
- SwitchHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- SwitchRuleHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for switch rules.
- SwitchRuleHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.SwitchRuleHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- SynchronizedHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for synchronized statements.
- SynchronizedHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.SynchronizedHandler
-
Construct an instance of this handler with the given indentation check, name, abstract syntax tree, and parent handler.
- syntaxError(Recognizer<?, ?>, Object, int, int, String, RecognitionException) - Method in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.DescriptiveErrorListener
-
Logs parser errors in Checkstyle manner.
- syntaxError(Recognizer<?, ?>, Object, int, int, String, RecognitionException) - Method in class com.puppycrawl.tools.checkstyle.JavaParser.CheckstyleErrorListener
- SYSTEM - com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
System default line separators.
T
- TAB - Static variable in class com.puppycrawl.tools.checkstyle.AstTreeStringPrinter
-
Tab pattern.
- TAB - Static variable in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Tab pattern.
- tableRow() - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
Write a table row tag.
- tableRows(int[], boolean) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
Write a table tag.
- tabWidth - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
The tab width for column reporting.
- tabWidth - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
The tab width for column reporting.
- tabWidth - Variable in class com.puppycrawl.tools.checkstyle.Checker
-
The tab width for column reporting.
- tabWidth - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Tab character length.
- tabWidth - Variable in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
The distance between tab stop position.
- tabWidth - Variable in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
-
The distance between tab stop position.
- tag - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Specify the name of tag.
- Tag(int, int, String, SuppressionCommentFilter.TagType, SuppressionCommentFilter) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Constructs a tag.
- Tag(String, int, SuppressWithNearbyCommentFilter) - Constructor for class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
Constructs a tag.
- tagCheckRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
The parsed check regexp, expanded for the text of this tag.
- tagCheckRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
The parsed check regexp, expanded for the text of this tag.
- tagCommentLine(String, int) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Tags a string if it matches the format for turning checkstyle reporting on or the format for turning reporting off.
- tagCommentLine(String, int, int) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Tags a string if it matches the format for turning checkstyle reporting on or the format for turning reporting off.
- tagFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Specify the regexp to match tag content.
- tagIdRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
The parsed check ID regexp, expanded for the text of this tag.
- tagIdRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
The parsed check ID regexp, expanded for the text of this tag.
- tagInfo - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
-
The JavadocTagInfo representing this tag.
- TagInfo - Class in com.puppycrawl.tools.checkstyle.checks.javadoc.utils
-
Value object for storing data about a parsed tag.
- TagInfo(String, String, LineColumn) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
Constructor.
- tagMessageRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
The parsed message regexp, expanded for the text of this tag.
- tagMessageRegexp - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
The parsed message regexp, expanded for the text of this tag.
- tagOrder - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
-
Specify the order by tags.
- TagParser - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Helper class used to parse HTML tags or generic type identifiers from a single-line of text.
- TagParser(String[], int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
Constructs a TagParser and finds the first tag if any.
- TagParser.Point - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Represents current position in the text.
- tagRegExp - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Compiled regexp to match tag.
- tags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
-
Specify the javadoc tags to process.
- tags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.TagParser
-
HtmlTags found on the input line of text.
- tags - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Tagged comments.
- tags - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Tagged comments.
- tagSeverity - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
-
Specify the severity level when tag is found and printed.
- tagSuppressions() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Collects all the suppression tags for all comments into a list and sorts the list.
- tagSuppressions() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Collects all the suppression tags for all comments into a list and sorts the list.
- tagSuppressions(Collection<TextBlock>) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
-
Appends the suppressions in a collection of comments to the full set of suppression tags.
- tagSuppressions(Collection<TextBlock>) - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter
-
Appends the suppressions in a collection of comments to the full set of suppression tags.
- tagType - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
Determines whether the suppression turns checkstyle reporting on.
- TagType() - Constructor for enum com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.TagType
- target - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
-
Specify block tags targeted.
- TBODY - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table body html tag.
- TBODY_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table body tag name.
- TBODY_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End table body tag.
- TBODY_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start table body tag.
- TD - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table cell html tag:
<td></td>
. - TD_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table cell tag name.
- TD_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End table cell tag.
- TD_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start table cell tag.
- TEMP_DIR - Static variable in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
-
User working directory.
- text - Variable in class com.puppycrawl.tools.checkstyle.api.Comment
-
Text of the comment.
- text - Variable in class com.puppycrawl.tools.checkstyle.api.FileContents
-
The text.
- text - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
-
The comment line of text where this tag appears.
- text - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
-
Token's text.
- text - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Node's text content.
- text - Variable in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
The tag text.
- text - Variable in class com.puppycrawl.tools.checkstyle.checks.regexp.MultilineDetector
-
The file text content.
- text - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
Text of this DetailAST.
- text - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
-
The text of the tag.
- text - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
-
The text of the tag.
- text - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Text for a frame's text area.
- TEXT - com.puppycrawl.tools.checkstyle.checks.blocks.BlockOption
-
Represents the policy that there is some text in the block.
- TEXT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
CHAR and WS sequence.
- TEXT_ATTRIBUTE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
String literal for text attribute.
- TEXT_BLOCK_CONTENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Content of a Java 15 text block.
- TEXT_BLOCK_LITERAL_BEGIN - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Text blocks are a new feature added to to Java SE 15 and later that will make writing multi-line strings much easier and cleaner.
- TEXT_BLOCK_LITERAL_END - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
End of a Java 15 text block literal, delimited by three double quotes.
- TEXT_TO_TAG - Static variable in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Holds tag text to tag enum mappings.
- textArea - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
Code text area.
- TextBlock - Interface in com.puppycrawl.tools.checkstyle.api
-
A block of text from an input file that does not necessarily have any grammatical structure.
- TFOOT - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table foot html tag.
- TFOOT_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table foot tag name.
- TFOOT_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End table foot tag.
- TFOOT_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start table foot tag.
- TH - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table header cell html tag:
<th></th>
. - TH_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table header cell tag name.
- TH_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End table header cell tag.
- TH_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start table header cell tag.
- THE_AST_IS_NULL - Static variable in class com.puppycrawl.tools.checkstyle.utils.AnnotationUtil
-
Common message.
- THEAD - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table head html tag.
- THEAD_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table head tag name.
- THEAD_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End table head tag.
- THEAD_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start table head tag.
- THIRD_PARTY_PACKAGE_RULE_GROUP - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
THIRD_PARTY_PACKAGE group name.
- thirdPartyNameToFullModuleNames - Variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Map of third party Checkstyle module names to the set of their fully qualified names.
- thirdPartyPackageRegExp - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Specify RegExp for THIRD_PARTY_PACKAGE group imports.
- threadModeSettings - Variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
The thread mode configuration.
- threadModeSettings - Variable in class com.puppycrawl.tools.checkstyle.DefaultConfiguration
-
The thread mode configuration.
- ThreadModeSettings - Class in com.puppycrawl.tools.checkstyle
-
Thread mode settings for the checkstyle modules.
- ThreadModeSettings(int, int) - Constructor for class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
Initializes the thread mode configuration.
- THROWS - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@throws
. - THROWS_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@throws' literal in
@throws
Javadoc tag. - ThrowsCountCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Restricts throws statements to a specified count.
- ThrowsCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Creates new instance of the check.
- throwsIndent - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
Specify how far a throws clause should be indented when on next line.
- throwUnsupportedOperationException() - Static method in class com.puppycrawl.tools.checkstyle.xpath.AbstractElementNode
-
Returns UnsupportedOperationException exception.
- throwUnsupportedOperationException() - Static method in class com.puppycrawl.tools.checkstyle.xpath.AbstractRootNode
-
Returns UnsupportedOperationException exception.
- throwUnsupportedOperationException() - Static method in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
Returns UnsupportedOperationException exception.
- TIME_SUFFIX - Static variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask
-
Suffix for time string.
- title - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrameModel
-
Title for the main frame.
- toByteArray(InputStream) - Static method in class com.puppycrawl.tools.checkstyle.PropertyCacheFile
-
Reads all the contents of an input stream and returns it as a byte array.
- TodoCommentCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Checks for
TODO:
comments. - TodoCommentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
- toFile - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
The file to output to.
- Token(FullIdent) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
-
Converts FullIdent to Token.
- Token(String, int, int) - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
-
Creates token.
- TOKEN_ARRAY - com.puppycrawl.tools.checkstyle.PropertyType
-
This property is a set of tokens.
- TOKEN_ID_EXCEPTION_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Format for exception message when getting token by given id.
- TOKEN_IDS - Static variable in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Array of all token IDs.
- TOKEN_NAME_EXCEPTION_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Format for exception message when getting token by given name.
- TOKEN_NAME_TO_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Maps from a token name to value.
- TOKEN_NAME_TO_VALUE - Static variable in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Maps from a token name to value.
- TOKEN_TEXT_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Regular expression for detecting ANTLR tokens(for e.g.
- TOKEN_TYPES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'TokenTypes'.
- TOKEN_TYPES_WITH_TEXT_ATTRIBUTE - Static variable in class com.puppycrawl.tools.checkstyle.utils.XpathUtil
-
Token types which support text attribute.
- TOKEN_VALUE_TO_NAME - Static variable in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Maps from a token value to name.
- TOKEN_VALUE_TO_NAME - Static variable in class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Maps from a token value to name.
- TokenEnd() - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.TokenEnd
- tokens - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
The tokens the check is interested in.
- tokens - Variable in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
Token stream to check for hidden tokens.
- TOKENS - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
The string 'tokens'.
- TOKENS_FOR_INTERFACE_MODIFIERS - Static variable in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
-
An array of tokens for interface modifiers.
- TOKENS_PROPERTY - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
This property is used to change the existing properties for javadoc.
- TOKENS_WITH_NO_CHILD_SLIST - Static variable in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.Details
-
Token types that identify tokens that will never have SLIST in their AST.
- tokenToCommentChecks - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Maps from token name to comment checks.
- tokenToOrdinaryChecks - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Maps from token name to ordinary checks.
- tokenType - Variable in class com.puppycrawl.tools.checkstyle.api.Violation
-
The token type constant.
- tokenType - Variable in class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
The token type of the element for which the query should be generated.
- TokenTypes - Class in com.puppycrawl.tools.checkstyle.api
-
Contains the constants for all the tokens contained in the Abstract Syntax Tree.
- TokenTypes() - Constructor for class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
Prevent instantiation.
- TokenUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Contains utility methods for tokens.
- TokenUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.TokenUtil
-
Stop instances being created.
- toLinesArray() - Method in class com.puppycrawl.tools.checkstyle.api.FileText
-
Returns an array of all lines.
- TOP - com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
-
Represents the policy that static imports are all at the top.
- topLevelType(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
-
If the given type string contains "."
- toRegex(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportControl
-
Converts a normal package name into a regex pattern by escaping all special characters that may occur in a java package name.
- toScan - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Boolean variable which lets us know whether we should scan and scrape the current javadoc or not.
- toString() - Method in class com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilterSet
- toString() - Method in class com.puppycrawl.tools.checkstyle.api.Comment
- toString() - Method in class com.puppycrawl.tools.checkstyle.api.FilterSet
- toString() - Method in class com.puppycrawl.tools.checkstyle.api.FullIdent
- toString() - Method in enum com.puppycrawl.tools.checkstyle.api.Scope
- toString() - Method in enum com.puppycrawl.tools.checkstyle.api.SeverityLevel
- toString() - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentLevel
- toString() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag
- toString() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.Token
- toString() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
- toString() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
- toString() - Method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
- toString() - Method in enum com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
- toString() - Method in class com.puppycrawl.tools.checkstyle.DetailAstImpl
- toString() - Method in class com.puppycrawl.tools.checkstyle.filters.IntMatchFilterElement
- toString() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag
- toString() - Method in class com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
- toString() - Method in enum com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
- toString() - Method in enum com.puppycrawl.tools.checkstyle.Main.OutputFormat
-
Returns the name in lowercase.
- total - Variable in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
-
Tracks the total.
- TR - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table row html tag:
<tr></tr>
. - TR_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Table row tag name.
- TR_TAG_END - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
End table row tag.
- TR_TAG_START - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Start table row tag.
- TRACK_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
"track" tag name.
- TRACK_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
HTML void element
<track>
. - trailingArrayComma - Variable in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
-
Define the policy for trailing comma in arrays.
- TrailingArrayCommaOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.TrailingArrayCommaOption
- TrailingCommentCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
The check to ensure that lines with code do not end with comment.
- TrailingCommentCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
- TRANSLATION_BUNDLE - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Resource bundle which contains messages for TranslationCheck.
- TranslationCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Ensures the correct translation of code by checking property files for consistency regarding their keys.
- TranslationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Creates a new
TranslationCheck
instance. - TranslationCheck.ResourceBundle - Class in com.puppycrawl.tools.checkstyle.checks
-
Class which represents a resource bundle.
- traverseFieldFrameTree(EqualsAvoidNullCheck.FieldFrame) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
-
Traverse the tree of the field frames to check all equals method calls.
- treatTryResourcesAsStatement - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
-
Enable resources processing.
- tree - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
A subclass of JTree.
- tree - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
-
JTree component.
- tree - Variable in class com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
DetailNode tree (is null if parsing fails).
- TREE_CACHE - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Key is the block comment node "lineNo".
- TREE_WALKER_MODULE_NAME - Static variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
A three walker module name.
- TREE_WALKER_THREADS_NUMBER - Static variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
The tree walker threads number.
- treeCollapsed(TreeExpansionEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeExpansionListener
- treeExpanded(TreeExpansionEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeExpansionListener
- treeInfo - Variable in class com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
The
TreeInfo
object. - treeNodesChanged(TreeModelEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeModelListener
- treeNodesInserted(TreeModelEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeModelListener
- treeNodesRemoved(TreeModelEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeModelListener
- treeStructureChanged(TreeModelEvent) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeModelListener
- treeTable - Variable in class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
TreeTable to perform updates on.
- treeTable - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
Tree table.
- treeTable - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
Tree table to render.
- TreeTable - Class in com.puppycrawl.tools.checkstyle.gui
-
This example shows how to create a simple TreeTable component, by using a JTree as a renderer (and editor) for the cells in a particular column in the JTable.
- TreeTable(ParseTreeTableModel) - Constructor for class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Creates TreeTable base on TreeTableModel.
- TreeTable.TreeTableCellEditor - Class in com.puppycrawl.tools.checkstyle.gui
-
TreeTableCellEditor implementation.
- TreeTableCellEditor() - Constructor for class com.puppycrawl.tools.checkstyle.gui.TreeTable.TreeTableCellEditor
- TreeTableCellRenderer - Class in com.puppycrawl.tools.checkstyle.gui
-
A TreeCellRenderer that displays a JTree.
- TreeTableCellRenderer(TreeTable, TreeModel) - Constructor for class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
Creates a new instance.
- treeTableModel - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
-
Tree table model.
- TreeTableModelAdapter - Class in com.puppycrawl.tools.checkstyle.gui
-
This is a wrapper class takes a TreeTableModel and implements the table model interface.
- TreeTableModelAdapter(ParseTreeTableModel, JTree) - Constructor for class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter
-
Initialise tree and treeTableModel class attributes.
- TreeTableModelAdapter.UpdatingTreeExpansionListener - Class in com.puppycrawl.tools.checkstyle.gui
-
TreeExpansionListener that can update the table when tree changes.
- TreeTableModelAdapter.UpdatingTreeModelListener - Class in com.puppycrawl.tools.checkstyle.gui
-
TreeModelListener that can update the table when tree changes.
- TreeWalker - Class in com.puppycrawl.tools.checkstyle
-
Responsible for walking an abstract syntax tree and notifying interested checks at each node.
- TreeWalker() - Constructor for class com.puppycrawl.tools.checkstyle.TreeWalker
-
Creates a new
TreeWalker
instance. - TreeWalker.AstState - Enum in com.puppycrawl.tools.checkstyle
-
State of AST.
- TreeWalkerAuditEvent - Class in com.puppycrawl.tools.checkstyle
-
Raw
TreeWalker
event for audit. - TreeWalkerAuditEvent(FileContents, String, Violation, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Creates a new
TreeWalkerAuditEvent
instance. - TreeWalkerFilter - Interface in com.puppycrawl.tools.checkstyle
-
An interface for filtering
TreeWalkerAuditEvent
. - treeWalkerFilters - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
The set of the
TreeWalkerFilter
filters. - treeWalkerThreadsNumber - Variable in class com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
The tree walker threads number.
- trimExcessWhitespaces(String) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Trims the given
text
of duplicate whitespaces. - trimTail(StringBuilder) - Static method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
-
Trims any trailing whitespace or the end of Javadoc comment string.
- TRY_IN_ALL_REGISTERED_PACKAGES - com.puppycrawl.tools.checkstyle.PackageObjectFactory.ModuleLoadOption
-
As SEARCH_REGISTERED_PACKAGES and also try to load class from all of packages given in constructor.
- TRY_WITH_RESOURCES_FRAME - com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
-
Try with resources frame type.
- tryCopyProperty(String, Object, boolean) - Method in class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
Recheck property and try to copy it.
- TryHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for try blocks.
- TryHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.TryHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- TryWithResourcesFrame(RequireThisCheck.AbstractFrame, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.TryWithResourcesFrame
-
Creates try-with-resources frame.
- type - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
The formatter type.
- type - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl
-
Node type.
- type - Variable in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
The tag type.
- type - Variable in class com.puppycrawl.tools.checkstyle.DetailAstImpl
-
The type of this DetailAST.
- type - Variable in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
Type of property.
- Type() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo.Type
- TYPE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A type.
- TYPE_ARGUMENT - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A type arguments to a type reference or a method/ctor invocation.
- TYPE_ARGUMENTS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A list of type arguments to a type reference or a method/ctor invocation.
- TYPE_EXTENSION_AND - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
&
symbol when used to extend a generic upper or lower bounds constrain or a type cast expression with an additional interface. - TYPE_LOWER_BOUNDS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A lower bounds on a wildcard type argument.
- TYPE_NAME_IN_JAVADOC_TAG - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Pattern to match type name within angle brackets in javadoc param tag.
- TYPE_NAME_IN_JAVADOC_TAG_SPLITTER - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Pattern to split type name field in javadoc param tag.
- TYPE_PARAMETER - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A type parameter to a class, interface or method definition.
- TYPE_PARAMETERS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A list of type parameters to a class, interface or method definition.
- TYPE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Regular expression for property type location in class-level javadocs.
- TYPE_UPPER_BOUNDS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An upper bounds on a wildcard type argument or type parameter.
- typeAst - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Ast of type
TokenTypes.TYPE
. - TYPECAST - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A type-cast.
- TypecastParenPadCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks the policy on the padding of parentheses for typecasts.
- TypecastParenPadCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
- typeDeclarationAst - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.TypeDeclarationDescription
-
Type declaration ast node.
- TypeDeclarationDescription(String, int, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.TypeDeclarationDescription
-
Create an instance of TypeDeclarationDescription.
- typeDeclarationNameMatchingCount(String, String) - Static method in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Calculates and returns the type declaration name matching count.
- typeDeclarations - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Keeps track of all the type declarations present in the file.
- typeDeclarations - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Keeps TypeDeclarationDescription object for stack of declared type descriptions.
- typeDeclAst - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
Type declaration ast node.
- typeDeclAstToTypeDeclDesc - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Maps type declaration ast to their respective TypeDeclDesc objects.
- TypeDeclDesc(String, int, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc
-
Create a new TypeDeclDesc instance.
- typeDeclWithSameName(String) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Checks if there is a type declaration with same name as the super class.
- typeHandlers - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.HandlerFactory
-
Registered handlers.
- typeName - Variable in class com.puppycrawl.tools.checkstyle.checks.indentation.AbstractExpressionHandler
-
Name used during output to user.
- TypeNameCheck - Class in com.puppycrawl.tools.checkstyle.checks.naming
-
Checks that type names conform to a specified pattern.
- TypeNameCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
-
Creates a new
TypeNameCheck
instance. - TYPES_HASH_SET - Static variable in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
-
Token types to find parent of.
U
- UNABLE_TO_FIND_ERROR_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader
-
File search error message.
- UNABLE_TO_FIND_EXCEPTION_PREFIX - Static variable in class com.puppycrawl.tools.checkstyle.utils.CommonUtil
-
Prefix for the exception when unable to find resource.
- UNABLE_TO_INSTANTIATE_EXCEPTION_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.PackageObjectFactory
-
Exception message when it is unable to create a class instance.
- UNABLE_TO_LOAD - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
-
A part of message for exception.
- UNABLE_TO_PARSE_EXCEPTION_PREFIX - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader
-
Prefix for the exception when unable to parse resource.
- UNACCEPTABLE_CHILD_OF_DOT - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
An array of unacceptable children of ast of type
TokenTypes.DOT
. - UNACCEPTABLE_PARENT_OF_IDENT - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
An array of unacceptable parent of ast of type
TokenTypes.IDENT
. - UNARY_AND_POSTFIX - Static variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Token types for unary and postfix operators.
- UNARY_MINUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
-
(unary minus) operator. - UNARY_PLUS - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The
+
(unary plus) operator. - UncommentedMainCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Detects uncommented
main
methods. - UncommentedMainCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
- UNDEFINED_PROPERTY_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.utils.ChainedPropertyUtil
-
Used to report undefined property in exception message.
- UNDER - com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
-
Represents the policy that static imports are under the local group.
- UNDERSCORE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.utils.CheckUtil
-
Pattern matching underscore characters ('_').
- UNDOCUMENTED_PROPERTIES - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Set of properties that are undocumented.
- UNICODE_CONTROL - Static variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Regular expression Unicode control characters.
- UNICODE_ESCAPE_UPPER_LIMIT - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Unicode escaping upper limit.
- UNICODE_LENGTH - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The length of unicode placeholder.
- UNICODE_REGEXP - Static variable in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
-
Regular expression for Unicode chars.
- uninitializedVariables - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.ScopeData
-
Contains definitions of uninitialized variables.
- UniqueProperties() - Constructor for class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck.UniqueProperties
- UniquePropertiesCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Detects duplicated keys in properties files.
- UniquePropertiesCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.UniquePropertiesCheck
-
Construct the check with default values.
- UniquePropertiesCheck.UniqueProperties - Class in com.puppycrawl.tools.checkstyle.checks
-
Properties subclass to store duplicated property keys in a separate map.
- UNKNOWN - com.puppycrawl.tools.checkstyle.checks.imports.AccessResult
-
Represents that access is unknown.
- UNKNOWN_COLUMN_MSG - Static variable in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
-
Exception message.
- UNKNOWN_JAVADOC_TOKEN_ID_EXCEPTION_MESSAGE - Static variable in class com.puppycrawl.tools.checkstyle.utils.JavadocUtil
-
Exception message for unknown JavaDoc token id.
- UnmodifiableCollectionUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Note: it simply wraps the existing JDK methods to provide a workaround for Pitest survival on mutation for removal of immutable wrapping, see #13127 for more details.
- UnmodifiableCollectionUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.UnmodifiableCollectionUtil
-
Private constructor for UnmodifiableCollectionUtil.
- unmodifiableList(Collection<S>, Class<T>) - Static method in class com.puppycrawl.tools.checkstyle.utils.UnmodifiableCollectionUtil
-
Returns an unmodifiable view of a List containing elements of a specific type.
- unmodifiableList(List<T>) - Static method in class com.puppycrawl.tools.checkstyle.utils.UnmodifiableCollectionUtil
-
Creates an unmodifiable list based on the provided collection.
- UNNAMED_PATTERN_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
An unnamed pattern variable definition.
- unnecessaryParenAroundOperators(DetailAST) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
-
Checks if conditional, relational, bitwise binary operator, unary and postfix operators in expressions are surrounded by unnecessary parentheses.
- UnnecessaryParenthesesCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks if unnecessary parentheses are used in a statement or expression.
- UnnecessaryParenthesesCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
- UnnecessarySemicolonAfterOuterTypeDeclarationCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks if unnecessary semicolon is used after type declaration.
- UnnecessarySemicolonAfterOuterTypeDeclarationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterOuterTypeDeclarationCheck
- UnnecessarySemicolonAfterTypeMemberDeclarationCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks if unnecessary semicolon is used after type member declaration.
- UnnecessarySemicolonAfterTypeMemberDeclarationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
- UnnecessarySemicolonInEnumerationCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks if unnecessary semicolon is in enum definitions.
- UnnecessarySemicolonInEnumerationCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck
- UnnecessarySemicolonInTryWithResourcesCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks if unnecessary semicolon is used in last resource declaration.
- UnnecessarySemicolonInTryWithResourcesCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
- UNSIGNED_RIGHT_SHIFT - Static variable in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
-
String representation of the unsigned right shift operator.
- UnusedCatchParameterShouldBeUnnamedCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Ensures that catch parameters that are not used are declared as an unnamed variable.
- UnusedCatchParameterShouldBeUnnamedCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
- UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Maintains information about the catch parameter.
- UnusedImportsCheck - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Checks for unused import statements.
- UnusedImportsCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
- UnusedImportsCheck.Frame - Class in com.puppycrawl.tools.checkstyle.checks.imports
-
Holds the names of referenced types and names of declared inner types.
- UnusedLambdaParameterShouldBeUnnamedCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Ensures that lambda parameters that are not used are declared as an unnamed variable.
- UnusedLambdaParameterShouldBeUnnamedCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
- UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Maintains information about the lambda parameter.
- UnusedLocalVariableCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks that a local variable is declared and/or assigned, but not used.
- UnusedLocalVariableCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
- UnusedLocalVariableCheck.TypeDeclDesc - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Maintains information about the type declaration.
- UnusedLocalVariableCheck.VariableDesc - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Maintains information about the variable.
- updateAllUninitializedVariables() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Update current scope data uninitialized variable according to the whole scope data.
- updateCurrentScopeAssignedVariables() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Update assigned variables in a temporary stack.
- updateDirectory(Path) - Static method in class com.puppycrawl.tools.checkstyle.utils.OsSpecificUtil
-
Updates the specified directory by resolving symbolic links, ensuring it exists, and creating any necessary parent directories.
- updateRegexp() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
-
Updates the
IllegalTokenTextCheck.format
based on the values fromIllegalTokenTextCheck.formatString
andIllegalTokenTextCheck.ignoreCase
. - updateSelectedPathIfRowIsSelected(int) - Method in class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
If the row at given index is selected, selected paths are updated.
- updateSelectedPathsFromSelectedRows() - Method in class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
If
updatingListSelectionModel
is false, this will reset the selected paths from the selected rows in the list selection model. - updateTreeTable(String, Deque<DetailAST>) - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Updates the Treetable by expanding paths in the tree and highlighting associated code.
- updateUI() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
Overridden to message super and forward the method to the tree.
- updateUI() - Method in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
UpdateUI is overridden to set the colors of the Tree's renderer to match that of the table.
- updateUninitializedVariables(Deque<DetailAST>) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Update current scope data uninitialized variable according to the specific scope data.
- updatingListSelectionModel - Variable in class com.puppycrawl.tools.checkstyle.gui.ListToTreeSelectionModelWrapper
-
Set to true when we are updating the ListSelectionModel.
- UpdatingTreeExpansionListener() - Constructor for class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeExpansionListener
- UpdatingTreeModelListener() - Constructor for class com.puppycrawl.tools.checkstyle.gui.TreeTableModelAdapter.UpdatingTreeModelListener
- upperBound - Variable in class com.puppycrawl.tools.checkstyle.filters.IntRangeFilterElement
-
Upper bound of the range.
- UpperEllCheck - Class in com.puppycrawl.tools.checkstyle.checks
-
Checks that long constants are defined with an upper ell.
- UpperEllCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
- URI_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The placeholder for uri.
- UriConverter() - Constructor for class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.UriConverter
- URL_F - Static variable in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Represents the format string for constructing URLs with two placeholders.
- useContainerOrderingForStatic - Variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
Control whether to use container ordering (Eclipse IDE term) for static imports or not.
- used - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails
-
Is the variable used.
- used - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails
-
Is the variable used.
- used - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Is the variable used.
- useFile - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Formatter
-
Whether or not to write to the named file.
- Utf8Control() - Constructor for class com.puppycrawl.tools.checkstyle.LocalizedMessage.Utf8Control
V
- VALID_SUPPRESSION_LINE_COLUMN_NUMBER_REGEX - Static variable in class com.puppycrawl.tools.checkstyle.SuppressionsStringPrinter
-
Line and column number config value pattern.
- validate(RightCurlyCheck.Details) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
-
Does general validation.
- validateAbstractClassNames - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Control whether to validate abstract class names.
- validateBetweenScopes - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
-
Allow to calculate the distance between declaration of variable and its first usage in the different scopes.
- validateCli(CommandLine.ParseResult, List<File>) - Method in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Validates the user-specified command line options.
- validateComments - Variable in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Control whether to validate whitespaces surrounding comments.
- validateDefaultJavadocTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Validates that check's required javadoc tokens are subset of default javadoc tokens.
- validateEnhancedForLoopVariable - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Control whether to check enhanced for-loop variable.
- validateEol(DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Validate EOL case.
- validateExtraEmptyLine(CustomImportOrderCheck.ImportDetails, CustomImportOrderCheck.ImportDetails, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Log violation if extra empty line is present.
- validateInlineReturnTag(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks the inline return for forbidden fragments.
- validateMissedEmptyLine(CustomImportOrderCheck.ImportDetails, CustomImportOrderCheck.ImportDetails, String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
-
Log violation if empty line is missed.
- validateNewLinePosition(DetailAST, DetailAST, String) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Validate token on new Line position.
- validateNonObjects(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
-
Checks for explicit initializations made to 'false', '0' and '\0'.
- validateOnlyOverlapping - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
-
Control whether to check only overlapping by variables or arguments.
- validateOptionalCliParametersIfConfigDefined() - Method in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Validates optional command line parameters that might be used with config file.
- validateSummaryTag(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks the inline summary (if present) for
period
at end and forbidden fragments. - validateThrows - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
-
Control whether to validate
throws
tags. - validateUnnamedVariables - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
-
Control whether to check unnamed variables.
- validateUntaggedSummary(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
-
Checks the javadoc text for
period
at end and forbidden fragments. - validateUserSpecifiedLanguageCodes(Set<String>) - Method in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
Validates the correctness of user specified language codes for the check.
- VALIDATION_TYPE_TAG - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Regular expression for property validation type location in class-level javadocs.
- validationType - Variable in class com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails
-
This property is java type that plugins can use to validate user input, it is used when 'type' field is "String".
- validTags - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags
-
Valid validTags.
- value - Variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.Property
-
The property value.
- value - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
Value of the tag.
- value - Variable in class com.puppycrawl.tools.checkstyle.xpath.AttributeNode
-
The value of the attribute.
- value() - Method in annotation type com.puppycrawl.tools.checkstyle.XdocsPropertyType
-
Returns the property type for documentation.
- value(Scope) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.MethodCounter
-
Gets the value of a scope counter.
- VALUE - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
{@value}
. - VALUE - Static variable in class com.puppycrawl.tools.checkstyle.ConfigurationLoader.InternalLoader
-
Value attribute.
- VALUE_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@value' literal in {@value} Javadoc inline tag.
- valueForPathChanged(TreePath, Object) - Method in class com.puppycrawl.tools.checkstyle.gui.ParseTreeTableModel
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.api.Scope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ClosingParensOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ElementStyleOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.TrailingArrayCommaOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.blocks.BlockOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.imports.AccessResult
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.imports.MismatchStrategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler.LineWrappingOptions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.ConfigurationLoader.IgnoredModulesOptions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.TagType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.SuppressionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.JavaParser.Options
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.Main.OutputFormat
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.meta.ModuleType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.PackageObjectFactory.ModuleLoadOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.PropertyType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.TreeWalker.AstState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.utils.JavadocUtil.JavadocTagType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith
-
Returns the enum constant of this type with the specified name.
- values - Variable in class com.puppycrawl.tools.checkstyle.PropertiesExpander
-
The underlying values.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.api.Scope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ClosingParensOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.ElementStyleOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.TrailingArrayCommaOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.blocks.BlockOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.FrameType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.imports.AccessResult
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.imports.MismatchStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.indentation.LineWrappingHandler.LineWrappingOptions
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.LineSeparatorOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.ConfigurationLoader.IgnoredModulesOptions
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.TagType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.SuppressionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.gui.MainFrameModel.ParseMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.JavaParser.Options
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.Main.OutputFormat
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.meta.ModuleType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.PackageObjectFactory.ModuleLoadOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.PropertyType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.TreeWalker.AstState
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.utils.JavadocUtil.JavadocTagType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator.StartWith
-
Returns an array containing the constants of this enum type, in the order they are declared.
- Values(BigInteger, BigInteger) - Constructor for class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.Values
-
Constructor that assigns all of class fields.
- VALUES - Static variable in class com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask.FormatterType
-
My possible values.
- valueStack - Variable in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Stack of values - all but the current value.
- VARIABLE_DEF - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
A field or local variable declaration.
- VariableDeclarationUsageDistanceCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Checks the distance between declaration of variable and its first usage.
- VariableDeclarationUsageDistanceCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
- VariableDesc(String) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Create a new VariableDesc instance.
- VariableDesc(String, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Create a new VariableDesc instance.
- VariableDesc(String, DetailAST, DetailAST) - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.VariableDesc
-
Create a new VariableDesc instance.
- variableIdent - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.FinalVariableCandidate
-
Identifier token.
- variables - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Keeps tracks of the variables declared in file.
- variableStack - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
-
Stack of block parameters.
- varIdents - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.AbstractFrame
-
Set of name of variables declared in this frame.
- verifyBrace(DetailAST, DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Verifies that a specified left curly brace is placed correctly according to policy.
- verifyImport(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule
-
Verifies whether a package name is used.
- verifyImport(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ClassImportRule
-
Verifies whether a class name is used.
- verifyImport(String) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.PkgImportRule
-
Verifies whether a package name is used.
- VERSION - com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo
-
@version
. - VERSION_3_0 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_3_2 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_3_4 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_5_0 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_5_1 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_5_7 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_6_9 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_7_7 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_8_24 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_8_36 - Static variable in class com.puppycrawl.tools.checkstyle.site.SiteUtil
-
Frequent version.
- VERSION_LITERAL - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
'@version' literal in
@version
Javadoc tag. - VERSION_PLACEHOLDER - Static variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
The placeholder for version.
- versionFormat - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
-
Specify the pattern for
@version
tag. - violateExecutionOnNonTightHtml - Variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
This property determines if a check should log a violation upon encountering javadoc with non-tight html.
- violateImpliedAbstractMethod - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Control whether to enforce that
abstract
is explicitly coded on interface methods. - violateImpliedFinalField - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Control whether to enforce that
final
is explicitly coded on interface fields. - violateImpliedPublicField - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Control whether to enforce that
public
is explicitly coded on interface fields. - violateImpliedPublicMethod - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Control whether to enforce that
public
is explicitly coded on interface methods. - violateImpliedPublicNested - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Control whether to enforce that
public
is explicitly coded on interface nested types. - violateImpliedStaticField - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Control whether to enforce that
static
is explicitly coded on interface fields. - violateImpliedStaticNested - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
-
Control whether to enforce that
static
is explicitly coded on interface nested types. - violateImpliedStaticOnNestedEnum - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Control whether to enforce that
static
is explicitly coded on nested enums in classes and records. - violateImpliedStaticOnNestedInterface - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Control whether to enforce that
static
is explicitly coded on nested interfaces in classes and records. - violateImpliedStaticOnNestedRecord - Variable in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
-
Control whether to enforce that
static
is explicitly coded on nested records in classes and records. - violation - Variable in class com.puppycrawl.tools.checkstyle.api.AuditEvent
-
Violation associated with the event.
- violation - Variable in class com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
Violation associated with the event.
- Violation - Class in com.puppycrawl.tools.checkstyle.api
-
Represents a violation that can be localised.
- Violation(int, int, int, int, String, String, Object[], SeverityLevel, String, Class<?>, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.Violation
-
Creates a new
Violation
instance. - Violation(int, int, int, String, String, Object[], SeverityLevel, String, Class<?>, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.Violation
-
Creates a new
Violation
instance. - Violation(int, int, String, String, Object[], SeverityLevel, String, Class<?>, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.Violation
-
Creates a new
Violation
instance. - Violation(int, int, String, String, Object[], String, Class<?>, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.Violation
-
Creates a new
Violation
instance. - Violation(int, String, String, Object[], SeverityLevel, String, Class<?>, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.Violation
-
Creates a new
Violation
instance. - Violation(int, String, String, Object[], String, Class<?>, String) - Constructor for class com.puppycrawl.tools.checkstyle.api.Violation
-
Creates a new
Violation
instance. - VIOLATION_MESSAGES_TAG - Static variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Regular expression for module violation messages location in class-level javadocs.
- violationMessageKeys - Variable in class com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
List of violation message keys of the module.
- ViolationMessagesMacro - Class in com.puppycrawl.tools.checkstyle.site
-
A macro that inserts a list of the violation messages.
- ViolationMessagesMacro() - Constructor for class com.puppycrawl.tools.checkstyle.site.ViolationMessagesMacro
- violations - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractCheck.FileContext
-
The sorted set for collecting violations.
- violations - Variable in class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck.FileContext
-
The sorted set for collecting violations.
- violations - Variable in class com.puppycrawl.tools.checkstyle.TreeWalker
-
The sorted set of violations.
- VisibilityModifierCheck - Class in com.puppycrawl.tools.checkstyle.checks.design
-
Checks visibility of class members.
- VisibilityModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- visibleRow - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTableCellRenderer
-
Last table/tree row asked to render.
- visit(ParseTree) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotation(JavaLanguageParser.AnnotationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotationField(JavaLanguageParser.AnnotationFieldContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotationMethodRest(JavaLanguageParser.AnnotationMethodRestContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotations(JavaLanguageParser.AnnotationsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotationType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Visit ANNOTATION literal and get its type to referenced classes of context.
- visitAnnotationType(JavaLanguageParser.AnnotationTypeContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotationTypeBody(JavaLanguageParser.AnnotationTypeBodyContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotationTypeDeclaration(JavaLanguageParser.AnnotationTypeDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAnnotationTypeElementDeclaration(JavaLanguageParser.AnnotationTypeElementDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitArguments(JavaLanguageParser.ArgumentsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitArrayCreatorRest(JavaLanguageParser.ArrayCreatorRestContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitArrayDeclarator(JavaLanguageParser.ArrayDeclaratorContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitArrayInitializer(JavaLanguageParser.ArrayInitializerContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitAssertExp(JavaLanguageParser.AssertExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitBinOp(JavaLanguageParser.BinOpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitBitShift(JavaLanguageParser.BitShiftContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitBlock(JavaLanguageParser.BlockContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitBlockStat(JavaLanguageParser.BlockStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitBooleanOperator() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.Context
-
Increases operator counter.
- visitBracketsWithExp(JavaLanguageParser.BracketsWithExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitBreakStat(JavaLanguageParser.BreakStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCaseConstant(JavaLanguageParser.CaseConstantContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCaseConstants(JavaLanguageParser.CaseConstantsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCaseLabel(JavaLanguageParser.CaseLabelContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCastExp(JavaLanguageParser.CastExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCatch(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Checks parameter of the catch block.
- visitCatchBlock(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
-
Visits catch ast node, if it is empty catch block - checks it according to Check's options.
- visitCatchClause(JavaLanguageParser.CatchClauseContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCatchParameter(JavaLanguageParser.CatchParameterContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCatchType(JavaLanguageParser.CatchTypeContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitClass(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Called to process a type definition.
- visitClassBlock(JavaLanguageParser.ClassBlockContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitClassBody(JavaLanguageParser.ClassBodyContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitClassCreatorRest(JavaLanguageParser.ClassCreatorRestContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitClassDeclaration(JavaLanguageParser.ClassDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitClassDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
Called when we start processing class definition.
- visitClassDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Creates new context for a given class.
- visitClassDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
-
Checks class definition.
- visitClassExtends(JavaLanguageParser.ClassExtendsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitClassOrInterfaceType(JavaLanguageParser.ClassOrInterfaceTypeContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitClassOrRecordDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
If not inner class then change current class name.
- visitClassRefPrimary(JavaLanguageParser.ClassRefPrimaryContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitComment(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
-
Checks comment indentations over surrounding code, e.g.:
- visitCompactConstructorDeclaration(JavaLanguageParser.CompactConstructorDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCompilationUnit(JavaLanguageParser.CompilationUnitContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitConditional(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Visits if, while, do-while, for and switch tokens - all of them have expression in parentheses which is used for calculation.
- visitConstructorBlock(JavaLanguageParser.ConstructorBlockContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitConstructorDeclaration(JavaLanguageParser.ConstructorDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitContainerNode(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
-
Process the start of the container node.
- visitContinueStat(JavaLanguageParser.ContinueStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCreatedNameObject(JavaLanguageParser.CreatedNameObjectContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCreatedNamePrimitive(JavaLanguageParser.CreatedNamePrimitiveContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCreator(JavaLanguageParser.CreatorContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitCtor(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
-
Called to process a constructor definition.
- visitDefaultLabel(JavaLanguageParser.DefaultLabelContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitDefaultValue(JavaLanguageParser.DefaultValueContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitDiamond(JavaLanguageParser.DiamondContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitDoStat(JavaLanguageParser.DoStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitDotToken(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Visit ast of type
TokenTypes.DOT
. - visitEachToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck
-
Examines every sibling and child of
node
for violations. - visitElementValue(JavaLanguageParser.ElementValueContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitElementValueArrayInitializer(JavaLanguageParser.ElementValueArrayInitializerContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitElementValuePair(JavaLanguageParser.ElementValuePairContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitElementValuePairs(JavaLanguageParser.ElementValuePairsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitElseStat(JavaLanguageParser.ElseStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEmptyClass(JavaLanguageParser.EmptyClassContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEmptyStat(JavaLanguageParser.EmptyStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnhancedFor(JavaLanguageParser.EnhancedForContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnhancedForControl(JavaLanguageParser.EnhancedForControlContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnhancedForControlWithRecordPattern(JavaLanguageParser.EnhancedForControlWithRecordPatternContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnumBody(JavaLanguageParser.EnumBodyContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnumBodyDeclarations(JavaLanguageParser.EnumBodyDeclarationsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnumConstant(JavaLanguageParser.EnumConstantContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnumConstants(JavaLanguageParser.EnumConstantsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitEnumDeclaration(JavaLanguageParser.EnumDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitExplicitCtorCall(JavaLanguageParser.ExplicitCtorCallContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitExpr() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Creates and pushes new context.
- visitExpression(JavaLanguageParser.ExpressionContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitExpressionList(JavaLanguageParser.ExpressionListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitExpStat(JavaLanguageParser.ExpStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitFieldDeclaration(JavaLanguageParser.FieldDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitFinallyBlock(JavaLanguageParser.FinallyBlockContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitFloatLiteral(JavaLanguageParser.FloatLiteralContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitForEachClause(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Checks parameter of the for each clause.
- visitForFor(JavaLanguageParser.ForForContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitForInit(JavaLanguageParser.ForInitContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitFormalLambdaParam(JavaLanguageParser.FormalLambdaParamContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitFormalParameter(JavaLanguageParser.FormalParameterContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitFormalParameterList(JavaLanguageParser.FormalParameterListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitFormalParameters(JavaLanguageParser.FormalParametersContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitForStat(JavaLanguageParser.ForStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitGuardedPattern(JavaLanguageParser.GuardedPatternContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitId(JavaLanguageParser.IdContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitIdentToken(DetailAST, Deque<UnusedLocalVariableCheck.VariableDesc>) - Static method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Visit ast of type
TokenTypes.IDENT
. - visitIfStat(JavaLanguageParser.IfStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitImplementsClause(JavaLanguageParser.ImplementsClauseContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitImport(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks imported type (as static and star imports are not supported by Check, only type is in the consideration).
If this type is illegal due to Check's options - puts violation on it. - visitImport(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks imported type.
- visitImportDec(JavaLanguageParser.ImportDecContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitIndexOp(JavaLanguageParser.IndexOpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInitExp(JavaLanguageParser.InitExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInnerCreator(JavaLanguageParser.InnerCreatorContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInnerPattern(JavaLanguageParser.InnerPatternContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInstanceOfExp(JavaLanguageParser.InstanceOfExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitIntegerLiteral(JavaLanguageParser.IntegerLiteralContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInterfaceBody(JavaLanguageParser.InterfaceBodyContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInterfaceBodyDeclaration(JavaLanguageParser.InterfaceBodyDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInterfaceDeclaration(JavaLanguageParser.InterfaceDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInterfaceExtends(JavaLanguageParser.InterfaceExtendsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInterfaceMethodDeclaration(JavaLanguageParser.InterfaceMethodDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitInvOp(JavaLanguageParser.InvOpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Called to process a Javadoc token.
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLeadingAsteriskAlignCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck
-
Logs when there is no empty line before the tag.
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
- visitJavadocToken(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.site.ClassAndPropertiesSettersJavadocScraper
- visitLabelStat(JavaLanguageParser.LabelStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitLambda() - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Creates new lambda context and places old one on the stack.
- visitLambda(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
Creates new set of parameters and store old one in stack.
- visitLambdaExp(JavaLanguageParser.LambdaExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitLambdaParameters(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
Creates new parameter set for given lambda expression.
- visitLastFormalParameter(JavaLanguageParser.LastFormalParameterContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitLastRecordComponent(JavaLanguageParser.LastRecordComponentContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitLiteral(JavaLanguageParser.LiteralContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitLiteralFor(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks parens in
TokenTypes.LITERAL_FOR
. - visitLiteralNew(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
-
Visits NEW.
- visitLiteralNew(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Visits NEW token for the current class context.
- visitLiteralReturn(int, Boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.Context
-
Increase the number of return statements and set context return type.
- visitLiteralThrows(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
-
Checks number of throws statements.
- visitLiteralThrows(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
-
Visits throws clause and collects all exceptions we throw.
- visitLiteralThrows(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Visits THROWS token for the current class context.
- visitLocalAnonInnerClass(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Visit the local anon inner class.
- visitLocalVar(JavaLanguageParser.LocalVarContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitMethod(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
-
Checks parameters of the method or ctor.
- visitMethodBody(JavaLanguageParser.MethodBodyContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitMethodCall(JavaLanguageParser.MethodCallContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitMethodCallOrRef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks the type arguments of given method call/reference.
- visitMethodDeclaration(JavaLanguageParser.MethodDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitMethodDef() - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Process the start of the method definition.
- visitMethodDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks return type of a given method.
- visitMethodDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
Creates new set of parameters and store old one in stack.
- visitMethodDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Creates new method context and places old one on the stack.
- visitMethodDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
-
Creates new context for a given method.
- visitMethodDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
Checks method definition if this is
public static void main(String[])
. - visitMethodParameters(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
Creates new parameter set for given method.
- visitMethodRef(JavaLanguageParser.MethodRefContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitModifier(JavaLanguageParser.ModifierContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitMultiLambdaParam(JavaLanguageParser.MultiLambdaParamContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitMultiLambdaParams(JavaLanguageParser.MultiLambdaParamsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitNewExp(JavaLanguageParser.NewExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitNonLocalTypeDeclarationToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Visit the non-local type declaration token.
- visitNonWildcardDiamond(JavaLanguageParser.NonWildcardDiamondContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitNonWildcardTypeArguments(JavaLanguageParser.NonWildcardTypeArgumentsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitOtherTokens(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
-
Called to process tokens other than
TokenTypes.VARIABLE_DEF
andTokenTypes.PARAMETER_DEF
. - visitPackageDeclaration(JavaLanguageParser.PackageDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPackageDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Stores package of current class we check.
- visitPackageDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
-
Sets current package.
- visitParameterDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks type of parameters.
- visitParameters(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
-
Visits parameter list and adds parameter names to the set.
- visitParenPattern(JavaLanguageParser.ParenPatternContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitParenPrimary(JavaLanguageParser.ParenPrimaryContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitParExpression(JavaLanguageParser.ParExpressionContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPattern(JavaLanguageParser.PatternContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPermittedSubclassesAndInterfaces(JavaLanguageParser.PermittedSubclassesAndInterfacesContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPostfix(JavaLanguageParser.PostfixContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPrefix(JavaLanguageParser.PrefixContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPrimaryCtorCall(JavaLanguageParser.PrimaryCtorCallContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPrimaryExp(JavaLanguageParser.PrimaryExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPrimitivePrimary(JavaLanguageParser.PrimitivePrimaryContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitPrimitiveType(JavaLanguageParser.PrimitiveTypeContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitQualifiedName(JavaLanguageParser.QualifiedNameContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitQualifiedNameList(JavaLanguageParser.QualifiedNameListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordBody(JavaLanguageParser.RecordBodyContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordComponent(JavaLanguageParser.RecordComponentContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordComponentPatternList(JavaLanguageParser.RecordComponentPatternListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordComponents(JavaLanguageParser.RecordComponentsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordComponentsList(JavaLanguageParser.RecordComponentsListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordDeclaration(JavaLanguageParser.RecordDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordPattern(JavaLanguageParser.RecordPatternContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRecordPatternDef(JavaLanguageParser.RecordPatternDefContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitRefOp(JavaLanguageParser.RefOpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitResourceDeclaration(JavaLanguageParser.ResourceDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitResources(JavaLanguageParser.ResourcesContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitResourceSpecification(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks parens in
TokenTypes.RESOURCE_SPECIFICATION
. - visitResourceSpecification(JavaLanguageParser.ResourceSpecificationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitReturn(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
-
Examines the return statement and tells context about it.
- visitReturnStat(JavaLanguageParser.ReturnStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSimpleMethodCall(JavaLanguageParser.SimpleMethodCallContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSimpleTypeArgument(JavaLanguageParser.SimpleTypeArgumentContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSingleLambdaParam(JavaLanguageParser.SingleLambdaParamContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSingleSemiImport(JavaLanguageParser.SingleSemiImportContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSlist(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
-
Process the end of a statement list.
- visitSuperExp(JavaLanguageParser.SuperExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSuperSuffixDot(JavaLanguageParser.SuperSuffixDotContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSwitchBlocks(JavaLanguageParser.SwitchBlocksContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSwitchBlockStatementGroup(JavaLanguageParser.SwitchBlockStatementGroupContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSwitchExpressionOrStatement(JavaLanguageParser.SwitchExpressionOrStatementContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSwitchLabeledBlock(JavaLanguageParser.SwitchLabeledBlockContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSwitchLabeledExpression(JavaLanguageParser.SwitchLabeledExpressionContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSwitchLabeledThrow(JavaLanguageParser.SwitchLabeledThrowContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSwitchRules(JavaLanguageParser.SwitchRulesContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitSyncStat(JavaLanguageParser.SyncStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTernaryOp(JavaLanguageParser.TernaryOpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTextBlockLiteral(JavaLanguageParser.TextBlockLiteralContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitThisExp(JavaLanguageParser.ThisExpContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitThrowsList(JavaLanguageParser.ThrowsListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitThrowStat(JavaLanguageParser.ThrowStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Called to process a token.
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationOnSameLineCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.EmptyCatchBlockCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck
-
Visits token.
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AbstractSuperCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidDoubleBraceInitializationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.AvoidNoArgumentSuperConstructorCallCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingNullCaseInSwitchCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoArrayTrailingCommaCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoEnumTrailingCommaCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterOuterTypeDeclarationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedCatchParameterShouldBeUnnamedCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLambdaParameterShouldBeUnnamedCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.SealedShouldHavePermitsListCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportControlCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ClassMemberImpliedModifierCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.InterfaceMemberImpliedModifierCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.LambdaParameterNameCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.LambdaBodyLengthCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.sizes.RecordComponentNumberCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.UpperEllCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
- visitTokenHook(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck
-
Hook called when visiting a token.
- visitTokenPrimary(JavaLanguageParser.TokenPrimaryContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTokenWithOptionalParentheses(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
Checks parens in token which may not contain parens, e.g.
- visitTryStat(JavaLanguageParser.TryStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTryWithResourceStat(JavaLanguageParser.TryWithResourceStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck.ClassContext
-
Visits type.
- visitType(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
-
Visits type token for the current class context.
- visitTypeArgs(JavaLanguageParser.TypeArgsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeArguments(JavaLanguageParser.TypeArgumentsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeArgumentsTypeList(JavaLanguageParser.TypeArgumentsTypeListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeBound(JavaLanguageParser.TypeBoundContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeBoundType(JavaLanguageParser.TypeBoundTypeContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeCastParameters(JavaLanguageParser.TypeCastParametersContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeDeclaration(JavaLanguageParser.TypeDeclarationContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks the super type and implemented interfaces of a given type.
- visitTypeList(JavaLanguageParser.TypeListContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeParameter(JavaLanguageParser.TypeParameterContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeParameters(JavaLanguageParser.TypeParametersContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypePatternDef(JavaLanguageParser.TypePatternDefContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeType(JavaLanguageParser.TypeTypeContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitTypeUpperBounds(JavaLanguageParser.TypeUpperBoundsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitUnitaryOperator(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Visits ternary operator (?
- visitUnnamedPatternDef(JavaLanguageParser.UnnamedPatternDefContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitVariableAccess(JavaLanguageParser.VariableAccessContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitVariableDeclarator(JavaLanguageParser.VariableDeclaratorContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitVariableDeclaratorId(JavaLanguageParser.VariableDeclaratorIdContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitVariableDeclarators(JavaLanguageParser.VariableDeclaratorsContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitVariableDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck
-
Checks type of given variable.
- visitVariableDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
-
Checks variable definition.
- visitVariableDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
-
Checks access modifier of given variable.
- visitVariableDefToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck
-
Visit ast of type
TokenTypes.VARIABLE_DEF
. - visitVariableModifier(JavaLanguageParser.VariableModifierContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitWhenExpression(DetailAST, int) - Method in class com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck
-
Visits when expression token.
- visitWhileStat(JavaLanguageParser.WhileStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitWildCardTypeArgument(JavaLanguageParser.WildCardTypeArgumentContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
- visitYieldStat(JavaLanguageParser.YieldStatContext) - Method in class com.puppycrawl.tools.checkstyle.JavaAstVisitor
W
- walk(DetailAST, FileContents, TreeWalker.AstState) - Method in class com.puppycrawl.tools.checkstyle.TreeWalker
-
Initiates the walk of an AST.
- walk(DetailNode) - Method in class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck
-
Processes a node calling Check at interested nodes.
- walkConditional(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck
-
Recursively walks a conditional expression checking the left and right sides, checking for matches and logging violations.
- WARNING - com.puppycrawl.tools.checkstyle.api.SeverityLevel
-
Severity level warning.
- WBR_HTML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
"wbr" tag name.
- WBR_TAG - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
HTML void element
<wbr>
. - WhenShouldBeUsedCheck - Class in com.puppycrawl.tools.checkstyle.checks.coding
-
Ensures that
when
is used instead of a singleif
statement inside a case block. - WhenShouldBeUsedCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.coding.WhenShouldBeUsedCheck
- WhileHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for while loops.
- WhileHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.WhileHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
- WHITESPACE - Static variable in class com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
Compiled pattern used to match whitespace in text block content.
- WHITESPACE_PATTERN - Static variable in class com.puppycrawl.tools.checkstyle.checks.javadoc.utils.InlineTagUtil
-
Pattern matching whitespace, used by
InlineTagUtil.collapseWhitespace(String)
. - WhitespaceAfterCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator.
- WhitespaceAfterCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck
- WhitespaceAroundCheck - Class in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Checks that a token is surrounded by whitespace.
- WhitespaceAroundCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck
- WILDCARD_GROUP_NAME - Static variable in class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
-
The special wildcard that catches all remaining groups.
- WILDCARD_TYPE - Static variable in class com.puppycrawl.tools.checkstyle.api.TokenTypes
-
The type that refers to all types.
- WITH_COMMENTS - com.puppycrawl.tools.checkstyle.JavaParser.Options
-
Comments nodes should be processed.
- WITH_COMMENTS - com.puppycrawl.tools.checkstyle.TreeWalker.AstState
-
AST contains comment nodes.
- withNestedSubclass - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Does class have nested subclass.
- withNonPrivateCtor - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
-
Does class have non-private ctors.
- WITHOUT_COMMENTS - com.puppycrawl.tools.checkstyle.JavaParser.Options
-
Comments nodes should be ignored.
- WrapOption - Enum in com.puppycrawl.tools.checkstyle.checks.whitespace
-
Represents the options for wrapping on an operator.
- WrapOption() - Constructor for enum com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption
- write(ModuleDetails) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
-
Helper function to write module details to XML file.
- write(String, int, int) - Method in class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink.CustomPrintWriter
-
Unifies all newline characters to Unix-Style Newline character.
- writeException(Throwable) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
-
Writes the exception event to the print writer.
- writeFileClosingTag() - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
-
Prints the "file" closing tag.
- writeFileError(AuditEvent) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
-
Outputs the given event to the writer.
- writeFileMessages(String, XMLLogger.FileMessages) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
-
Prints the file section with all file errors and exceptions.
- writeFileOpeningTag(String) - Method in class com.puppycrawl.tools.checkstyle.XMLLogger
-
Prints the "file" opening tag with the given filename.
- writeLink(Sink) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Write a link when all types of token supported.
- writeLinkToToken(Sink, String, String) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a link to the given token.
- writePropertiesFile(JavadocPropertiesGenerator.CliOptions) - Static method in class com.puppycrawl.tools.checkstyle.JavadocPropertiesGenerator
-
Creates the .properties file from a .java file.
- writePropertiesTable(XdocSink) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes the properties table for the given module.
- writePropertyDefaultValueCell(Sink, String, Field, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a table cell with the property default value.
- writePropertyDescriptionCell(Sink, String, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a table cell with the property description.
- writePropertyNameCell(Sink, String) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a table cell with the given property name.
- writePropertyRow(Sink, String, DetailNode, Object, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a table row with 5 columns for the given property - name, description, type, default value, since.
- writePropertySinceVersionCell(Sink, String, DetailNode, DetailNode) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a table cell with the property since version.
- writePropertyTypeCell(Sink, String, Field, Object) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a table cell with the property type.
- writer - Variable in class com.puppycrawl.tools.checkstyle.SarifLogger
-
Helper writer that allows easy encoding and printing.
- writer - Variable in class com.puppycrawl.tools.checkstyle.XMLLogger
-
Helper writer that allows easy encoding and printing.
- writer - Variable in class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
-
Helper writer that allows easy encoding and printing.
- writerLock - Variable in class com.puppycrawl.tools.checkstyle.XMLLogger
-
The writer lock object.
- writeSnippet(Sink, String) - Static method in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Write the given snippet to the file inside a source block.
- writeTableHeaderCell(Sink, String) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes a table header cell with the given text.
- writeTableHeaderRow(Sink) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes the table header row with 5 columns - name, description, type, default value, since.
- writeTablePropertiesRows(Sink) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Writes the rows of the table with the 5 columns - name, description, type, default value, since.
- WriteTagCheck - Class in com.puppycrawl.tools.checkstyle.checks.javadoc
-
Requires user defined Javadoc tag to be present in Javadoc comment with defined format.
- WriteTagCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck
- writeToFile(Document, ModuleDetails) - Static method in class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
-
Function to write the prepared document object into an XML file.
- writeTokensList(Sink, List<String>, String, boolean) - Static method in class com.puppycrawl.tools.checkstyle.site.PropertiesMacro
-
Write a list of tokens with links to the tokenTypesLink file.
- writeXmlOutput - Variable in class com.puppycrawl.tools.checkstyle.meta.JavadocMetadataScraper
-
Control whether to write XML output or not.
- WRONG_LANGUAGE_CODE_KEY - Static variable in class com.puppycrawl.tools.checkstyle.checks.TranslationCheck
-
A key is pointing to the warning message text for wrong language code in "messages.properties" file.
- wrongType - Variable in class com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck
-
Outer type with mismatched file name.
- WS - Static variable in class com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes
-
Whitespace or tab ('\t') symbol.
X
- XdocsPropertyType - Annotation Type in com.puppycrawl.tools.checkstyle
-
The type of property used in documentation and configuration files for clarification of the user-friendly type.
- XdocsTemplateParser - Class in com.puppycrawl.tools.checkstyle.site
-
Parser for Checkstyle's xdoc templates.
- XdocsTemplateParser() - Constructor for class com.puppycrawl.tools.checkstyle.site.XdocsTemplateParser
- XdocsTemplateSink - Class in com.puppycrawl.tools.checkstyle.site
-
A sink for Checkstyle's xdoc templates.
- XdocsTemplateSink(Writer, String) - Constructor for class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
Create a new instance, initialize the Writer.
- XdocsTemplateSink.CustomPrintWriter - Class in com.puppycrawl.tools.checkstyle.site
-
A Custom writer that only prints Unix-style newline character.
- XdocsTemplateSinkFactory - Class in com.puppycrawl.tools.checkstyle.site
-
Xdoc template implementation of the
SinkFactory
. - XdocsTemplateSinkFactory() - Constructor for class com.puppycrawl.tools.checkstyle.site.XdocsTemplateSinkFactory
- XML - com.puppycrawl.tools.checkstyle.Main.OutputFormat
-
XML output format.
- XML_CONFIG_END - Static variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Ending delimiter for config snippets.
- XML_CONFIG_START - Static variable in class com.puppycrawl.tools.checkstyle.site.ExampleMacro
-
Starting delimiter for config snippets.
- XML_TAG_DESCRIPTION - Static variable in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Description tag of metadata XML files.
- XML_TAG_DESCRIPTION - Static variable in class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
-
Description tag of metadata XML files.
- XML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Name tag of metadata XML files.
- XML_TAG_NAME - Static variable in class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
-
Name tag of metadata XML files.
- XmlLoader - Class in com.puppycrawl.tools.checkstyle
-
Contains the common implementation of a loader, for loading a configuration from an XML file.
- XmlLoader(Map<String, String>) - Constructor for class com.puppycrawl.tools.checkstyle.XmlLoader
-
Creates a new instance.
- XmlLoader.LoadExternalDtdFeatureProvider - Class in com.puppycrawl.tools.checkstyle
-
Used for setting specific for secure java installations features to SAXParserFactory.
- XMLLogger - Class in com.puppycrawl.tools.checkstyle
-
Simple XML logger.
- XMLLogger(OutputStream, AbstractAutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.XMLLogger
-
Creates a new
XMLLogger
instance. - XMLLogger(OutputStream, AutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.XMLLogger
-
Creates a new
XMLLogger
instance. - XMLLogger.FileMessages - Class in com.puppycrawl.tools.checkstyle
-
The registered file messages.
- XmlMetaReader - Class in com.puppycrawl.tools.checkstyle.meta
-
Class having utilities required to read module details from an XML metadata file of a module.
- XmlMetaReader() - Constructor for class com.puppycrawl.tools.checkstyle.meta.XmlMetaReader
-
Do no allow
XmlMetaReader
instances to be created. - XmlMetaWriter - Class in com.puppycrawl.tools.checkstyle.meta
-
Class to write module details object into an XML file.
- XmlMetaWriter() - Constructor for class com.puppycrawl.tools.checkstyle.meta.XmlMetaWriter
-
Do no allow
XmlMetaWriter
instances to be created. - xpath - Variable in class com.puppycrawl.tools.checkstyle.Main.CliOptions
-
Show AST branches that match xpath.
- xpathEditor - Variable in class com.puppycrawl.tools.checkstyle.gui.TreeTable
-
JTextArea xpathEditor.
- xpathExpression - Variable in class com.puppycrawl.tools.checkstyle.checks.coding.MatchXpathCheck
-
Xpath expression.
- xpathExpression - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Xpath expression.
- XpathFileGeneratorAstFilter - Class in com.puppycrawl.tools.checkstyle
-
Catches
TreeWalkerAuditEvent
and generates corresponding xpath query. - XpathFileGeneratorAstFilter() - Constructor for class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
- XpathFileGeneratorAuditListener - Class in com.puppycrawl.tools.checkstyle
-
Generates suppressions.xml file, based on violations occurred.
- XpathFileGeneratorAuditListener(OutputStream, AbstractAutomaticBean.OutputStreamOptions) - Constructor for class com.puppycrawl.tools.checkstyle.XpathFileGeneratorAuditListener
-
Creates a new
SuppressionFileGenerator
instance. - xpathFilter - Variable in class com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter
-
XpathFilterElement instance.
- XpathFilterElement - Class in com.puppycrawl.tools.checkstyle.filters
-
This filter element is immutable and processes
TreeWalkerAuditEvent
objects based on the criteria of file, check, module id, xpathQuery. - XpathFilterElement(String, String, String, String, String) - Constructor for class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Creates a
XpathElement
instance. - XpathFilterElement(Pattern, Pattern, Pattern, String, String) - Constructor for class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Creates a
XpathElement
instance. - xpathQuery - Variable in class com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
-
Xpath query.
- XpathQueryGenerator - Class in com.puppycrawl.tools.checkstyle.xpath
-
Generates xpath queries.
- XpathQueryGenerator(DetailAST, int, int, int, FileText, int) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Creates a new
XpathQueryGenerator
instance. - XpathQueryGenerator(DetailAST, int, int, FileText, int) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Creates a new
XpathQueryGenerator
instance. - XpathQueryGenerator(TreeWalkerAuditEvent, int) - Constructor for class com.puppycrawl.tools.checkstyle.xpath.XpathQueryGenerator
-
Creates a new
XpathQueryGenerator
instance. - xpathTextArea - Variable in class com.puppycrawl.tools.checkstyle.gui.MainFrame
-
Xpath text area.
- XpathUtil - Class in com.puppycrawl.tools.checkstyle.utils
-
Contains utility methods for xpath.
- XpathUtil() - Constructor for class com.puppycrawl.tools.checkstyle.utils.XpathUtil
-
Stop instances being created.
Y
- YieldHandler - Class in com.puppycrawl.tools.checkstyle.checks.indentation
-
Handler for yield expression.
- YieldHandler(IndentationCheck, DetailAST, AbstractExpressionHandler) - Constructor for class com.puppycrawl.tools.checkstyle.checks.indentation.YieldHandler
-
Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.
All Classes All Packages