com.google.javascript.jscomp.lint

Class CheckRequiresSorted

java.lang.Object

com.google.javascript.jscomp.lint.CheckRequiresSorted

All Implemented Interfaces:

NodeTraversal.Callback

public final class CheckRequiresSorted
extends java.lang.Object
implements NodeTraversal.Callback

Checks that Closure import statements (goog.require, goog.requireType, and goog.forwardDeclare) are sorted and deduplicated, exposing the necessary information to produce a suggested fix.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckRequiresSorted.Mode Operation modes.

Constructor Summary

Constructors

Constructor and Description
CheckRequiresSorted(CheckRequiresSorted.Mode mode)

Method Summary

Modifier and Type	Method and Description
Node	getFirstNode() Returns the node for the first recognized import statement.
Node	getLastNode() Returns the node for the last recognized import statement.
java.lang.String	getReplacement() Returns a textual replacement yielding a canonical version of the imports.
boolean	needsFix() Returns whether the imports need to be fixed, i.e., whether they are *not* already canonical.
boolean	shouldTraverse(NodeTraversal t, Node n, Node parent) Visits a node in pre order (before visiting its children) and decides whether this node's children should be traversed.
void	visit(NodeTraversal t, Node n, Node parent) Visits a node in postorder (after its children have been visited).

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckRequiresSorted

public CheckRequiresSorted(CheckRequiresSorted.Mode mode)

Method Detail

getFirstNode

public Node getFirstNode()

Returns the node for the first recognized import statement.

getLastNode

public Node getLastNode()

Returns the node for the last recognized import statement.

getReplacement

public java.lang.String getReplacement()

Returns a textual replacement yielding a canonical version of the imports.

needsFix

public boolean needsFix()

Returns whether the imports need to be fixed, i.e., whether they are *not* already canonical.

shouldTraverse

public final boolean shouldTraverse(NodeTraversal t,
                                    Node n,
                                    Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in pre order (before visiting its children) and decides whether this node's children should be traversed. If children are traversed, they will be visited by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder.

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

Specified by:

shouldTraverse in interface NodeTraversal.Callback

Returns:

whether the children of this node should be visited

visit

public final void visit(NodeTraversal t,
                        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