com.google.template.soy.sharedpasses

Class FindIjParamsVisitor

java.lang.Object

com.google.template.soy.sharedpasses.FindIjParamsVisitor

public class FindIjParamsVisitor
extends Object

Visitor for finding the injected params used by a given template.

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

exec(com.google.template.soy.soytree.TemplateNode) 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	FindIjParamsVisitor.IjParamsInfo Return value for FindIjParamsVisitor.

Constructor Summary

Constructors

Constructor and Description
FindIjParamsVisitor(TemplateRegistry templateRegistry, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
FindIjParamsVisitor.IjParamsInfo	exec(TemplateNode rootTemplate) Computes injected params info for a template.
com.google.common.collect.ImmutableMap<TemplateNode,FindIjParamsVisitor.IjParamsInfo>	execOnAllTemplates(SoyFileSetNode soyTree) Precomputes injected params info for all templates.

Methods inherited from class java.lang.Object

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

Constructor Detail

FindIjParamsVisitor

public FindIjParamsVisitor(@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 FindIjParamsVisitor.IjParamsInfo exec(TemplateNode rootTemplate)

Computes injected params info for a template.

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

execOnAllTemplates

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

Precomputes injected params info for all templates.

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

Parameters:

soyTree - The full Soy tree.

Returns:

A map from template node to injected params info for all templates. The returned map is deeply immutable (IjParamsInfo is immutable).