com.google.javascript.jscomp.lint

Class CheckArrayWithGoogObject

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.lint.CheckArrayWithGoogObject

All Implemented Interfaces:

CompilerPass, HotSwapCompilerPass, NodeTraversal.Callback

public final class CheckArrayWithGoogObject
extends NodeTraversal.AbstractPostOrderCallback
implements HotSwapCompilerPass

Lints against passing arrays to goog.object methods with the intention of iterating over them as though with a for-in loop, which is discouraged with arrays.

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticType	ARRAY_PASSED_TO_GOOG_OBJECT

Constructor Summary

Constructors

Constructor and Description
CheckArrayWithGoogObject(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
void	hotSwapScript(Node scriptRoot, Node originalRoot) Process the JS with root node root.
boolean	isGoogObjectIterationOverArray(Node n)
void	process(Node externs, Node root) Process the JS with root node root.
void	visit(NodeTraversal unused, Node n, Node parent) Visits a node in postorder (after its children have been visited).

Methods inherited from class com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

shouldTraverse

Methods inherited from class java.lang.Object

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

Field Detail

ARRAY_PASSED_TO_GOOG_OBJECT

public static final DiagnosticType ARRAY_PASSED_TO_GOOG_OBJECT

Constructor Detail

CheckArrayWithGoogObject

public CheckArrayWithGoogObject(AbstractCompiler compiler)

Method Detail

isGoogObjectIterationOverArray

public boolean isGoogObjectIterationOverArray(Node n)

visit

public void visit(NodeTraversal unused,
                  Node n,
                  Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children have been visited). A node is visited only if all its parents should be traversed (NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node)).

Implementations can have side effects (e.g. modifying the parse tree).

Specified by:

visit in interface NodeTraversal.Callback

process

public void process(Node externs,
                    Node root)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

hotSwapScript

public void hotSwapScript(Node scriptRoot,
                          Node originalRoot)

Description copied from interface: HotSwapCompilerPass

Process the JS with root node root. This is supposed to be significantly faster compared to corresponding full-compiler passes.

Specified by:

hotSwapScript in interface HotSwapCompilerPass

Parameters:

scriptRoot - Root node corresponding to the file that is modified, should be of type Token.SCRIPT.

originalRoot - Root node corresponding to the original version of the file that is modified. Should be of type token.SCRIPT.