NodeUtil (Closure Compiler v20180610 API)

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

```
public final class NodeUtil
extends java.lang.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 class NodeUtil.ValueType

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

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

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String EXTERN_OBJECT_PROPERTY_STRING

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXTERN_OBJECT_PROPERTY_STRING`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`canMergeBlock(Node block)` A check inside a block to see if there are const, let, class, or function declarations to be safe and not hoist them into the upper block.
`static boolean`	`containsType(Node node, Token type)`
`static void`	`deleteChildren(Node n, AbstractCompiler compiler)` Permanently delete all the children of the given node, including reporting changes.
`static void`	`deleteFunctionCall(Node n, AbstractCompiler compiler)` Permanently delete the given call from the AST while maintaining a valid node structure, as well as report the related AST changes to the given compiler.
`static void`	`deleteNode(Node n, AbstractCompiler compiler)` Permanently delete the given node from the AST, as well as report the related AST changes/deletions to the given compiler.
`static Node`	`emptyFunction()`
`static java.util.List<Node>`	`findLhsNodesInNode(Node declNode)` Retrieves lhs nodes declared in the current declaration or ASSIGN statement.
`static int`	`getApproxRequiredArity(Node fun)` Counts the parameters of a function that are not marked optional or varargs.
`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`	`getBestJSDocInfoNode(Node n)`
`static Node`	`getBestLValue(Node n)` Find the l-value that the given r-value is being assigned to.
`static Node`	`getClassMembers(Node n)`
`static int`	`getCount(Node n, com.google.common.base.Predicate<Node> pred, com.google.common.base.Predicate<Node> traverseChildrenPred)`
`static JSTypeExpression`	`getDeclaredTypeExpression(Node declaration)` Return declared JSDoc type for the given name declaration, or null if none present.
`static Node`	`getDeclaringParent(Node targetNode)` Returns the node that is effectively declaring the given target.
`static Node`	`getEnclosingBlock(Node n)` Finds the block containing the given node.
`static Node`	`getEnclosingBlockScopeRoot(Node n)`
`static Node`	`getEnclosingClass(Node n)` Finds the class 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`	`getEnclosingScopeRoot(Node n)`
`static Node`	`getEnclosingScript(Node n)` Finds the script containing the given node.
`static Node`	`getEnclosingStatement(Node n)`
`static Node`	`getEnclosingType(Node n, Token type)` Gets the closest ancestor to the given node of the provided type.
`static Node`	`getFunctionBody(Node fn)` Return a BLOCK node for the given FUNCTION node.
`static Node`	`getFunctionParameters(Node fnNode)`
`static InputId`	`getInputId(Node n)`
`static NodeUtil.ValueType`	`getKnownValueType(Node n)` Apply the supplied predicate against all possible result Nodes of the expression.
`static java.lang.String`	`getName(Node n)`
`static Node`	`getNameNode(Node n)` Gets the node of a function or class's name.
`static java.lang.String`	`getNearestFunctionName(Node n)` Gets the function's name.
`static Node`	`getNodeByLineCol(Node ancestor, int lineNo, int columNo)`
`static java.util.List<Node>`	`getParentChangeScopeNodes(java.util.List<Node> scopeNodes)` Returns the list of scope nodes which are parents of the provided list of scope nodes.
`static Node`	`getRootTarget(Node targetNode)` Returns the outermost target enclosing the given assignment target.
`static Node`	`getRValueOfLValue(Node n)` Gets the r-value (or initializer) of a node returned by getBestLValue.
`static StaticSourceFile`	`getSourceFile(Node n)`
`static java.lang.String`	`getSourceName(Node n)`
`static java.lang.String`	`getStringValue(Node n)` Gets the value of a node as a String, or null if it cannot be converted.
`static boolean`	`has(Node node, com.google.common.base.Predicate<Node> pred, com.google.common.base.Predicate<Node> traverseChildrenPred)`
`static boolean`	`isAnyFor(Node n)`
`static boolean`	`isAssignmentOp(Node n)`
`static boolean`	`isBlocklessArrowFunctionResult(Node n)`
`static boolean`	`isBooleanResult(Node n)`
`static boolean`	`isCallOrNew(Node node)`
`static boolean`	`isCallTo(Node n, java.lang.String qualifiedName)`
`static boolean`	`isClassDeclaration(Node n)` see `isClassDeclaration(com.google.javascript.rhino.Node)`
`static boolean`	`isCompoundAssignmentOp(Node n)`
`static boolean`	`isControlStructure(Node n)` Determines whether the given node is a FOR, DO, WHILE, WITH, or IF node.
`static boolean`	`isDeclarationLValue(Node n)` Determines whether this node is used as an L-value that is a declaration.
`static boolean`	`isEnhancedFor(Node n)`
`static boolean`	`isExprCall(Node n)` Is this node a call expression statement?
`static boolean`	`isFromTypeSummary(Node n)` Determine if the given SCRIPT is a @typeSummary file, like an i.js file
`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`	`isGet(Node n)` Is this a GETPROP or GETELEM node?
`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`	`isImportedName(Node n)`
`static boolean`	`isInFunction(Node n)`
`static boolean`	`isLhsByDestructuring(Node n)` Returns true if the node is a lhs value of a destructuring assignment For example, x in `var [x] = [1];`, `var [...x] = [1];`, and `var {a: x} = {a: 1}` or a.b in `([a.b] = [1]);` or `({key: a.b} = {key: 1});`
`static boolean`	`isLiteralValue(Node n, boolean includeFunctions)` Returns true if this is a literal value.
`static boolean`	`isLValue(Node n)` Determines whether this node is used as an L-value.
`static boolean`	`isMethodDeclaration(Node n)` Is this node a class or object literal member function?
`static boolean`	`isNameDeclaration(Node n)` Is this node a name declaration?
`static boolean`	`isNamespaceDecl(Node n)` Returns true iff this node defines a namespace, e.g., /** @const * / var goog = {}; /** @const * / var goog = goog \|\| {}; /** @const * / goog.math = goog.math \|\| {};
`static boolean`	`isNullOrUndefined(Node n)`
`static boolean`	`isNumericResult(Node n)` Returns true if the result of node evaluation is always a number
`static boolean`	`isObjectResult(Node n)`
`static boolean`	`isObjLitProperty(Node node)` Returns true if the node is a property of an object literal.
`static boolean`	`isPrototypePropertyDeclaration(Node n)`
`static boolean`	`isStatement(Node n)`
`static boolean`	`isStatementBlock(Node n)`
`static boolean`	`isStatementParent(Node parent)`
`static boolean`	`isStringResult(Node n)`
`static boolean`	`isTopLevel(Node n)`
`static boolean`	`isUndefined(Node n)`
`static boolean`	`isValidQualifiedName(CompilerOptions.LanguageMode mode, java.lang.String name)` Deprecated.
`static boolean`	`isValidQualifiedName(FeatureSet mode, java.lang.String name)` Determines whether the given name is a valid qualified name.
`static void`	`markFunctionsDeleted(Node node, AbstractCompiler compiler)` Recurses through a tree, marking all function nodes deleted.
`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`	`newDeclaration(Node lhs, Node rhs, Token declarationType)`
`static Node`	`newPropertyAccess(AbstractCompiler compiler, Node context, java.lang.String name)` Creates a property access on the `context` tree.
`static Node`	`newQName(AbstractCompiler compiler, java.lang.String name)` Creates a node representing a qualified name.
`static Node`	`newQNameDeclaration(AbstractCompiler compiler, java.lang.String name, Node value, JSDocInfo info)` Creates a node representing a qualified name.
`static Node`	`newQNameDeclaration(AbstractCompiler compiler, java.lang.String name, Node value, JSDocInfo info, Token type)` Creates a node representing a qualified name.
`static java.lang.String`	`opToStr(Token operator)` Converts an operator's token value (see `Token`) to a string representation.
`static int`	`precedence(Token type)` The comma operator has the lowest precedence, 0, followed by the assignment operators (`=`, `&=`, `+=`, etc.) which have precedence of 1, and so on.
`static void`	`removeChild(Node parent, Node node)` Safely remove children while maintaining a valid node structure.
`static void`	`removeName(Node n)` Set the given function/class node to an empty name
`static java.util.List<Node>`	`removeNestedChangeScopeNodes(java.util.List<Node> scopeNodes)` Removes any scope nodes from the provided list that are nested within some other scope node also in the list.
`static void`	`replaceDeclarationChild(Node declChild, Node newStatement)` Replace the child of a var/let/const declaration (usually a name) with a new statement.
`static boolean`	`tryMergeBlock(Node block, boolean alwaysMerge)` Merge a block with its parent block.
`static void`	`visitPostOrder(Node node, NodeUtil.Visitor visitor)` A post-order traversal, calling Visitor.visit for each decendent.
`static void`	`visitPostOrder(Node node, NodeUtil.Visitor visitor, com.google.common.base.Predicate<Node> traverseChildrenPred)` A post-order traversal, calling Visitor.visit for each descendant matching the predicate.
`static void`	`visitPreOrder(Node node, NodeUtil.Visitor visitor)` A pre-order traversal, calling Visitor.visit for each decendent.
`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

- Field Detail
  - EXTERN_OBJECT_PROPERTY_STRING
```
public static final java.lang.String EXTERN_OBJECT_PROPERTY_STRING
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getStringValue
```
public static java.lang.String getStringValue(Node n)
```
    Gets the value of a node as a String, or null if it cannot be converted. When it returns a non-null String, this method effectively emulates the String() JavaScript cast function.
  - getName
```
public static java.lang.String getName(Node n)
```
    Parameters:
    
    n - A function or class node.
    
    Returns:
    
    The name of the given function or class, if it has one.
  - getNameNode
```
public static Node getNameNode(Node n)
```
    Gets the node of a function or class's name. This method recognizes five forms:
    - class name {...}
    - var name = class {...}
    - qualified.name = class {...}
    - var name2 = class name1 {...}
    - qualified.name2 = class name1 {...}
    In two last cases with named function expressions, the second name is returned (the variable or qualified name).
    Parameters:
    
    n - A function or class node
    
    Returns:
    
    the node best representing the class's name
  - removeName
```
public static void removeName(Node n)
```
    Set the given function/class node to an empty name
  - getNearestFunctionName
```
public static java.lang.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
  - getClassMembers
```
public static Node getClassMembers(Node n)
```
  - isLiteralValue
```
public static boolean isLiteralValue(Node n,
                                     boolean includeFunctions)
```
    Returns true if this is a literal value. We define a literal value as any node that evaluates to the same thing regardless of when or where it is evaluated. So /xyz/ and [3, 5] are literals, but the name a is not.
    Function literals do not meet this definition, because they lexically capture variables. For example, if you have function() { return a; } If it is evaluated in a different scope, then it captures a different variable. Even if the function did not read any captured variables directly, it would still fail this definition, because it affects the lifecycle of variables in the enclosing scope.
    However, a function literal with respect to a particular scope is a literal.
    
    Parameters:
    
    includeFunctions - If true, all function expressions will be treated as literals.
  - isNamespaceDecl
```
public static boolean isNamespaceDecl(Node n)
```
    Returns true iff this node defines a namespace, e.g., /** @const * / var goog = {}; /** @const * / var goog = goog || {}; /** @const * / goog.math = goog.math || {};
  - isFromTypeSummary
```
public static boolean isFromTypeSummary(Node n)
```
    Determine if the given SCRIPT is a @typeSummary file, like an i.js file
  - 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)
```
  - precedence
```
public static int precedence(Token type)
```
    The comma operator has the lowest precedence, 0, followed by the assignment operators (=, &=, +=, etc.) which have precedence of 1, and so on. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence
  - isUndefined
```
public static boolean isUndefined(Node n)
```
  - isNullOrUndefined
```
public static boolean isNullOrUndefined(Node n)
```
  - getKnownValueType
```
public static NodeUtil.ValueType getKnownValueType(Node n)
```
    Apply the supplied predicate against all possible result Nodes of the expression.
  - isNumericResult
```
public static boolean isNumericResult(Node n)
```
    Returns true if the result of node evaluation is always a number
  - isBooleanResult
```
public static boolean isBooleanResult(Node n)
```
    Returns:
    
    Whether the result of node evaluation is always a boolean
  - isStringResult
```
public static boolean isStringResult(Node n)
```
    Returns:
    
    Whether the result of node evaluation is always a string
  - isObjectResult
```
public static boolean isObjectResult(Node n)
```
    Returns:
    
    Whether the result of node evaluation is always an object
  - isAssignmentOp
```
public static boolean isAssignmentOp(Node n)
```
  - isCompoundAssignmentOp
```
public static boolean isCompoundAssignmentOp(Node n)
```
  - getEnclosingType
```
public static Node getEnclosingType(Node n,
                                    Token type)
```
    Gets the closest ancestor to the given node of the provided type.
  - getEnclosingClass
```
public static Node getEnclosingClass(Node n)
```
    Finds the class containing the given node.
  - 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.
  - getEnclosingBlockScopeRoot
```
public static Node getEnclosingBlockScopeRoot(Node n)
```
  - getEnclosingScopeRoot
```
public static Node getEnclosingScopeRoot(Node n)
```
  - 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)
```
  - isGet
```
public static boolean isGet(Node n)
```
    Is this a GETPROP or GETELEM node?
  - 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.
  - isExprCall
```
public static boolean isExprCall(Node n)
```
    Is this node a call expression statement?
    
    Parameters:
    
    n - The node
    
    Returns:
    
    True if n is EXPR_RESULT and n's first child is CALL
  - isEnhancedFor
```
public static boolean isEnhancedFor(Node n)
```
  - isAnyFor
```
public static boolean isAnyFor(Node n)
```
  - isControlStructure
```
public static boolean isControlStructure(Node n)
```
    Determines whether the given node is a FOR, DO, WHILE, WITH, or IF node.
  - isStatementBlock
```
public static boolean isStatementBlock(Node n)
```
    Returns:
    
    Whether the node is of a type that contain other statements.
  - isStatement
```
public static boolean isStatement(Node n)
```
    Returns:
    
    Whether the node is used as a statement.
  - isStatementParent
```
public static boolean isStatementParent(Node parent)
```
  - deleteNode
```
public static void deleteNode(Node n,
                              AbstractCompiler compiler)
```
    Permanently delete the given node from the AST, as well as report the related AST changes/deletions to the given compiler.
  - deleteFunctionCall
```
public static void deleteFunctionCall(Node n,
                                      AbstractCompiler compiler)
```
    Permanently delete the given call from the AST while maintaining a valid node structure, as well as report the related AST changes to the given compiler. In some cases, this is done by deleting the parent from the AST and is come cases expression is replaced by undefined.
  - deleteChildren
```
public static void deleteChildren(Node n,
                                  AbstractCompiler compiler)
```
    Permanently delete all the children of the given node, including reporting changes.
  - removeChild
```
public static void removeChild(Node parent,
                               Node node)
```
    Safely remove children while maintaining a valid node structure. In some cases, this is done by removing the parent from the AST as well.
  - replaceDeclarationChild
```
public static void replaceDeclarationChild(Node declChild,
                                           Node newStatement)
```
    Replace the child of a var/let/const declaration (usually a name) with a new statement. Preserves the order of side effects for all the other declaration children.
    
    Parameters:
    
    declChild - The name node to be replaced.
    
    newStatement - The statement to replace with.
  - tryMergeBlock
```
public static boolean tryMergeBlock(Node block,
                                    boolean alwaysMerge)
```
    Merge a block with its parent block.
    
    Returns:
    
    Whether the block was removed.
  - canMergeBlock
```
public static boolean canMergeBlock(Node block)
```
    A check inside a block to see if there are const, let, class, or function declarations to be safe and not hoist them into the upper block.
    
    Returns:
    
    Whether the block can be removed
  - isCallOrNew
```
public static boolean isCallOrNew(Node node)
```
    Parameters:
    
    node - A node
    
    Returns:
    
    Whether the call is a NEW or CALL node.
  - getFunctionBody
```
public static Node getFunctionBody(Node fn)
```
    Return a BLOCK node for the given FUNCTION node.
  - 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)).
  - isMethodDeclaration
```
public static boolean isMethodDeclaration(Node n)
```
    Is this node a class or object literal member function?
    examples:
```
   class C {
     f() {}
     get x() { return this.x_; }
     set x(v) { this.x_ = v; }
     [someExpr]() {}
   }
   obj = {
     f() {}
     get x() { return this.x_; }
     set x(v) { this.x_ = v; }
     [someExpr]() {}
   }
 
```
  - 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.
  - isDeclarationLValue
```
public static boolean isDeclarationLValue(Node n)
```
    Determines whether this node is used as an L-value that is a declaration.
    x = 5; is an L-value but does not declare a variable.
  - isImportedName
```
public static boolean isImportedName(Node n)
```
  - getDeclaringParent
```
public static Node getDeclaringParent(Node targetNode)
```
    Returns the node that is effectively declaring the given target.
    Examples:
```
   const a = 1; // getDeclaringParent(a) returns CONST
   let {[expression]: [x = 3]} = obj; // getDeclaringParent(x) returns LET
   function foo({a, b}) {}; // getDeclaringParent(a) returns PARAM_LIST
   function foo(a = 1) {}; // getDeclaringParent(a) returns PARAM_LIST
   function foo({a, b} = obj) {}; // getDeclaringParent(a) returns PARAM_LIST
   function foo(...a) {}; // getDeclaringParent(a) returns PARAM_LIST
   function foo() {}; // gotRootTarget(foo) returns FUNCTION
   class foo {}; // gotRootTarget(foo) returns CLASS
   import foo from './foo'; // getDeclaringParent(foo) returns IMPORT
   import {foo} from './foo'; // getDeclaringParent(foo) returns IMPORT
   import {foo as bar} from './foo'; // getDeclaringParent(bar) returns IMPORT
 
```
    Parameters:
    
    targetNode - a NAME, OBJECT_PATTERN, or ARRAY_PATTERN
    
    Returns:
    
    node of type LET, CONST, VAR, FUNCTION, CLASS, PARAM_LIST, or IMPORT
    
    Throws:
    
    java.lang.IllegalStateException - if targetNode is not actually used as a declaration target
  - getRootTarget
```
public static Node getRootTarget(Node targetNode)
```
    Returns the outermost target enclosing the given assignment target.
    Returns targetNode itself if there is no enclosing target.
    Examples:
```
   const a = 1; // getRootTarget(a) returns a
   let {[expression]: [x = 3]} = obj; // getRootTarget(x) returns {[expression]: [x = 3]}
   {a = 1} = obj; // getRootTarget(a) returns {a = 1}
   {[expression]: [x = 3]} = obj; // getRootTarget(x) returns {[expression]: [x = 3]}
   function foo({a, b}) {}; // getRootTarget(a) returns {a, b}
   function foo(a = 1) {}; // getRootTarget(a) returns a
   function foo({a, b} = obj) {}; // getRootTarget(a) returns a
   function foo(...a) {}; // getRootTarget(a) returns a
   function foo() {}; // gotRootTarget(foo) returns foo
   class foo {}; // gotRootTarget(foo) returns foo
   import foo from './foo'; // getRootTarget(foo) returns foo
   import {foo} from './foo'; // getRootTarget(foo) returns foo
   import {foo as bar} from './foo'; // getRootTarget(bar) returns bar
 
```
    Parameters:
    
    targetNode -
    
    Throws:
    
    java.lang.IllegalStateException - if targetNode is not actually used as a target
  - isLhsByDestructuring
```
public static boolean isLhsByDestructuring(Node n)
```
    Returns true if the node is a lhs value of a destructuring assignment For example, x in var [x] = [1];, var [...x] = [1];, and var {a: x} = {a: 1} or a.b in ([a.b] = [1]); or ({key: a.b} = {key: 1});
  - opToStr
```
public static java.lang.String opToStr(Token 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
  - containsType
```
public static boolean containsType(Node node,
                                   Token type)
```
    Returns:
    
    true if n or any of its descendants are of the specified type.
  - newDeclaration
```
public static Node newDeclaration(Node lhs,
                                  @Nullable
                                  Node rhs,
                                  Token declarationType)
```
  - newQName
```
public static Node newQName(AbstractCompiler compiler,
                            java.lang.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,
                                     java.lang.String name)
```
    Creates a property access on the context tree.
  - newQNameDeclaration
```
public static Node newQNameDeclaration(AbstractCompiler compiler,
                                       java.lang.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.
  - newQNameDeclaration
```
public static Node newQNameDeclaration(AbstractCompiler compiler,
                                       java.lang.String name,
                                       Node value,
                                       JSDocInfo info,
                                       Token type)
```
    Creates a node representing a qualified name.
    
    Parameters:
    
    name - A qualified name (e.g. "foo" or "foo.bar.baz")
    
    type - Must be VAR, CONST, or LET. Ignored if name is dotted.
    
    Returns:
    
    A VAR/CONST/LET node, or an EXPR_RESULT node containing an ASSIGN or NAME node.
  - isValidQualifiedName
```
@Deprecated
public static boolean isValidQualifiedName(CompilerOptions.LanguageMode mode,
                                                       java.lang.String name)
```
    Deprecated.
  - isValidQualifiedName
```
public static boolean isValidQualifiedName(FeatureSet mode,
                                           java.lang.String name)
```
    Determines whether the given name is a valid qualified name.
  - findLhsNodesInNode
```
public static java.util.List<Node> findLhsNodesInNode(Node declNode)
```
    Retrieves lhs nodes declared in the current declaration or ASSIGN statement.
  - isPrototypePropertyDeclaration
```
public static boolean isPrototypePropertyDeclaration(Node n)
```
    Returns:
    
    true if the node an assignment to a prototype property of some constructor.
  - emptyFunction
```
public static Node emptyFunction()
```
  - has
```
public static boolean has(Node node,
                          com.google.common.base.Predicate<Node> pred,
                          com.google.common.base.Predicate<Node> traverseChildrenPred)
```
    Returns:
    
    Whether the predicate is true for the node or any of its descendants.
  - getCount
```
public static int getCount(Node n,
                           com.google.common.base.Predicate<Node> pred,
                           com.google.common.base.Predicate<Node> traverseChildrenPred)
```
    Returns:
    
    The number of times the predicate is true for the node or any of its descendants.
  - visitPreOrder
```
public static void visitPreOrder(Node node,
                                 NodeUtil.Visitor visitor)
```
    A pre-order traversal, calling Visitor.visit for each decendent.
  - 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.
  - visitPostOrder
```
public static void visitPostOrder(Node node,
                                  NodeUtil.Visitor visitor)
```
    A post-order traversal, calling Visitor.visit for each decendent.
  - visitPostOrder
```
public static void visitPostOrder(Node node,
                                  NodeUtil.Visitor visitor,
                                  com.google.common.base.Predicate<Node> traverseChildrenPred)
```
    A post-order traversal, calling Visitor.visit for each descendant matching the predicate.
  - getFunctionParameters
```
public static Node getFunctionParameters(Node fnNode)
```
    Parameters:
    
    fnNode - The function.
    
    Returns:
    
    The Node containing the Function parameters.
  - getApproxRequiredArity
```
public static int getApproxRequiredArity(Node fun)
```
    Counts the parameters of a function that are not marked optional or varargs. In ES5 functions, that's all parameters, in ES6 it's a prefix of the parameters. The result is an overapproximation: if a parameter is not marked as optional, it may still be optional, but it doesn't have a default value, and wasn't marked as optional during transpilation.
  - getSourceName
```
public static java.lang.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.
  - getNodeByLineCol
```
public static Node getNodeByLineCol(Node ancestor,
                                    int lineNo,
                                    int columNo)
```
  - getDeclaredTypeExpression
```
@Nullable
public static JSTypeExpression getDeclaredTypeExpression(Node declaration)
```
    Return declared JSDoc type for the given name declaration, or null if none present.
  - getBestJSDocInfo
```
@Nullable
public static JSDocInfo getBestJSDocInfo(Node n)
```
    Find the best JSDoc for the given node.
  - getBestJSDocInfoNode
```
@Nullable
public static Node getBestJSDocInfoNode(Node n)
```
  - getBestLValue
```
public static Node getBestLValue(Node n)
```
    Find the l-value that the given r-value is being assigned to.
  - getRValueOfLValue
```
public static Node getRValueOfLValue(Node n)
```
    Gets the r-value (or initializer) of a node returned by getBestLValue.
  - isTopLevel
```
public static boolean isTopLevel(Node n)
```
  - isCallTo
```
public static boolean isCallTo(Node n,
                               java.lang.String qualifiedName)
```
  - markFunctionsDeleted
```
public static void markFunctionsDeleted(Node node,
                                        AbstractCompiler compiler)
```
    Recurses through a tree, marking all function nodes deleted.
  - getParentChangeScopeNodes
```
public static java.util.List<Node> getParentChangeScopeNodes(java.util.List<Node> scopeNodes)
```
    Returns the list of scope nodes which are parents of the provided list of scope nodes.
  - removeNestedChangeScopeNodes
```
public static java.util.List<Node> removeNestedChangeScopeNodes(java.util.List<Node> scopeNodes)
```
    Removes any scope nodes from the provided list that are nested within some other scope node also in the list. Returns the modified list.
  - isObjLitProperty
```
public static boolean isObjLitProperty(Node node)
```
    Returns true if the node is a property of an object literal.
  - isBlocklessArrowFunctionResult
```
public static boolean isBlocklessArrowFunctionResult(Node n)
```
    Returns:
    
    Whether the node represents the return value of a blockless Arrow function

Class NodeUtil

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTERN_OBJECT_PROPERTY_STRING

Method Detail

getStringValue

getName

getNameNode

removeName

getNearestFunctionName

getClassMembers

isLiteralValue

isNamespaceDecl

isFromTypeSummary

mayHaveSideEffects

mayHaveSideEffects

precedence

isUndefined

isNullOrUndefined

getKnownValueType

isNumericResult

isBooleanResult

isStringResult

isObjectResult

isAssignmentOp

isCompoundAssignmentOp

getEnclosingType

getEnclosingClass

getEnclosingFunction

getEnclosingScript

getEnclosingBlock

getEnclosingBlockScopeRoot

getEnclosingScopeRoot

isInFunction

getEnclosingStatement

getEnclosingNode

isGet

isNameDeclaration

getAssignedValue

isExprCall

isEnhancedFor

isAnyFor

isControlStructure

isStatementBlock

isStatement

isStatementParent

deleteNode

deleteFunctionCall

deleteChildren

removeChild

replaceDeclarationChild

tryMergeBlock

canMergeBlock

isCallOrNew

getFunctionBody

isFunctionDeclaration

isMethodDeclaration

isClassDeclaration

isHoistedFunctionDeclaration

isLValue

isDeclarationLValue

isImportedName

getDeclaringParent

getRootTarget

isLhsByDestructuring

opToStr

containsType

newDeclaration

newQName

newPropertyAccess

newQNameDeclaration

newQNameDeclaration

isValidQualifiedName

isValidQualifiedName

findLhsNodesInNode

isPrototypePropertyDeclaration

emptyFunction