com.google.template.soy.soytree

Class ForeachNonemptyNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractParentSoyNode<SoyNode.StandaloneNode>

com.google.template.soy.soytree.AbstractBlockNode

com.google.template.soy.soytree.ForeachNonemptyNode

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockNode, SoyNode.ConditionalBlockNode, SoyNode.LocalVarBlockNode, SoyNode.LocalVarNode, SoyNode.LoopNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>

public final class ForeachNonemptyNode
extends AbstractBlockNode
implements SoyNode.ConditionalBlockNode, SoyNode.LoopNode, SoyNode.LocalVarBlockNode

Node representing the loop portion of a 'foreach' statement.

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

Field Summary

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

SPACES

Constructor Summary

Constructors

Constructor and Description
ForeachNonemptyNode(int id, String varName)

Method Summary

Modifier and Type	Method and Description
ForeachNonemptyNode	clone() Copies this node.
ExprRootNode<?>	getExpr() Returns the expression we're iterating over.
String	getExprText() Returns the text of the expression we're iterating over.
int	getForeachNodeId()
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
ForeachNode	getParent() Gets this node's parent.
LoopVar	getVar()
String	getVarName() Returns the name of this node's local variable (without the preceding '$').
String	toSourceString() Builds a Soy source string that could be the source for this node.

Methods inherited from class com.google.template.soy.soytree.AbstractParentSoyNode

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

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNode

getId, getSourceLocation, setId, setSourceLocation, toString

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent

Methods inherited from class java.lang.Object

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

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

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

Constructor Detail

ForeachNonemptyNode

public ForeachNonemptyNode(int id,
                           String varName)

Parameters:

id - The id for this node.

varName - The variable name of the loop index variable

Method Detail

getKind

public SoyNode.Kind getKind()

Description copied from interface: SoyNode

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

Specified by:

getKind in interface SoyNode

getForeachNodeId

public int getForeachNodeId()

getVar

public final LoopVar getVar()

getVarName

public final String getVarName()

Description copied from interface: SoyNode.LocalVarNode

Returns the name of this node's local variable (without the preceding '$').

Specified by:

getVarName in interface SoyNode.LocalVarNode

getExprText

public String getExprText()

Returns the text of the expression we're iterating over.

getExpr

public ExprRootNode<?> getExpr()

Returns the expression we're iterating over.

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.

Specified by:

toSourceString in interface Node

Returns:

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

getParent

public ForeachNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

clone

public ForeachNonemptyNode 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 SoyNode

Specified by:

clone in class AbstractSoyNode

Returns:

A clone of this code.