com.google.template.soy.exprtree

Class AbstractReturningExprNodeVisitor<R>

java.lang.Object

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

com.google.template.soy.exprtree.AbstractReturningExprNodeVisitor<R>

Type Parameters:

R - The return type of this visitor.

All Implemented Interfaces:

NodeVisitor<ExprNode,R>

Direct Known Subclasses:

EvalVisitor, TranslateExprNodeVisitor, TranslateToPyExprVisitor

public abstract class AbstractReturningExprNodeVisitor<R>
extends AbstractReturningNodeVisitor<ExprNode,R>

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

Same as AbstractExprNodeVisitor 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 visitExprNode(), which is usually needed. Other fallback methods include visitPrimitiveNode() and visitOperatorNode().
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:

AbstractExprNodeVisitor

Constructor Summary

Constructors

Constructor and Description
AbstractReturningExprNodeVisitor()

Method Summary

Modifier and Type	Method and Description
protected R	visit(ExprNode node) Visits the given node to execute the function defined by this visitor.
protected R	visitAndOpNode(OperatorNodes.AndOpNode node)
protected R	visitBooleanNode(BooleanNode node)
protected List<R>	visitChildren(ExprNode.ParentExprNode node) Helper to visit all the children of a node, in order.
protected R	visitConditionalOpNode(OperatorNodes.ConditionalOpNode node)
protected R	visitDataAccessNode(DataAccessNode node)
protected R	visitDivideByOpNode(OperatorNodes.DivideByOpNode node)
protected R	visitEqualOpNode(OperatorNodes.EqualOpNode node)
protected R	visitExprNode(ExprNode node)
protected R	visitExprRootNode(ExprRootNode node)
protected R	visitFieldAccessNode(FieldAccessNode node)
protected R	visitFloatNode(FloatNode node)
protected R	visitFunctionNode(FunctionNode node)
protected R	visitGlobalNode(GlobalNode node)
protected R	visitGreaterThanOpNode(OperatorNodes.GreaterThanOpNode node)
protected R	visitGreaterThanOrEqualOpNode(OperatorNodes.GreaterThanOrEqualOpNode node)
protected R	visitIntegerNode(IntegerNode node)
protected R	visitItemAccessNode(ItemAccessNode node)
protected R	visitLegacyObjectMapLiteralNode(LegacyObjectMapLiteralNode node)
protected R	visitLessThanOpNode(OperatorNodes.LessThanOpNode node)
protected R	visitLessThanOrEqualOpNode(OperatorNodes.LessThanOrEqualOpNode node)
protected R	visitListLiteralNode(ListLiteralNode node)
protected R	visitMapLiteralNode(MapLiteralNode node)
protected R	visitMinusOpNode(OperatorNodes.MinusOpNode node)
protected R	visitModOpNode(OperatorNodes.ModOpNode node)
protected R	visitNegativeOpNode(OperatorNodes.NegativeOpNode node)
protected R	visitNotEqualOpNode(OperatorNodes.NotEqualOpNode node)
protected R	visitNotOpNode(OperatorNodes.NotOpNode node)
protected R	visitNullCoalescingOpNode(OperatorNodes.NullCoalescingOpNode node)
protected R	visitNullNode(NullNode node)
protected R	visitOperatorNode(ExprNode.OperatorNode node)
protected R	visitOrOpNode(OperatorNodes.OrOpNode node)
protected R	visitPlusOpNode(OperatorNodes.PlusOpNode node)
protected R	visitPrimitiveNode(ExprNode.PrimitiveNode node)
protected R	visitProtoInitNode(ProtoInitNode node)
protected R	visitStringNode(StringNode node)
protected R	visitTimesOpNode(OperatorNodes.TimesOpNode node)
protected R	visitVarRefNode(VarRefNode 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

AbstractReturningExprNodeVisitor

public AbstractReturningExprNodeVisitor()

Method Detail

visit

protected R visit(ExprNode node)

Description copied from class: AbstractReturningNodeVisitor

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

Specified by:

visit in class AbstractReturningNodeVisitor<ExprNode,R>

Parameters:

node - The node to visit.

visitChildren

protected List<R> visitChildren(ExprNode.ParentExprNode node)

Helper to visit all the children of a node, in order.

Parameters:

node - The parent node whose children to visit.

Returns:

The list of return values from visiting the children.

See Also:

AbstractReturningNodeVisitor.visitChildrenAllowingConcurrentModification(com.google.template.soy.basetree.ParentNode<? extends N>)

visitExprRootNode

protected R visitExprRootNode(ExprRootNode node)

visitNullNode

protected R visitNullNode(NullNode node)

visitBooleanNode

protected R visitBooleanNode(BooleanNode node)

visitIntegerNode

protected R visitIntegerNode(IntegerNode node)

visitFloatNode

protected R visitFloatNode(FloatNode node)

visitStringNode

protected R visitStringNode(StringNode node)

visitPrimitiveNode

protected R visitPrimitiveNode(ExprNode.PrimitiveNode node)

visitListLiteralNode

protected R visitListLiteralNode(ListLiteralNode node)

visitLegacyObjectMapLiteralNode

protected R visitLegacyObjectMapLiteralNode(LegacyObjectMapLiteralNode node)

visitMapLiteralNode

protected R visitMapLiteralNode(MapLiteralNode node)

visitVarRefNode

protected R visitVarRefNode(VarRefNode node)

visitDataAccessNode

protected R visitDataAccessNode(DataAccessNode node)

visitFieldAccessNode

protected R visitFieldAccessNode(FieldAccessNode node)

visitItemAccessNode

protected R visitItemAccessNode(ItemAccessNode node)

visitGlobalNode

protected R visitGlobalNode(GlobalNode node)

visitNegativeOpNode

protected R visitNegativeOpNode(OperatorNodes.NegativeOpNode node)

visitNotOpNode

protected R visitNotOpNode(OperatorNodes.NotOpNode node)

visitTimesOpNode

protected R visitTimesOpNode(OperatorNodes.TimesOpNode node)

visitDivideByOpNode

protected R visitDivideByOpNode(OperatorNodes.DivideByOpNode node)

visitModOpNode

protected R visitModOpNode(OperatorNodes.ModOpNode node)

visitPlusOpNode

protected R visitPlusOpNode(OperatorNodes.PlusOpNode node)

visitMinusOpNode

protected R visitMinusOpNode(OperatorNodes.MinusOpNode node)

visitLessThanOpNode

protected R visitLessThanOpNode(OperatorNodes.LessThanOpNode node)

visitGreaterThanOpNode

protected R visitGreaterThanOpNode(OperatorNodes.GreaterThanOpNode node)

visitLessThanOrEqualOpNode

protected R visitLessThanOrEqualOpNode(OperatorNodes.LessThanOrEqualOpNode node)

visitGreaterThanOrEqualOpNode

protected R visitGreaterThanOrEqualOpNode(OperatorNodes.GreaterThanOrEqualOpNode node)

visitEqualOpNode

protected R visitEqualOpNode(OperatorNodes.EqualOpNode node)

visitNotEqualOpNode

protected R visitNotEqualOpNode(OperatorNodes.NotEqualOpNode node)

visitAndOpNode

protected R visitAndOpNode(OperatorNodes.AndOpNode node)

visitOrOpNode

protected R visitOrOpNode(OperatorNodes.OrOpNode node)

visitConditionalOpNode

protected R visitConditionalOpNode(OperatorNodes.ConditionalOpNode node)

visitNullCoalescingOpNode

protected R visitNullCoalescingOpNode(OperatorNodes.NullCoalescingOpNode node)

visitOperatorNode

protected R visitOperatorNode(ExprNode.OperatorNode node)

visitFunctionNode

protected R visitFunctionNode(FunctionNode node)

visitProtoInitNode

protected R visitProtoInitNode(ProtoInitNode node)

visitExprNode

protected R visitExprNode(ExprNode node)

Parameters:

node - The node being visited.