com.google.template.soy.sharedpasses

Class FindTransitiveDepTemplatesVisitor

java.lang.Object

com.google.template.soy.basetree.AbstractNodeVisitor<SoyNode,R>

com.google.template.soy.soytree.AbstractSoyNodeVisitor<FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

com.google.template.soy.sharedpasses.FindTransitiveDepTemplatesVisitor

All Implemented Interfaces:

NodeVisitor<SoyNode,FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

public final class FindTransitiveDepTemplatesVisitor
extends AbstractSoyNodeVisitor<FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

Visitor for finding the set of templates transitively called by a given template.

Important: Do not use outside of Soy code (treat as superpackage-private).

exec(com.google.template.soy.soytree.SoyNode) should be called on a TemplateNode.

If you need to call this visitor for multiple templates in the same tree (without modifying the tree), it's more efficient to reuse the same instance of this visitor because we memoize results from previous calls to exec.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo Return value for FindTransitiveDepTemplatesVisitor.

Field Summary

Fields inherited from class com.google.template.soy.basetree.AbstractNodeVisitor

errorReporter

Constructor Summary

Constructors

Constructor and Description
FindTransitiveDepTemplatesVisitor(TemplateRegistry templateRegistry, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo	exec(SoyNode rootTemplate) Executes the function defined by this visitor.
com.google.common.collect.ImmutableMap<TemplateNode,FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>	execOnAllTemplates(SoyFileSetNode soyTree) Computes transitive dep templates info for all templates in a Soy tree.
com.google.common.collect.ImmutableMap<TemplateNode,FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>	execOnMultipleTemplates(Iterable<TemplateNode> rootTemplates) Computes transitive dep templates info for multiple templates.
protected void	visitCallBasicNode(CallBasicNode node)
protected void	visitCallDelegateNode(CallDelegateNode node)
protected void	visitSoyNode(SoyNode node)
protected void	visitTemplateNode(TemplateNode node)

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNodeVisitor

visit, visitCallNode, visitCallParamContentNode, visitCallParamNode, visitCallParamValueNode, visitChildren, visitChildrenAllowingConcurrentModification, visitCssNode, visitDebuggerNode, visitForeachIfemptyNode, visitForeachNode, visitForeachNonemptyNode, visitForNode, visitGoogMsgDefNode, visitGoogMsgRefNode, visitIfCondNode, visitIfElseNode, visitIfNode, visitLetContentNode, visitLetNode, visitLetValueNode, visitLogNode, visitLoopNode, visitMsgFallbackGroupNode, visitMsgHtmlTagNode, visitMsgNode, visitMsgPlaceholderNode, visitMsgPluralCaseNode, visitMsgPluralDefaultNode, visitMsgPluralNode, visitMsgPluralRemainderNode, visitMsgSelectCaseNode, visitMsgSelectDefaultNode, visitMsgSelectNode, visitMsgSubstUnitNode, visitPrintDirectiveNode, visitPrintNode, visitRawTextNode, visitSoyFileNode, visitSoyFileSetNode, visitSwitchCaseNode, visitSwitchDefaultNode, visitSwitchNode, visitTemplateBasicNode, visitTemplateDelegateNode, visitXidNode

Methods inherited from class com.google.template.soy.basetree.AbstractNodeVisitor

visitChildren, visitChildrenAllowingConcurrentModification

Methods inherited from class java.lang.Object

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

Constructor Detail

FindTransitiveDepTemplatesVisitor

public FindTransitiveDepTemplatesVisitor(@Nullable
                                         TemplateRegistry templateRegistry,
                                         ErrorReporter errorReporter)

Parameters:

templateRegistry - Map from template name to TemplateNode to use during the pass.

errorReporter - For reporting errors.

Method Detail

exec

public FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo exec(SoyNode rootTemplate)

Executes the function defined by this visitor.

Note: This method is not thread-safe. If you need to get transitive dep templates info in a thread-safe manner, then please use execOnAllTemplates(com.google.template.soy.soytree.SoyFileSetNode)() in a thread-safe manner.

Specified by:

exec in interface NodeVisitor<SoyNode,FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

Overrides:

exec in class AbstractNodeVisitor<SoyNode,FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

Parameters:

rootTemplate - The node to execute the function on.

execOnMultipleTemplates

public com.google.common.collect.ImmutableMap<TemplateNode,FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo> execOnMultipleTemplates(Iterable<TemplateNode> rootTemplates)

Computes transitive dep templates info for multiple templates.

Note: This method returns a map from root template to TransitiveDepTemplatesInfo for the given root templates. If you wish to obtain a single TransitiveDepTemplatesInfo object that contains the combined info for all of the given root templates, then use TransitiveDepTemplatesInfo.merge(resultMap.values()) where resultMap is the result returned by this method.

Note: This method is not thread-safe. If you need to get transitive dep templates info in a thread-safe manner, then please use execOnAllTemplates(com.google.template.soy.soytree.SoyFileSetNode)() in a thread-safe manner.

Parameters:

rootTemplates - The root templates to compute transitive dep templates info for.

Returns:

Map from root template to TransitiveDepTemplatesInfo.

execOnAllTemplates

public com.google.common.collect.ImmutableMap<TemplateNode,FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo> execOnAllTemplates(SoyFileSetNode soyTree)

Computes transitive dep templates info for all templates in a Soy tree.

Note: This method returns a map from root template to TransitiveDepTemplatesInfo for all templates in the given Soy tree. If you wish to obtain a single TransitiveDepTemplatesInfo object that contains the combined info for all templates in the given Soy tree, then use TransitiveDepTemplatesInfo.merge(resultMap.values()) where resultMap is the result returned by this method.

Note: This method is not thread-safe. If you need to get transitive dep templates info in a thread-safe manner, be sure to call this method only once and then use the precomputed map.

Parameters:

soyTree - A full Soy tree.

Returns:

Map from root template to TransitiveDepTemplatesInfo for all templates in the given Soy tree. The returned map is deeply immutable (TransitiveDepTemplatesInfo is immutable).

visitTemplateNode

protected void visitTemplateNode(TemplateNode node)

Overrides:

visitTemplateNode in class AbstractSoyNodeVisitor<FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

visitCallBasicNode

protected void visitCallBasicNode(CallBasicNode node)

Overrides:

visitCallBasicNode in class AbstractSoyNodeVisitor<FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

visitCallDelegateNode

protected void visitCallDelegateNode(CallDelegateNode node)

Overrides:

visitCallDelegateNode in class AbstractSoyNodeVisitor<FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

visitSoyNode

protected void visitSoyNode(SoyNode node)

Overrides:

visitSoyNode in class AbstractSoyNodeVisitor<FindTransitiveDepTemplatesVisitor.TransitiveDepTemplatesInfo>

Parameters:

node - the visited node.