com.google.template.soy.basetree

Class AbstractReturningNodeVisitor<N extends Node,R>

java.lang.Object

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

Type Parameters:

N - A more specific subinterface of Node, or just Node if not applicable.

R - The return type of this visitor.

All Implemented Interfaces:

NodeVisitor<N,R>

Direct Known Subclasses:

AbstractReturningExprNodeVisitor, AbstractReturningSoyNodeVisitor

public abstract class AbstractReturningNodeVisitor<N extends Node,R>
extends Object
implements NodeVisitor<N,R>

Base class for AbstractXxxNodeVisitor classes.

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

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

See Also:

AbstractNodeVisitor

Constructor Summary

Constructors

Constructor and Description
AbstractReturningNodeVisitor()

Method Summary

Modifier and Type	Method and Description
R	exec(N node) Executes the function defined by this visitor.
protected abstract R	visit(N node) Visits the given node to execute the function defined by this visitor.
protected List<R>	visitChildren(ParentNode<? extends N> node) Helper to visit all the children of a node, in order.
protected List<R>	visitChildrenAllowingConcurrentModification(ParentNode<? extends N> node) Helper to visit all the children of a node, in order.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReturningNodeVisitor

public AbstractReturningNodeVisitor()

Method Detail

exec

public R exec(N node)

Description copied from interface: NodeVisitor

Executes the function defined by this visitor.

Specified by:

exec in interface NodeVisitor<N extends Node,R>

Parameters:

node - The node to execute the function on.

visit

protected abstract R visit(N node)

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

Parameters:

node - The node to visit.

visitChildren

protected List<R> visitChildren(ParentNode<? extends N> 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:

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

visitChildrenAllowingConcurrentModification

protected List<R> visitChildrenAllowingConcurrentModification(ParentNode<? extends N> node)

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

This method differs from visitChildren in that we are iterating through a copy of the children. Thus, concurrent modification of the list of children is allowed.

Parameters:

node - The parent node whose children to visit.

Returns:

The list of return values from visiting the children.

See Also:

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