com.google.template.soy.exprtree

Class ExprRootNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.exprtree.AbstractExprNode

com.google.template.soy.exprtree.AbstractParentExprNode

com.google.template.soy.exprtree.ExprRootNode

All Implemented Interfaces:

Node, ParentNode<ExprNode>, ExprNode, ExprNode.ParentExprNode

public final class ExprRootNode
extends AbstractParentExprNode

Dummy node that serves as the root of an expression tree so that the tree can be arbitrarily changed without needing to change the reference to the tree.

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

This node should always have exactly one child.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.exprtree.ExprNode

ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Constructor Summary

Constructors

Constructor and Description
ExprRootNode(ExprNode child) Creates a new instance with the given node as the child.

Method Summary

Modifier and Type	Method and Description
ExprRootNode	copy(CopyState copyState) See Node.copy(CopyState) for a description of the copy contract.
ExprNode	getChild(int index) Gets the child at the given index.
ExprNode.Kind	getKind() Gets this node's kind (corresponding to this node's specific type).
ExprNode	getRoot()
String	toSourceString() Builds a Soy source string that could be the source for this node.
static com.google.common.collect.ImmutableList<ExprNode>	unwrap(Iterable<ExprRootNode> exprs)
static com.google.common.collect.ImmutableList<ExprRootNode>	wrap(Iterable<? extends ExprNode> exprs)

Methods inherited from class com.google.template.soy.exprtree.AbstractParentExprNode

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, clearChildren, getChildIndex, getChildren, getType, numChildren, removeChild, removeChild, replaceChild, replaceChild, setType

Methods inherited from class com.google.template.soy.exprtree.AbstractExprNode

getParent, getSourceLocation

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

couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.exprtree.ExprNode

getParent

Methods inherited from interface com.google.template.soy.basetree.Node

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

ExprRootNode

public ExprRootNode(ExprNode child)

Creates a new instance with the given node as the child.

Parameters:

child - The child to add to the new node.

Method Detail

unwrap

public static com.google.common.collect.ImmutableList<ExprNode> unwrap(Iterable<ExprRootNode> exprs)

wrap

public static com.google.common.collect.ImmutableList<ExprRootNode> wrap(Iterable<? extends ExprNode> exprs)

getKind

public ExprNode.Kind getKind()

Description copied from interface: ExprNode

Gets this node's kind (corresponding to this node's specific type).

Returns:

This node's kind (corresponding to this node's specific type).

getRoot

public ExprNode getRoot()

getChild

public ExprNode getChild(int index)

Description copied from interface: ParentNode

Gets the child at the given index.

Specified by:

getChild in interface ParentNode<ExprNode>

Overrides:

getChild in class AbstractParentExprNode

Parameters:

index - The index of the child to get.

Returns:

The child at the given index.

toSourceString

public String toSourceString()

Description copied from interface: Node

Builds a Soy source string that could be the source for this node. Note that this is not the actual original source string, but a (SORT OF, NOT QUITE) canonical equivalent.

Note: Some nodes do not have a direct mapping to Soy source (such as nodes created during some optimization passes). Thus this method may not always be supported.

Returns:

A Soy string that could be the source for this node.

copy

public ExprRootNode copy(CopyState copyState)

Description copied from interface: ExprNode

See Node.copy(CopyState) for a description of the copy contract.

Returns:

A clone of this code.