com.google.javascript.jscomp

Class SimpleDefinitionFinder.DefinitionGatheringCallback

java.lang.Object

com.google.javascript.jscomp.SimpleDefinitionFinder.DefinitionGatheringCallback

All Implemented Interfaces:

NodeTraversal.Callback

Enclosing class:

SimpleDefinitionFinder

private class SimpleDefinitionFinder.DefinitionGatheringCallback
extends java.lang.Object
implements NodeTraversal.Callback

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inExterns

Constructor Summary

Constructors

Constructor and Description
DefinitionGatheringCallback(boolean inExterns)

Method Summary

Modifier and Type	Method and Description
private boolean	jsdocContainsDeclarations(Node node)
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 traversal, Node node, 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

Field Detail

inExterns

private boolean inExterns

Constructor Detail

DefinitionGatheringCallback

DefinitionGatheringCallback(boolean inExterns)

Method Detail

shouldTraverse

public 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 void visit(NodeTraversal traversal,
                  Node node,
                  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

jsdocContainsDeclarations

private boolean jsdocContainsDeclarations(Node node)

Returns:

Whether the node has a JSDoc that actually declares something.