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

Class ASTName

java.lang.Object
net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?>,EcmascriptNode<?>>
net.sourceforge.pmd.lang.ecmascript.ast.ASTName
All Implemented Interfaces:
net.sourceforge.pmd.lang.ast.impl.GenericNode<EcmascriptNode<?>>, net.sourceforge.pmd.lang.ast.Node, EcmascriptNode<org.mozilla.javascript.ast.Name>, net.sourceforge.pmd.reporting.Reportable
public final class ASTName extends net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?>,EcmascriptNode<?>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.mozilla.javascript.ast.Name
    node
     

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

    COORDS_COMPARATOR

  • Method Summary

    Modifier and Type
    Method
    Description
    protected <P, R> R
    acceptJsVisitor(EcmascriptVisitor<? super P,? extends R> visitor, P data)
     
    final <P, R> R
    acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor, P data)
     
    protected void
    addChild(net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?> child, int index)
     
    String
    getIdentifier()
     
    String
    getJsDoc()
    Get the JsDoc associated with the given node.
    net.sourceforge.pmd.lang.document.TextRegion
    getTextRegion()
     
    String
    getXPathNodeName()
     
    boolean
    hasSideEffects()
     
    boolean
    isFunctionCallName()
    Returns whether this name node is the name of a function call.
    boolean
    isFunctionNodeName()
    Returns whether this name node is the name of a function declaration.
    boolean
    isFunctionNodeParameter()
    Returns whether this name node is the name of a function declaration parameter.
    boolean
    isGlobalName()
     
    boolean
    isLocalName()
     
    boolean
    isVariableDeclaration()
    Returns whether this name node is the name of a variable declaration.
    protected void
    setTrailingCommaExists(boolean b)
     

    Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode

    children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, insertChild, remove, removeChildAtIndex, setChild, setParent, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    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

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

  • Field Details

    • node

      protected final org.mozilla.javascript.ast.Name node

  • Method Details

    • acceptJsVisitor

      protected <P, R> R acceptJsVisitor(EcmascriptVisitor<? super P,? extends R> visitor, P data)

    • getIdentifier

      public String getIdentifier()

    • isLocalName

      public boolean isLocalName()

    • isGlobalName

      public boolean isGlobalName()

    • isFunctionNodeName

      public boolean isFunctionNodeName()
      Returns whether this name node is the name of a function declaration.
      Returns:
      true if name of a function declaration, false otherwise.

    • isFunctionNodeParameter

      public boolean isFunctionNodeParameter()
      Returns whether this name node is the name of a function declaration parameter.
      Returns:
      true if name of a function declaration parameter, false otherwise.

    • isFunctionCallName

      public boolean isFunctionCallName()
      Returns whether this name node is the name of a function call.
      Returns:
      true if name of a function call, false otherwise.

    • isVariableDeclaration

      public boolean isVariableDeclaration()
      Returns whether this name node is the name of a variable declaration.
      Returns:
      true if name of a variable declaration, false otherwise.

    • addChild

      protected void addChild(net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?> child, int index)
      Overrides:
      addChild in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?>,EcmascriptNode<?>>

    • getTextRegion

      public net.sourceforge.pmd.lang.document.TextRegion getTextRegion()
      Specified by:
      getTextRegion in interface net.sourceforge.pmd.lang.ast.Node

    • acceptVisitor

      public final <P, R> R acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor, P data)
      Specified by:
      acceptVisitor in interface net.sourceforge.pmd.lang.ast.Node

    • getJsDoc

      public String getJsDoc()
      Description copied from interface: EcmascriptNode
      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.
      Specified by:
      getJsDoc in interface EcmascriptNode<T extends org.mozilla.javascript.ast.AstNode>
      Returns:
      The JsDoc comment for the node, may be null.

    • hasSideEffects

      public boolean hasSideEffects()
      Specified by:
      hasSideEffects in interface EcmascriptNode<T extends org.mozilla.javascript.ast.AstNode>

    • getXPathNodeName

      public String getXPathNodeName()
      Specified by:
      getXPathNodeName in interface net.sourceforge.pmd.lang.ast.Node

    • setTrailingCommaExists

      protected void setTrailingCommaExists(boolean b)