Package net.sourceforge.pmd.lang.ecmascript.ast

Interface EcmascriptNode<T extends org.mozilla.javascript.ast.AstNode>

All Superinterfaces:

net.sourceforge.pmd.lang.ast.impl.GenericNode<EcmascriptNode<?>>, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.reporting.Reportable

All Known Implementing Classes:

ASTArrayComprehension, ASTArrayComprehensionLoop, ASTArrayLiteral, ASTAssignment, ASTAstRoot, ASTBigIntLiteral, ASTBlock, ASTBreakStatement, ASTCatchClause, ASTComment, ASTConditionalExpression, ASTContinueStatement, ASTDoLoop, ASTElementGet, ASTEmptyExpression, ASTEmptyStatement, ASTErrorNode, ASTExpressionStatement, ASTForInLoop, ASTForLoop, ASTFunctionCall, ASTFunctionNode, ASTGeneratorExpression, ASTGeneratorExpressionLoop, ASTIfStatement, ASTInfixExpression, ASTKeywordLiteral, ASTLabel, ASTLabeledStatement, ASTLetNode, ASTName, ASTNewExpression, ASTNumberLiteral, ASTObjectLiteral, ASTObjectProperty, ASTParenthesizedExpression, ASTPropertyGet, ASTRegExpLiteral, ASTReturnStatement, ASTScope, ASTScriptNode, ASTStringLiteral, ASTSwitchCase, ASTSwitchStatement, ASTTaggedTemplateLiteral, ASTTemplateCharacters, ASTTemplateLiteral, ASTThrowStatement, ASTTryStatement, ASTUnaryExpression, ASTUpdateExpression, ASTVariableDeclaration, ASTVariableInitializer, ASTWhileLoop, ASTWithStatement, ASTXmlDotQuery, ASTXmlElemRef, ASTXmlExpression, ASTXmlLiteral, ASTXmlMemberGet, ASTXmlPropRef, ASTXmlString, ASTYield

public interface EcmascriptNode<T extends org.mozilla.javascript.ast.AstNode>
extends net.sourceforge.pmd.lang.ast.impl.GenericNode<EcmascriptNode<?>>

Field Summary

Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

COORDS_COMPARATOR

Method Summary

Modifier and Type	Method	Description
String	getJsDoc()	Get the JsDoc associated with the given node.
boolean	hasSideEffects()

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

acceptVisitor, ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, getRoot, getTextDocument, getTextRegion, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasImageEqualTo, isFindBoundary

Method Detail

getJsDoc

String getJsDoc()

Get the JsDoc associated with the given node. If there is no JsDoc on this node, it may be associated with a parent node, on more representative of the entire expression containing this node.

Returns:

The JsDoc comment for the node, may be null.

hasSideEffects

boolean hasSideEffects()