Package 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, NodeTraversal.Callback

public final class CheckArrayWithGoogObject
extends NodeTraversal.AbstractPostOrderCallback
implements CompilerPass

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	Description
static DiagnosticType	ARRAY_PASSED_TO_GOOG_OBJECT

Constructor Summary

Constructors

Constructor	Description
CheckArrayWithGoogObject(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method	Description
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).

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). A node is visited in postorder iff NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) returned true for its parent. In particular, the root node is never visited in postorder.

Siblings are always visited left-to-right.

Implementations can have side-effects (e.g. modify the parse tree). Removing the current node is legal, but removing or reordering nodes above the current node may cause nodes to be visited twice or not at all.

Specified by:

visit in interface NodeTraversal.Callback

Parameters:

unused - The current traversal.

n - The current node.

parent - The parent of the current node.

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