com.google.template.soy.soytree

Class AbstractReturningSoyNodeVisitor<R>

java.lang.Object

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

com.google.template.soy.soytree.AbstractReturningSoyNodeVisitor<R>

Type Parameters:

R - The return type of this visitor.

All Implemented Interfaces:

NodeVisitor<SoyNode,R>

Direct Known Subclasses:

CanInitOutputVarVisitor, IsComputableAsJsExprsVisitor

public abstract class AbstractReturningSoyNodeVisitor<R>
extends AbstractReturningNodeVisitor<SoyNode,R>

Abstract base class for all SoyNode visitors. A visitor is basically a function implemented for some or all SoyNodes, where the implementation can be different for each specific node class.

Same as AbstractSoyNodeVisitor except that in this class, internal visit() calls return a value.

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

To create a visitor:

1. Subclass this class.
2. Implement visit*Node() methods for some specific node types.
3. Implement fallback methods for node types not specifically handled. The most general fallback method is visitSoyNode(), which is usually needed. Other fallback methods include visitLoopNode() and visitCallParamNode().
4. Maybe implement a constructor, taking appropriate parameters for your visitor call.
5. Maybe implement exec() if this visitor needs to return a non-null final result and/or if this visitor has state that needs to be setup/reset before each unrelated use of visit().

See Also:

AbstractSoyNodeVisitor

Constructor Summary

Constructors

Constructor and Description
AbstractReturningSoyNodeVisitor()

Method Summary

Modifier and Type	Method and Description
protected R	visit(SoyNode node) Visits the given node to execute the function defined by this visitor.
protected R	visitCallBasicNode(CallBasicNode node)
protected R	visitCallDelegateNode(CallDelegateNode node)
protected R	visitCallNode(CallNode node)
protected R	visitCallParamContentNode(CallParamContentNode node)
protected R	visitCallParamNode(CallParamNode node)
protected R	visitCallParamValueNode(CallParamValueNode node)
protected R	visitDebuggerNode(DebuggerNode node)
protected R	visitForIfemptyNode(ForIfemptyNode node)
protected R	visitForNode(ForNode node)
protected R	visitForNonemptyNode(ForNonemptyNode node)
protected R	visitHtmlAttributeNode(HtmlAttributeNode node)
protected R	visitHtmlAttributeValueNode(HtmlAttributeValueNode node)
protected R	visitHtmlCloseTagNode(HtmlCloseTagNode node)
protected R	visitHtmlOpenTagNode(HtmlOpenTagNode node)
protected R	visitIfCondNode(IfCondNode node)
protected R	visitIfElseNode(IfElseNode node)
protected R	visitIfNode(IfNode node)
protected R	visitLetContentNode(LetContentNode node)
protected R	visitLetNode(LetNode node)
protected R	visitLetValueNode(LetValueNode node)
protected R	visitLogNode(LogNode node)
protected R	visitMsgFallbackGroupNode(MsgFallbackGroupNode node)
protected R	visitMsgHtmlTagNode(MsgHtmlTagNode node)
protected R	visitMsgNode(MsgNode node)
protected R	visitMsgPlaceholderNode(MsgPlaceholderNode node)
protected R	visitMsgPluralCaseNode(MsgPluralCaseNode node)
protected R	visitMsgPluralDefaultNode(MsgPluralDefaultNode node)
protected R	visitMsgPluralNode(MsgPluralNode node)
protected R	visitMsgSelectCaseNode(MsgSelectCaseNode node)
protected R	visitMsgSelectDefaultNode(MsgSelectDefaultNode node)
protected R	visitMsgSelectNode(MsgSelectNode node)
protected R	visitMsgSubstUnitNode(SoyNode.MsgSubstUnitNode node)
protected R	visitPrintDirectiveNode(PrintDirectiveNode node)
protected R	visitPrintNode(PrintNode node)
protected R	visitRawTextNode(RawTextNode node)
protected R	visitSoyFileNode(SoyFileNode node)
protected R	visitSoyFileSetNode(SoyFileSetNode node)
protected R	visitSoyNode(SoyNode node)
protected R	visitSwitchCaseNode(SwitchCaseNode node)
protected R	visitSwitchDefaultNode(SwitchDefaultNode node)
protected R	visitSwitchNode(SwitchNode node)
protected R	visitTemplateBasicNode(TemplateNode node)
protected R	visitTemplateDelegateNode(TemplateNode node)
protected R	visitTemplateNode(TemplateNode node)
protected R	visitVeLogNode(VeLogNode node)

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

exec, visitChildren, visitChildrenAllowingConcurrentModification

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReturningSoyNodeVisitor

public AbstractReturningSoyNodeVisitor()

Method Detail

visit

protected R visit(SoyNode node)

Description copied from class: AbstractReturningNodeVisitor

Visits the given node to execute the function defined by this visitor.

Specified by:

visit in class AbstractReturningNodeVisitor<SoyNode,R>

Parameters:

node - The node to visit.

visitSoyFileSetNode

protected R visitSoyFileSetNode(SoyFileSetNode node)

visitSoyFileNode

protected R visitSoyFileNode(SoyFileNode node)

visitTemplateBasicNode

protected R visitTemplateBasicNode(TemplateNode node)

visitTemplateDelegateNode

protected R visitTemplateDelegateNode(TemplateNode node)

visitTemplateNode

protected R visitTemplateNode(TemplateNode node)

visitRawTextNode

protected R visitRawTextNode(RawTextNode node)

visitMsgFallbackGroupNode

protected R visitMsgFallbackGroupNode(MsgFallbackGroupNode node)

visitMsgNode

protected R visitMsgNode(MsgNode node)

visitMsgPluralNode

protected R visitMsgPluralNode(MsgPluralNode node)

visitMsgPluralCaseNode

protected R visitMsgPluralCaseNode(MsgPluralCaseNode node)

visitMsgPluralDefaultNode

protected R visitMsgPluralDefaultNode(MsgPluralDefaultNode node)

visitMsgSelectNode

protected R visitMsgSelectNode(MsgSelectNode node)

visitMsgSelectCaseNode

protected R visitMsgSelectCaseNode(MsgSelectCaseNode node)

visitMsgSelectDefaultNode

protected R visitMsgSelectDefaultNode(MsgSelectDefaultNode node)

visitMsgPlaceholderNode

protected R visitMsgPlaceholderNode(MsgPlaceholderNode node)

visitMsgHtmlTagNode

protected R visitMsgHtmlTagNode(MsgHtmlTagNode node)

visitMsgSubstUnitNode

protected R visitMsgSubstUnitNode(SoyNode.MsgSubstUnitNode node)

visitPrintNode

protected R visitPrintNode(PrintNode node)

visitPrintDirectiveNode

protected R visitPrintDirectiveNode(PrintDirectiveNode node)

visitLetValueNode

protected R visitLetValueNode(LetValueNode node)

visitLetContentNode

protected R visitLetContentNode(LetContentNode node)

visitLetNode

protected R visitLetNode(LetNode node)

visitIfNode

protected R visitIfNode(IfNode node)

visitIfCondNode

protected R visitIfCondNode(IfCondNode node)

visitIfElseNode

protected R visitIfElseNode(IfElseNode node)

visitSwitchNode

protected R visitSwitchNode(SwitchNode node)

visitSwitchCaseNode

protected R visitSwitchCaseNode(SwitchCaseNode node)

visitSwitchDefaultNode

protected R visitSwitchDefaultNode(SwitchDefaultNode node)

visitForNode

protected R visitForNode(ForNode node)

visitForIfemptyNode

protected R visitForIfemptyNode(ForIfemptyNode node)

visitForNonemptyNode

protected R visitForNonemptyNode(ForNonemptyNode node)

visitCallBasicNode

protected R visitCallBasicNode(CallBasicNode node)

visitCallDelegateNode

protected R visitCallDelegateNode(CallDelegateNode node)

visitCallNode

protected R visitCallNode(CallNode node)

visitCallParamValueNode

protected R visitCallParamValueNode(CallParamValueNode node)

visitCallParamContentNode

protected R visitCallParamContentNode(CallParamContentNode node)

visitCallParamNode

protected R visitCallParamNode(CallParamNode node)

visitHtmlOpenTagNode

protected R visitHtmlOpenTagNode(HtmlOpenTagNode node)

visitHtmlCloseTagNode

protected R visitHtmlCloseTagNode(HtmlCloseTagNode node)

visitHtmlAttributeNode

protected R visitHtmlAttributeNode(HtmlAttributeNode node)

visitHtmlAttributeValueNode

protected R visitHtmlAttributeValueNode(HtmlAttributeValueNode node)

visitVeLogNode

protected R visitVeLogNode(VeLogNode node)

visitLogNode

protected R visitLogNode(LogNode node)

visitDebuggerNode

protected R visitDebuggerNode(DebuggerNode node)

visitSoyNode

protected R visitSoyNode(SoyNode node)

Parameters:

node - the visited node.