com.google.template.soy.exprtree

Class ExprRootNode<N extends ExprNode>

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<N>

All Implemented Interfaces:

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

public final class ExprRootNode<N extends ExprNode>
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.ConstantNode, ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Field Summary

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

SPACES

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ExprRootNode<N>	clone() Copies this node.
N	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).
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

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

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

getParent

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, 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, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent

Constructor Detail

ExprRootNode

public ExprRootNode(N child)

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

Parameters:

child - The child to add to the new node.

Method Detail

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).

getChild

public N 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) 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.

clone

public ExprRootNode<N> clone()

Description copied from interface: Node

Copies this node. The clone's parent pointer is set to null.

All clone() overrides should follow this contract:

• only leaf classes (in the class hierarchy) should have non-abstract clone methods
• all leaf classes should be final
• all leaf copy constructors should be private
• all clone methods should look exactly like:

  
      {@literal @}Override public T clone() {
        return new T(this);
      }
   

• all non-leaf copy constructors should be protected

NOTE: this means we do not ultimately delegate to Object.clone(), ever.

TODO(lukes): The usecases for a clone method are few and far between. Making the AST nodes immutable (or at least unmodifiable) would be preferable to maintaining our clone() methods.

Specified by:

clone in interface Node

Specified by:

clone in interface ExprNode

Specified by:

clone in class AbstractExprNode

Returns:

A clone of this code.