Uses of Interface
com.puppycrawl.tools.checkstyle.api.DetailAST
Packages that use DetailAST
Package
Description
Contains the implementation of the Checkstyle framework.
Contains the core API to be used to implement checks.
Contains the checks that are bundled with the main distribution.
Contains the Annotation checks that are
bundled with the main distribution.
Contains the Block checks that are
bundled with the main distribution.
Contains the Coding checks that are
bundled with the main distribution.
Contains the Class Design checks that
are bundled with the main distribution.
Contains the Imports checks that are
bundled with the main distribution.
Contains all classes required for the
indentation check.
Contains the Javadoc checks that are bundled with the main distribution.
Contains the Metrics checks that are
bundled with the main distribution.
Contains the modifier checks that are bundled with the main distribution.
Contains the Naming conventions checks
that are bundled with the main distribution.
Contains the regular expression checks that are bundled with the main
distribution.
Contains the Size Violations checks
that are bundled with the main distribution.
Contains the Whitespace checks that
are bundled with the main distribution.
User interface classes for CheckStyle.
Contains utils classes for checkstyle.
Contains the nodes implementations for XPATH queries and query generator.
-
Uses of DetailAST in com.puppycrawl.tools.checkstyle
Classes in com.puppycrawl.tools.checkstyle that implement DetailASTMethods in com.puppycrawl.tools.checkstyle that return DetailASTModifier and TypeMethodDescriptionstatic DetailASTJavaParser.appendHiddenCommentNodes(DetailAST root) Appends comment nodes to existing AST.DetailAstImpl.findFirstToken(int type) DetailAstImpl.getLastChild()DetailAstImpl.getParent()DetailAstImpl.getPreviousSibling()TreeWalkerAuditEvent.getRootAst()Gets the root element of the AST tree.static DetailASTJavaParser.parse(FileContents contents) Static helper method to parses a Java source file.static DetailASTJavaParser.parseFile(File file, JavaParser.Options options) Parses Java source file.static DetailASTJavaParser.parseFileText(FileText text, JavaParser.Options options) Parse a text and return the parse tree.Methods in com.puppycrawl.tools.checkstyle with parameters of type DetailASTModifier and TypeMethodDescriptionvoidDetailAstImpl.addNextSibling(DetailAST ast) Add next sibling.voidDetailAstImpl.addPreviousSibling(DetailAST ast) Add previous sibling.static DetailASTJavaParser.appendHiddenCommentNodes(DetailAST root) Appends comment nodes to existing AST.static DetailNodeDetailNodeTreeStringPrinter.parseJavadocAsDetailNode(DetailAST blockComment) Parse block comment DetailAST as Javadoc DetailNode tree.JavadocDetailNodeParser.parseJavadocAsDetailNode(DetailAST javadocCommentAst) Parses Javadoc comment as DetailNode tree.static StringAstTreeStringPrinter.printBranch(DetailAST node) Print branch info from root down to givennode.Constructors in com.puppycrawl.tools.checkstyle with parameters of type DetailASTModifierConstructorDescriptionTreeWalkerAuditEvent(FileContents fileContents, String fileName, LocalizedMessage localizedMessage, DetailAST rootAst) Creates a newTreeWalkerAuditEventinstance. -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.api
Methods in com.puppycrawl.tools.checkstyle.api that return DetailASTModifier and TypeMethodDescriptionDetailAST.findFirstToken(int type) Returns the first child token that makes a specified type.FullIdent.getDetailAst()Gets the topmost leftmost DetailAST for this FullIdent.DetailAST.getFirstChild()Get the first child of this AST.DetailAST.getLastChild()Gets the last child node.DetailAST.getNextSibling()Get the next sibling in line after this one.DetailAST.getParent()Returns the parent token.DetailAST.getPreviousSibling()Returns the previous sibling or null if no such sibling exists.Methods in com.puppycrawl.tools.checkstyle.api with parameters of type DetailASTModifier and TypeMethodDescriptionvoidCalled before the starting to process a tree.static FullIdentFullIdent.createFullIdent(DetailAST ast) Creates a new FullIdent starting from the specified node.static FullIdentFullIdent.createFullIdentBelow(DetailAST ast) Creates a new FullIdent starting from the child of the specified node.voidAbstractCheck.finishTree(DetailAST rootAST) Called after finished processing a tree.voidAbstractCheck.leaveToken(DetailAST ast) Called after all the child nodes have been process.final voidHelper method to log a LocalizedMessage.voidAbstractCheck.visitToken(DetailAST ast) Called to process a token. -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks
Methods in com.puppycrawl.tools.checkstyle.checks with parameters of type DetailASTModifier and TypeMethodDescriptionvoidvoidvoidvoidvoidvoidNoCodeInFileCheck.finishTree(DetailAST ast) voidOuterTypeFilenameCheck.finishTree(DetailAST rootAST) voidUncommentedMainCheck.leaveToken(DetailAST ast) voidArrayTypeStyleCheck.visitToken(DetailAST ast) voidAvoidEscapedUnicodeCharactersCheck.visitToken(DetailAST ast) voidDescendantTokenCheck.visitToken(DetailAST ast) voidFinalParametersCheck.visitToken(DetailAST ast) voidOuterTypeFilenameCheck.visitToken(DetailAST ast) voidSuppressWarningsHolder.visitToken(DetailAST ast) voidTodoCommentCheck.visitToken(DetailAST ast) voidTrailingCommentCheck.visitToken(DetailAST ast) voidUncommentedMainCheck.visitToken(DetailAST ast) voidUpperEllCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.annotation
Methods in com.puppycrawl.tools.checkstyle.checks.annotation with parameters of type DetailASTModifier and TypeMethodDescriptionvoidAnnotationLocationCheck.visitToken(DetailAST ast) voidAnnotationOnSameLineCheck.visitToken(DetailAST ast) voidAnnotationUseStyleCheck.visitToken(DetailAST ast) voidMissingOverrideCheck.visitToken(DetailAST ast) voidPackageAnnotationCheck.visitToken(DetailAST ast) voidSuppressWarningsCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.blocks
Methods in com.puppycrawl.tools.checkstyle.checks.blocks with parameters of type DetailASTModifier and TypeMethodDescriptionvoidAvoidNestedBlocksCheck.visitToken(DetailAST ast) voidEmptyBlockCheck.visitToken(DetailAST ast) voidEmptyCatchBlockCheck.visitToken(DetailAST ast) voidLeftCurlyCheck.visitToken(DetailAST ast) We cannot reduce the number of branches in this switch statement, since many tokens require specific methods to find the first left curly.voidNeedBracesCheck.visitToken(DetailAST ast) voidRightCurlyCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.coding
Methods in com.puppycrawl.tools.checkstyle.checks.coding with parameters of type DetailASTModifier and TypeMethodDescriptionvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidEqualsAvoidNullCheck.finishTree(DetailAST ast) voidEqualsHashCodeCheck.finishTree(DetailAST rootAST) voidIllegalInstantiationCheck.finishTree(DetailAST rootAST) voidMultipleStringLiteralsCheck.finishTree(DetailAST rootAST) voidPackageDeclarationCheck.finishTree(DetailAST ast) voidAbstractSuperCheck.leaveToken(DetailAST ast) voidDeclarationOrderCheck.leaveToken(DetailAST ast) voidEqualsAvoidNullCheck.leaveToken(DetailAST ast) voidFinalLocalVariableCheck.leaveToken(DetailAST ast) voidHiddenFieldCheck.leaveToken(DetailAST ast) voidModifiedControlVariableCheck.leaveToken(DetailAST ast) voidNestedForDepthCheck.leaveToken(DetailAST ast) voidNestedIfDepthCheck.leaveToken(DetailAST literalIf) voidNestedTryDepthCheck.leaveToken(DetailAST literalTry) voidOneStatementPerLineCheck.leaveToken(DetailAST ast) voidParameterAssignmentCheck.leaveToken(DetailAST ast) voidRequireThisCheck.leaveToken(DetailAST ast) voidReturnCountCheck.leaveToken(DetailAST ast) voidUnnecessaryParenthesesCheck.leaveToken(DetailAST ast) voidAbstractSuperCheck.visitToken(DetailAST ast) voidArrayTrailingCommaCheck.visitToken(DetailAST arrayInit) voidAvoidDoubleBraceInitializationCheck.visitToken(DetailAST ast) voidAvoidInlineConditionalsCheck.visitToken(DetailAST ast) voidAvoidNoArgumentSuperConstructorCallCheck.visitToken(DetailAST ast) voidCovariantEqualsCheck.visitToken(DetailAST ast) voidDeclarationOrderCheck.visitToken(DetailAST ast) voidDefaultComesLastCheck.visitToken(DetailAST ast) voidEmptyStatementCheck.visitToken(DetailAST ast) voidEqualsAvoidNullCheck.visitToken(DetailAST ast) voidEqualsHashCodeCheck.visitToken(DetailAST ast) voidExplicitInitializationCheck.visitToken(DetailAST ast) voidFallThroughCheck.visitToken(DetailAST ast) voidFinalLocalVariableCheck.visitToken(DetailAST ast) voidHiddenFieldCheck.visitToken(DetailAST ast) voidIllegalCatchCheck.visitToken(DetailAST detailAST) voidIllegalInstantiationCheck.visitToken(DetailAST ast) voidIllegalThrowsCheck.visitToken(DetailAST detailAST) voidIllegalTokenCheck.visitToken(DetailAST ast) voidIllegalTokenTextCheck.visitToken(DetailAST ast) voidIllegalTypeCheck.visitToken(DetailAST ast) voidInnerAssignmentCheck.visitToken(DetailAST ast) voidMagicNumberCheck.visitToken(DetailAST ast) voidMissingCtorCheck.visitToken(DetailAST ast) voidMissingSwitchDefaultCheck.visitToken(DetailAST ast) voidModifiedControlVariableCheck.visitToken(DetailAST ast) voidMultipleStringLiteralsCheck.visitToken(DetailAST ast) voidMultipleVariableDeclarationsCheck.visitToken(DetailAST ast) voidNestedForDepthCheck.visitToken(DetailAST ast) voidNestedIfDepthCheck.visitToken(DetailAST literalIf) voidNestedTryDepthCheck.visitToken(DetailAST literalTry) voidNoArrayTrailingCommaCheck.visitToken(DetailAST arrayInit) voidNoCloneCheck.visitToken(DetailAST ast) voidNoEnumTrailingCommaCheck.visitToken(DetailAST detailAST) voidNoFinalizerCheck.visitToken(DetailAST ast) voidOneStatementPerLineCheck.visitToken(DetailAST ast) voidOverloadMethodsDeclarationOrderCheck.visitToken(DetailAST ast) voidPackageDeclarationCheck.visitToken(DetailAST ast) voidParameterAssignmentCheck.visitToken(DetailAST ast) voidRequireThisCheck.visitToken(DetailAST ast) voidReturnCountCheck.visitToken(DetailAST ast) voidSimplifyBooleanExpressionCheck.visitToken(DetailAST ast) voidSimplifyBooleanReturnCheck.visitToken(DetailAST ast) voidStringLiteralEqualityCheck.visitToken(DetailAST ast) voidUnnecessaryParenthesesCheck.visitToken(DetailAST ast) voidUnnecessarySemicolonAfterOuterTypeDeclarationCheck.visitToken(DetailAST ast) voidUnnecessarySemicolonAfterTypeMemberDeclarationCheck.visitToken(DetailAST ast) voidUnnecessarySemicolonInEnumerationCheck.visitToken(DetailAST ast) voidUnnecessarySemicolonInTryWithResourcesCheck.visitToken(DetailAST ast) voidVariableDeclarationUsageDistanceCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.design
Methods in com.puppycrawl.tools.checkstyle.checks.design with parameters of type DetailASTModifier and TypeMethodDescriptionvoidvoidvoidvoidvoidFinalClassCheck.leaveToken(DetailAST ast) voidInnerTypeLastCheck.leaveToken(DetailAST ast) voidMutableExceptionCheck.leaveToken(DetailAST ast) voidDesignForExtensionCheck.visitToken(DetailAST ast) voidFinalClassCheck.visitToken(DetailAST ast) voidHideUtilityClassConstructorCheck.visitToken(DetailAST ast) voidInnerTypeLastCheck.visitToken(DetailAST ast) voidInterfaceIsTypeCheck.visitToken(DetailAST ast) voidMutableExceptionCheck.visitToken(DetailAST ast) voidThrowsCountCheck.visitToken(DetailAST ast) voidVisibilityModifierCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.imports
Methods in com.puppycrawl.tools.checkstyle.checks.imports with parameters of type DetailASTModifier and TypeMethodDescriptionvoidvoidvoidvoidvoidvoidCustomImportOrderCheck.finishTree(DetailAST rootAST) voidUnusedImportsCheck.finishTree(DetailAST rootAST) voidAvoidStarImportCheck.visitToken(DetailAST ast) voidAvoidStaticImportCheck.visitToken(DetailAST ast) voidCustomImportOrderCheck.visitToken(DetailAST ast) voidIllegalImportCheck.visitToken(DetailAST ast) voidImportControlCheck.visitToken(DetailAST ast) voidImportOrderCheck.visitToken(DetailAST ast) voidRedundantImportCheck.visitToken(DetailAST ast) voidUnusedImportsCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.indentation
Methods in com.puppycrawl.tools.checkstyle.checks.indentation that return DetailASTModifier and TypeMethodDescriptionDetailAstSet.firstLine()The first line in set of ast.DetailAstSet.getAst(int lineNum) Get the ast corresponding to line number.protected static DetailASTAbstractExpressionHandler.getFirstAst(DetailAST ast, DetailAST tree) Get the first ast for given expression.static DetailASTAbstractExpressionHandler.getFirstToken(DetailAST ast) Searches in given sub-tree (including given node) for the token which represents first symbol for this sub-tree in file.protected DetailASTArrayInitHandler.getLeftCurly()protected DetailASTBlockParentHandler.getLeftCurly()Get the left curly brace portion of the expression we are handling.protected DetailASTClassDefHandler.getLeftCurly()protected DetailASTObjectBlockHandler.getLeftCurly()protected DetailASTSlistHandler.getLeftCurly()protected DetailASTSwitchHandler.getLeftCurly()protected DetailASTArrayInitHandler.getListChild()protected DetailASTBlockParentHandler.getListChild()Get the child element representing the list of statements.protected DetailASTClassDefHandler.getListChild()protected DetailASTObjectBlockHandler.getListChild()protected DetailASTSlistHandler.getListChild()protected DetailASTSwitchHandler.getListChild()protected final DetailASTAbstractExpressionHandler.getMainAst()Accessor for the MainAst attribute.protected DetailASTBlockParentHandler.getNonListChild()Get the child element that is not a list of statements.protected DetailASTElseHandler.getNonListChild()protected DetailASTSwitchHandler.getNonListChild()protected DetailASTArrayInitHandler.getRightCurly()protected DetailASTBlockParentHandler.getRightCurly()Get the right curly brace portion of the expression we are handling.protected DetailASTClassDefHandler.getRightCurly()protected DetailASTObjectBlockHandler.getRightCurly()protected DetailASTSlistHandler.getRightCurly()protected DetailASTSwitchHandler.getRightCurly()protected DetailASTArrayInitHandler.getTopLevelAst()protected DetailASTBlockParentHandler.getTopLevelAst()Get the top level expression being managed by this handler.protected DetailASTClassDefHandler.getTopLevelAst()protected DetailASTMethodDefHandler.getTopLevelAst()protected DetailASTObjectBlockHandler.getTopLevelAst()protected DetailASTSlistHandler.getTopLevelAst()Methods in com.puppycrawl.tools.checkstyle.checks.indentation with parameters of type DetailASTModifier and TypeMethodDescriptionvoidAdd ast to the set of ast.voidprotected final voidAbstractExpressionHandler.checkChildren(DetailAST parentNode, int[] tokenTypes, IndentLevel startIndent, boolean firstLineMatches, boolean allowNesting) Check the indent level of the children of the specified parent expression.protected final voidAbstractExpressionHandler.checkExpressionSubtree(DetailAST tree, IndentLevel indentLevel, boolean firstLineMatches, boolean allowNesting) Check the indentation level for an expression subtree.voidLineWrappingHandler.checkIndentation(DetailAST firstNode, DetailAST lastNode) Checks line wrapping into expressions and definitions using property 'lineWrappingIndentation'.voidLineWrappingHandler.checkIndentation(DetailAST firstNode, DetailAST lastNode, int indentLevel, int startIndent, LineWrappingHandler.LineWrappingOptions ignoreFirstLine) Checks line wrapping into expressions and definitions.protected final voidAbstractExpressionHandler.checkLeftParen(DetailAST lparen) Check the indentation of the left parenthesis.protected final voidAbstractExpressionHandler.checkRightParen(DetailAST lparen, DetailAST rparen) Check the indentation of the right parenthesis.protected voidAbstractExpressionHandler.checkWrappingIndentation(DetailAST firstNode, DetailAST lastNode) Checks indentation on wrapped lines between and includingfirstNodeandlastNode.protected voidAbstractExpressionHandler.checkWrappingIndentation(DetailAST firstNode, DetailAST lastNode, int wrappedIndentLevel, int startIndent, boolean ignoreFirstLine) Checks indentation on wrapped lines between and includingfirstNodeandlastNode.protected final intAbstractExpressionHandler.expandedTabsColumnNo(DetailAST ast) Get the column number for the start of a given expression, expanding tabs out into spaces in the process.protected final intDetailAstSet.expandedTabsColumnNo(DetailAST ast) Get the column number for the start of a given expression, expanding tabs out into spaces in the process.protected final voidAbstractExpressionHandler.findSubtreeAst(DetailAstSet astSet, DetailAST tree, boolean allowNesting) Find the set of abstract syntax tree for a given subtree.protected static DetailASTAbstractExpressionHandler.getFirstAst(DetailAST ast, DetailAST tree) Get the first ast for given expression.protected static intAbstractExpressionHandler.getFirstLine(DetailAST tree) Get the first line number for given expression.static DetailASTAbstractExpressionHandler.getFirstToken(DetailAST ast) Searches in given sub-tree (including given node) for the token which represents first symbol for this sub-tree in file.HandlerFactory.getHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Get the handler for an AST.protected final intAbstractExpressionHandler.getLineStart(DetailAST ast) Get the start of the line for the given expression.voidIndentationCheck.indentationLog(DetailAST ast, String key, Object... args) Log a violation message.protected final booleanAbstractExpressionHandler.isOnStartOfLine(DetailAST ast) Determines if the given expression is at the start of a line.voidIndentationCheck.leaveToken(DetailAST ast) protected final voidLog an indentation error.protected final voidAbstractExpressionHandler.logError(DetailAST ast, String subtypeName, int actualIndent, IndentLevel expectedIndent) Log an indentation error.voidCommentsIndentationCheck.visitToken(DetailAST commentAst) voidIndentationCheck.visitToken(DetailAST ast) Constructors in com.puppycrawl.tools.checkstyle.checks.indentation with parameters of type DetailASTModifierConstructorDescriptionprotectedAbstractExpressionHandler(IndentationCheck indentCheck, String typeName, DetailAST expr, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, name, abstract syntax tree, and parent handler.ArrayInitHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.BlockParentHandler(IndentationCheck indentCheck, String name, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, name, abstract syntax tree, and parent handler.CaseHandler(IndentationCheck indentCheck, DetailAST expr, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.CatchHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.ClassDefHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.DoWhileHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.ElseHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.FinallyHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.ForHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.IfHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.ImportHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.IndexHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.LabelHandler(IndentationCheck indentCheck, DetailAST expr, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.LambdaHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.MemberDefHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.MethodCallHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.MethodDefHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.NewHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.ObjectBlockHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.PackageDefHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.SlistHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.StaticInitHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.SwitchHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.SwitchRuleHandler(IndentationCheck indentCheck, DetailAST expr, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.SynchronizedHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, name, abstract syntax tree, and parent handler.TryHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.WhileHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler.YieldHandler(IndentationCheck indentCheck, DetailAST ast, AbstractExpressionHandler parent) Construct an instance of this handler with the given indentation check, abstract syntax tree, and parent handler. -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.javadoc
Methods in com.puppycrawl.tools.checkstyle.checks.javadoc that return DetailASTModifier and TypeMethodDescriptionprotected DetailASTAbstractJavadocCheck.getBlockCommentAst()Getter for block comment in Java language syntax tree.Methods in com.puppycrawl.tools.checkstyle.checks.javadoc that return types with arguments of type DetailASTModifier and TypeMethodDescriptionJavadocMethodCheck.findTokensInAstByType(DetailAST root, int astType) Finds node of specified type among root children, siblings, siblings children on any deep level.Methods in com.puppycrawl.tools.checkstyle.checks.javadoc with parameters of type DetailASTModifier and TypeMethodDescriptionfinal voidvoidJavadocMethodCheck.findTokensInAstByType(DetailAST root, int astType) Finds node of specified type among root children, siblings, siblings children on any deep level.final voidAbstractJavadocCheck.finishTree(DetailAST rootAST) abstract booleanChecks if a particular Javadoc tag is valid within a Javadoc block of a given AST.final voidJavadocMethodCheck.leaveToken(DetailAST ast) final voidAbstractJavadocCheck.visitToken(DetailAST blockCommentNode) voidInvalidJavadocPositionCheck.visitToken(DetailAST ast) voidJavadocContentLocationCheck.visitToken(DetailAST ast) final voidJavadocMethodCheck.visitToken(DetailAST ast) voidJavadocStyleCheck.visitToken(DetailAST ast) voidJavadocTypeCheck.visitToken(DetailAST ast) voidJavadocVariableCheck.visitToken(DetailAST ast) final voidMissingJavadocMethodCheck.visitToken(DetailAST ast) voidMissingJavadocPackageCheck.visitToken(DetailAST ast) voidMissingJavadocTypeCheck.visitToken(DetailAST ast) voidWriteTagCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.metrics
Methods in com.puppycrawl.tools.checkstyle.checks.metrics with parameters of type DetailASTModifier and TypeMethodDescriptionfinal voidvoidvoidvoidJavaNCSSCheck.finishTree(DetailAST rootAST) voidAbstractClassCouplingCheck.leaveToken(DetailAST ast) voidBooleanExpressionComplexityCheck.leaveToken(DetailAST ast) voidCyclomaticComplexityCheck.leaveToken(DetailAST ast) voidJavaNCSSCheck.leaveToken(DetailAST ast) voidNPathComplexityCheck.leaveToken(DetailAST ast) voidAbstractClassCouplingCheck.visitToken(DetailAST ast) voidBooleanExpressionComplexityCheck.visitToken(DetailAST ast) voidCyclomaticComplexityCheck.visitToken(DetailAST ast) voidJavaNCSSCheck.visitToken(DetailAST ast) voidNPathComplexityCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.modifier
Methods in com.puppycrawl.tools.checkstyle.checks.modifier with parameters of type DetailASTModifier and TypeMethodDescriptionvoidClassMemberImpliedModifierCheck.visitToken(DetailAST ast) voidInterfaceMemberImpliedModifierCheck.visitToken(DetailAST ast) voidModifierOrderCheck.visitToken(DetailAST ast) voidRedundantModifierCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.naming
Methods in com.puppycrawl.tools.checkstyle.checks.naming with parameters of type DetailASTModifier and TypeMethodDescriptionprotected booleanAbstractAccessControlNameCheck.mustCheckName(DetailAST ast) protected abstract booleanAbstractNameCheck.mustCheckName(DetailAST ast) Decides whether the name of an AST should be checked against the format regexp.protected booleanCatchParameterNameCheck.mustCheckName(DetailAST ast) protected final booleanClassTypeParameterNameCheck.mustCheckName(DetailAST ast) protected final booleanConstantNameCheck.mustCheckName(DetailAST ast) protected booleanIllegalIdentifierNameCheck.mustCheckName(DetailAST ast) protected final booleanInterfaceTypeParameterNameCheck.mustCheckName(DetailAST ast) protected booleanLambdaParameterNameCheck.mustCheckName(DetailAST ast) protected final booleanLocalFinalVariableNameCheck.mustCheckName(DetailAST ast) protected final booleanLocalVariableNameCheck.mustCheckName(DetailAST ast) protected final booleanMemberNameCheck.mustCheckName(DetailAST ast) protected final booleanMethodTypeParameterNameCheck.mustCheckName(DetailAST ast) protected booleanParameterNameCheck.mustCheckName(DetailAST ast) protected final booleanPatternVariableNameCheck.mustCheckName(DetailAST ast) protected final booleanRecordTypeParameterNameCheck.mustCheckName(DetailAST ast) protected final booleanStaticVariableNameCheck.mustCheckName(DetailAST ast) protected booleanAbstractAccessControlNameCheck.shouldCheckInScope(DetailAST modifiers) Should we check member with given modifiers.voidAbbreviationAsWordInNameCheck.visitToken(DetailAST ast) voidAbstractClassNameCheck.visitToken(DetailAST ast) voidAbstractNameCheck.visitToken(DetailAST ast) voidLambdaParameterNameCheck.visitToken(DetailAST ast) voidMethodNameCheck.visitToken(DetailAST ast) voidPackageNameCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.regexp
Methods in com.puppycrawl.tools.checkstyle.checks.regexp with parameters of type DetailAST -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.sizes
Methods in com.puppycrawl.tools.checkstyle.checks.sizes with parameters of type DetailASTModifier and TypeMethodDescriptionvoidvoidvoidOuterTypeNumberCheck.finishTree(DetailAST ast) voidExecutableStatementCountCheck.leaveToken(DetailAST ast) voidMethodCountCheck.leaveToken(DetailAST ast) voidOuterTypeNumberCheck.leaveToken(DetailAST ast) voidAnonInnerLengthCheck.visitToken(DetailAST ast) voidExecutableStatementCountCheck.visitToken(DetailAST ast) voidMethodCountCheck.visitToken(DetailAST ast) voidMethodLengthCheck.visitToken(DetailAST ast) voidOuterTypeNumberCheck.visitToken(DetailAST ast) voidParameterNumberCheck.visitToken(DetailAST ast) voidRecordComponentNumberCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.checks.whitespace
Methods in com.puppycrawl.tools.checkstyle.checks.whitespace with parameters of type DetailASTModifier and TypeMethodDescriptionvoidvoidprotected voidAbstractParenPadCheck.processLeft(DetailAST ast) Process a token representing a left parentheses.protected voidAbstractParenPadCheck.processRight(DetailAST ast) Process a token representing a right parentheses.voidEmptyForInitializerPadCheck.visitToken(DetailAST ast) voidEmptyForIteratorPadCheck.visitToken(DetailAST ast) voidEmptyLineSeparatorCheck.visitToken(DetailAST ast) voidGenericWhitespaceCheck.visitToken(DetailAST ast) voidMethodParamPadCheck.visitToken(DetailAST ast) voidNoLineWrapCheck.visitToken(DetailAST ast) voidNoWhitespaceAfterCheck.visitToken(DetailAST ast) voidNoWhitespaceBeforeCheck.visitToken(DetailAST ast) voidOperatorWrapCheck.visitToken(DetailAST ast) voidParenPadCheck.visitToken(DetailAST ast) voidSeparatorWrapCheck.visitToken(DetailAST ast) voidTypecastParenPadCheck.visitToken(DetailAST ast) voidWhitespaceAfterCheck.visitToken(DetailAST ast) voidWhitespaceAroundCheck.visitToken(DetailAST ast) -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.gui
Methods in com.puppycrawl.tools.checkstyle.gui with parameters of type DetailASTModifier and TypeMethodDescriptionprotected final voidParseTreeTableModel.setParseTree(DetailAST parseTree) Sets parse tree.protected final voidParseTreeTablePresentation.setParseTree(DetailAST parseTree) Set parse tree.Constructors in com.puppycrawl.tools.checkstyle.gui with parameters of type DetailASTModifierConstructorDescriptionCodeSelectorPresentation(DetailAST ast, List<Integer> lines2position) Constructor.ParseTreeTableModel(DetailAST parseTree) Initialise pModel.ParseTreeTablePresentation(DetailAST parseTree) Constructor initialise root node. -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.utils
Methods in com.puppycrawl.tools.checkstyle.utils that return DetailASTModifier and TypeMethodDescriptionstatic DetailASTCommonUtil.createBlockCommentNode(antlr.Token token) Create block comment from token.static DetailASTCommonUtil.createBlockCommentNode(String content) Create block comment from string content.static DetailASTAnnotationUtil.getAnnotation(DetailAST ast, String annotation) Checks if the AST is annotated with the passed in annotation and returns the AST representing that annotation.static DetailASTAnnotationUtil.getAnnotationHolder(DetailAST ast) Gets the AST that holds a series of annotations for the potentially annotated AST.static DetailASTCheckUtil.getFirstNode(DetailAST node) Finds sub-node for given node minimal (line, column) pair.Methods in com.puppycrawl.tools.checkstyle.utils that return types with arguments of type DetailASTModifier and TypeMethodDescriptionTokenUtil.findFirstTokenByPredicate(DetailAST root, Predicate<DetailAST> predicate) CheckUtil.getTypeParameters(DetailAST node) Retrieves the type parameters to the node.Methods in com.puppycrawl.tools.checkstyle.utils with parameters of type DetailASTModifier and TypeMethodDescriptionstatic booleanTokenUtil.areOnSameLine(DetailAST ast1, DetailAST ast2) Determines if two ASTs are on the same line.static booleanAnnotationUtil.containsAnnotation(DetailAST ast) Checks if the AST is annotated with any annotation.static booleanAnnotationUtil.containsAnnotation(DetailAST ast, String annotation) Checks if the AST is annotated with the passed in annotation.static booleanAnnotationUtil.containsAnnotation(DetailAST ast, List<String> annotations) Checks if the given AST element is annotated with any of the specified annotations.static FullIdentCheckUtil.createFullType(DetailAST typeAST) CreatesFullIdentfor given type node.TokenUtil.findFirstTokenByPredicate(DetailAST root, Predicate<DetailAST> predicate) static voidTokenUtil.forEachChild(DetailAST root, int type, Consumer<DetailAST> action) Performs an action for each child ofDetailASTroot node which matches the given token type.static AccessModifierOptionCheckUtil.getAccessModifierFromModifiersToken(DetailAST modifiersToken) ReturnsAccessModifierOptionbased on the information about access modifier taken from the given token of typeTokenTypes.MODIFIERS.static DetailASTAnnotationUtil.getAnnotation(DetailAST ast, String annotation) Checks if the AST is annotated with the passed in annotation and returns the AST representing that annotation.static DetailASTAnnotationUtil.getAnnotationHolder(DetailAST ast) Gets the AST that holds a series of annotations for the potentially annotated AST.static StringJavadocUtil.getBlockCommentContent(DetailAST blockCommentBegin) Gets content of block comment.static DetailASTCheckUtil.getFirstNode(DetailAST node) Finds sub-node for given node minimal (line, column) pair.static StringJavadocUtil.getJavadocCommentContent(DetailAST javadocCommentBegin) Get content of Javadoc comment.static ScopeScopeUtil.getScopeFromMods(DetailAST aMods) Returns the Scope specified by the modifier set.static ScopeScopeUtil.getSurroundingScope(DetailAST node) Returns the scope of the surrounding "block".static StringXpathUtil.getTextAttributeValue(DetailAST ast) Returns content of the text attribute of the ast element.CheckUtil.getTypeParameterNames(DetailAST node) Retrieves the names of the type parameters to the node.CheckUtil.getTypeParameters(DetailAST node) Retrieves the type parameters to the node.static booleanCheckUtil.isBeforeInSource(DetailAST ast1, DetailAST ast2) Retrieves whether ast1 is located before ast2.static booleanScopeUtil.isClassFieldDef(DetailAST node) Determines whether a node is a class field definition.static booleanJavadocUtil.isCorrectJavadocPosition(DetailAST blockComment) Checks Javadoc comment it's in right place.static booleanReturns whether a token represents an ELSE as part of an ELSE / IF set.static booleanCheckUtil.isEqualsMethod(DetailAST ast) Tests whether a method definition AST defines an equals covariant.static booleanCheckUtil.isGetterMethod(DetailAST ast) Returns whether an AST represents a getter method.static booleanScopeUtil.isInAnnotationBlock(DetailAST node) Returns whether a node is directly contained within an annotation block.static booleanScopeUtil.isInClassBlock(DetailAST node) Returns whether a node is directly contained within a class block.static booleanScopeUtil.isInCodeBlock(DetailAST node) Returns whether the scope of a node is restricted to a code block.static booleanScopeUtil.isInEnumBlock(DetailAST node) Returns whether a node is directly contained within an enum block.static booleanScopeUtil.isInInterfaceBlock(DetailAST node) Returns whether a node is directly contained within an interface block.static booleanScopeUtil.isInInterfaceOrAnnotationBlock(DetailAST node) Returns whether a node is directly contained within an interface or annotation block.static booleanScopeUtil.isInRecordBlock(DetailAST node) Returns whether a node is directly contained within a record block.static booleanChecks whether ast node is in a specific scope.static booleanJavadocUtil.isJavadocComment(DetailAST blockCommentBegin) Checks block comment content starts with '*' javadoc comment identifier.static booleanScopeUtil.isLocalVariableDef(DetailAST node) Determines whether a node is a local variable definition.static booleanCheckUtil.isNonVoidMethod(DetailAST methodDefAst) Checks whether a method is a not void one.static booleanDetermines if the AST belongs to the given types.static booleanBlockCommentPosition.isOnAnnotationDef(DetailAST blockComment) Node is on annotation definition.static booleanBlockCommentPosition.isOnAnnotationField(DetailAST blockComment) Node is on annotation field declaration.static booleanNode is on class definition.static booleanBlockCommentPosition.isOnCompactConstructor(DetailAST blockComment) 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.static booleanBlockCommentPosition.isOnConstructor(DetailAST blockComment) Node is on constructor.static booleanNode is on enum definition.static booleanBlockCommentPosition.isOnEnumConstant(DetailAST blockComment) Node is on enum constant.static booleanNode is on field declaration.static booleanBlockCommentPosition.isOnInterface(DetailAST blockComment) Node is on interface definition.static booleanBlockCommentPosition.isOnMember(DetailAST blockComment) Node is on type member declaration.static booleanBlockCommentPosition.isOnMethod(DetailAST blockComment) Node is on method declaration.static booleanBlockCommentPosition.isOnPackage(DetailAST blockComment) Node is on package definition.static booleanBlockCommentPosition.isOnRecord(DetailAST blockComment) Node is on record definition.static booleanNode is on type definition.static booleanScopeUtil.isOuterMostType(DetailAST node) Returns whether a node is contained in the outer most type block.static booleanCheckUtil.isReceiverParameter(DetailAST parameterDefAst) Checks whether a parameter is a receiver.static booleanCheckUtil.isSetterMethod(DetailAST ast) Returns whether an AST represents a setter method.static booleanXpathUtil.supportsTextAttribute(DetailAST ast) Checks, if specified node can have@textattribute.Method parameters in com.puppycrawl.tools.checkstyle.utils with type arguments of type DetailASTModifier and TypeMethodDescriptionTokenUtil.findFirstTokenByPredicate(DetailAST root, Predicate<DetailAST> predicate) static voidTokenUtil.forEachChild(DetailAST root, int type, Consumer<DetailAST> action) Performs an action for each child ofDetailASTroot node which matches the given token type. -
Uses of DetailAST in com.puppycrawl.tools.checkstyle.xpath
Methods in com.puppycrawl.tools.checkstyle.xpath that return DetailASTModifier and TypeMethodDescriptionabstract DetailASTAbstractNode.getUnderlyingNode()Returns underlying node.AttributeNode.getUnderlyingNode()Returns underlying node.ElementNode.getUnderlyingNode()Returns underlying node.RootNode.getUnderlyingNode()Returns underlying node.Methods in com.puppycrawl.tools.checkstyle.xpath with parameters of type DetailASTModifier and TypeMethodDescriptionstatic StringXpathQueryGenerator.generateXpathQuery(DetailAST ast) Returns full xpath query for given ast element.Constructors in com.puppycrawl.tools.checkstyle.xpath with parameters of type DetailASTModifierConstructorDescriptionElementNode(AbstractNode root, AbstractNode parent, DetailAST detailAst) Creates a newElementNodeinstance.Creates a newRootNodeinstance.XpathQueryGenerator(DetailAST rootAst, int lineNumber, int columnNumber, int tokenType, FileText fileText, int tabWidth) Creates a newXpathQueryGeneratorinstance.XpathQueryGenerator(DetailAST rootAst, int lineNumber, int columnNumber, FileText fileText, int tabWidth) Creates a newXpathQueryGeneratorinstance.