NodeUtil (Closure Compiler v20160208 API)

java.lang.Object
- com.google.javascript.jscomp.NodeUtil

```
public final class NodeUtil
extends Object
```
NodeUtil contains generally useful AST utilities.

Author:

[email protected] (Nick Santos), [email protected] (John Lenz)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NodeUtil.Visitor
Interface for use with the visit method.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`NodeUtil.Visitor` Interface for use with the visit method.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Node`	`getAssignedValue(Node n)` For an assignment or variable declaration get the assigned value.
`static JSDocInfo`	`getBestJSDocInfo(Node n)` Find the best JSDoc for the given node.
`static Node`	`getEnclosingBlock(Node n)` Finds the block containing the given node.
`static Node`	`getEnclosingFunction(Node n)` Finds the function containing the given node.
`static Node`	`getEnclosingNode(Node n, com.google.common.base.Predicate<Node> pred)`
`static Node`	`getEnclosingScript(Node n)` Finds the script containing the given node.
`static Node`	`getEnclosingStatement(Node n)`
`static Node`	`getFunctionParameters(Node fnNode)`
`static InputId`	`getInputId(Node n)`
`static String`	`getName(Node n)`
`static String`	`getNearestFunctionName(Node n)` Gets the function's name.
`static StaticSourceFile`	`getSourceFile(Node n)`
`static String`	`getSourceName(Node n)`
`static boolean`	`isAssignmentOp(Node n)`
`static boolean`	`isClassDeclaration(Node n)` see `isClassDeclaration(com.google.javascript.rhino.Node)`
`static boolean`	`isForIn(Node n)`
`static boolean`	`isFunctionDeclaration(Node n)` Is this node a function declaration? A function declaration is a function that has a name that is added to the current scope (i.e.
`static boolean`	`isHoistedFunctionDeclaration(Node n)` Is this node a hoisted function declaration? A function declaration in the scope root is hoisted to the top of the scope.
`static boolean`	`isInFunction(Node n)`
`static boolean`	`isLhsByDestructuring(Node n)`
`static boolean`	`isLValue(Node n)` Determines whether this node is used as an L-value.
`static boolean`	`isNameDeclaration(Node n)` Is this node a name declaration?
`static boolean`	`isPrototypePropertyDeclaration(Node n)`
`static boolean`	`isStatement(Node n)`
`static boolean`	`isValidQualifiedName(CompilerOptions.LanguageMode mode, String name)` Determines whether the given name is a valid qualified name.
`static boolean`	`isValidQualifiedName(String name)` Deprecated.
`static Map<Node,Node>`	`mapMainToClone(Node main, Node clone)` Given an AST and its copy, map the root node of each scope of main to the corresponding root node of clone
`static boolean`	`mayHaveSideEffects(Node n)` Returns true if the node which may have side effects when executed.
`static boolean`	`mayHaveSideEffects(Node n, AbstractCompiler compiler)`
`static Node`	`newPropertyAccess(AbstractCompiler compiler, Node context, String name)` Creates a property access on the `context` tree.
`static Node`	`newQName(AbstractCompiler compiler, String name)` Creates a node representing a qualified name.
`static Node`	`newQNameDeclaration(AbstractCompiler compiler, String name, Node value, JSDocInfo info)` Creates a node representing a qualified name.
`static String`	`opToStr(int operator)` Converts an operator's token value (see `Token`) to a string representation.
`static void`	`verifyScopeChanges(Map<Node,Node> map, Node main, boolean verifyUnchangedNodes, AbstractCompiler compiler)` Checks that the scope roots marked as changed have indeed changed
`static void`	`visitPreOrder(Node node, NodeUtil.Visitor visitor, com.google.common.base.Predicate<Node> traverseChildrenPred)` A pre-order traversal, calling Visitor.visit for each child matching the predicate.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public static String getName(Node n)
```
    Parameters:
    
    n - A function or class node.
    
    Returns:
    
    The name of the given function or class, if it has one.
  - getNearestFunctionName
```
public static String getNearestFunctionName(Node n)
```
    Gets the function's name. This method recognizes the forms:
    - {'name': function() ...}
    - {name: function() ...}
    - function name() ...
    - var name = function() ...
    - var obj = {name() {} ...}
    - qualified.name = function() ...
    - var name2 = function name1() ...
    - qualified.name2 = function name1() ...
    Parameters:
    
    n - a node whose type is Token.FUNCTION
    
    Returns:
    
    the function's name, or null if it has no name
  - mayHaveSideEffects
```
public static boolean mayHaveSideEffects(Node n)
```
    Returns true if the node which may have side effects when executed. This version default to the "safe" assumptions when the compiler object is not provided (RegExp have side-effects, etc).
  - mayHaveSideEffects
```
public static boolean mayHaveSideEffects(Node n,
                                         AbstractCompiler compiler)
```
  - isAssignmentOp
```
public static boolean isAssignmentOp(Node n)
```
  - getEnclosingFunction
```
public static Node getEnclosingFunction(Node n)
```
    Finds the function containing the given node.
  - getEnclosingScript
```
public static Node getEnclosingScript(Node n)
```
    Finds the script containing the given node.
  - getEnclosingBlock
```
public static Node getEnclosingBlock(Node n)
```
    Finds the block containing the given node.
  - isInFunction
```
public static boolean isInFunction(Node n)
```
  - getEnclosingStatement
```
public static Node getEnclosingStatement(Node n)
```
  - getEnclosingNode
```
public static Node getEnclosingNode(Node n,
                                    com.google.common.base.Predicate<Node> pred)
```
  - isNameDeclaration
```
public static boolean isNameDeclaration(Node n)
```
    Is this node a name declaration?
    
    Parameters:
    
    n - The node
    
    Returns:
    
    True if n is VAR, LET or CONST
  - getAssignedValue
```
public static Node getAssignedValue(Node n)
```
    For an assignment or variable declaration get the assigned value.
    
    Returns:
    
    The value node representing the new value.
  - isForIn
```
public static boolean isForIn(Node n)
```
    Returns:
    
    Whether the node represents a FOR-IN loop.
  - isStatement
```
public static boolean isStatement(Node n)
```
    Returns:
    
    Whether the node is used as a statement.
  - isFunctionDeclaration
```
public static boolean isFunctionDeclaration(Node n)
```
    Is this node a function declaration? A function declaration is a function that has a name that is added to the current scope (i.e. a function that is not part of a expression; see isFunctionExpression(com.google.javascript.rhino.Node)).
  - isClassDeclaration
```
public static boolean isClassDeclaration(Node n)
```
    see isClassDeclaration(com.google.javascript.rhino.Node)
  - isHoistedFunctionDeclaration
```
public static boolean isHoistedFunctionDeclaration(Node n)
```
    Is this node a hoisted function declaration? A function declaration in the scope root is hoisted to the top of the scope. See isFunctionDeclaration(com.google.javascript.rhino.Node)).
  - isLValue
```
public static boolean isLValue(Node n)
```
    Determines whether this node is used as an L-value. Notice that sometimes names are used as both L-values and R-values.
    We treat "var x;" and "let x;" as an L-value because it's syntactically similar to "var x = undefined", even though it's technically not an L-value. But it kind of makes sense if you treat it as "assignment to 'undefined' at the top of the scope".
    
    Parameters:
    
    n - The node
    
    Returns:
    
    True if n is an L-value.
  - isLhsByDestructuring
```
public static boolean isLhsByDestructuring(Node n)
```
  - opToStr
```
public static String opToStr(int operator)
```
    Converts an operator's token value (see Token) to a string representation.
    
    Parameters:
    
    operator - the operator's token value to convert
    
    Returns:
    
    the string representation or null if the token value is not an operator
  - newQName
```
public static Node newQName(AbstractCompiler compiler,
                            String name)
```
    Creates a node representing a qualified name.
    
    Parameters:
    
    name - A qualified name (e.g. "foo" or "foo.bar.baz")
    
    Returns:
    
    A NAME or GETPROP node
  - newPropertyAccess
```
public static Node newPropertyAccess(AbstractCompiler compiler,
                                     Node context,
                                     String name)
```
    Creates a property access on the context tree.
  - newQNameDeclaration
```
public static Node newQNameDeclaration(AbstractCompiler compiler,
                                       String name,
                                       Node value,
                                       JSDocInfo info)
```
    Creates a node representing a qualified name.
    
    Parameters:
    
    name - A qualified name (e.g. "foo" or "foo.bar.baz")
    
    Returns:
    
    A VAR node, or an EXPR_RESULT node containing an ASSIGN or NAME node.
  - isValidQualifiedName
```
@Deprecated
public static boolean isValidQualifiedName(String name)
```
    Deprecated.
  - isValidQualifiedName
```
public static boolean isValidQualifiedName(CompilerOptions.LanguageMode mode,
                                           String name)
```
    Determines whether the given name is a valid qualified name.
  - isPrototypePropertyDeclaration
```
public static boolean isPrototypePropertyDeclaration(Node n)
```
    Returns:
    
    true if the node an assignment to a prototype property of some constructor.
  - visitPreOrder
```
public static void visitPreOrder(Node node,
                                 NodeUtil.Visitor visitor,
                                 com.google.common.base.Predicate<Node> traverseChildrenPred)
```
    A pre-order traversal, calling Visitor.visit for each child matching the predicate.
  - getFunctionParameters
```
public static Node getFunctionParameters(Node fnNode)
```
    Parameters:
    
    fnNode - The function.
    
    Returns:
    
    The Node containing the Function parameters.
  - getSourceName
```
public static String getSourceName(Node n)
```
    Parameters:
    
    n - The node.
    
    Returns:
    
    The source name property on the node or its ancestors.
  - getSourceFile
```
public static StaticSourceFile getSourceFile(Node n)
```
    Parameters:
    
    n - The node.
    
    Returns:
    
    The source name property on the node or its ancestors.
  - getInputId
```
public static InputId getInputId(Node n)
```
    Parameters:
    
    n - The node.
    
    Returns:
    
    The InputId property on the node or its ancestors.
  - getBestJSDocInfo
```
@Nullable
public static JSDocInfo getBestJSDocInfo(Node n)
```
    Find the best JSDoc for the given node.
  - mapMainToClone
```
public static Map<Node,Node> mapMainToClone(Node main,
                                            Node clone)
```
    Given an AST and its copy, map the root node of each scope of main to the corresponding root node of clone
  - verifyScopeChanges
```
public static void verifyScopeChanges(Map<Node,Node> map,
                                      Node main,
                                      boolean verifyUnchangedNodes,
                                      AbstractCompiler compiler)
```
    Checks that the scope roots marked as changed have indeed changed

Class NodeUtil

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getNearestFunctionName

mayHaveSideEffects

mayHaveSideEffects

isAssignmentOp

getEnclosingFunction

getEnclosingScript

getEnclosingBlock

isInFunction

getEnclosingStatement

getEnclosingNode

isNameDeclaration

getAssignedValue

isForIn

isStatement

isFunctionDeclaration

isClassDeclaration

isHoistedFunctionDeclaration

isLValue

isLhsByDestructuring

opToStr

newQName

newPropertyAccess

newQNameDeclaration

isValidQualifiedName

isValidQualifiedName

isPrototypePropertyDeclaration

visitPreOrder

getFunctionParameters

getSourceName

getSourceFile

getInputId

getBestJSDocInfo

mapMainToClone

verifyScopeChanges