ForeachNonemptyNode (Closure Templates)

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.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 AbstractParentSoyNode<SoyNode.StandaloneNode>
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, SourceLocation sourceLocation)

Constructors
Constructor and Description
`ForeachNonemptyNode(int id, String varName, SourceLocation sourceLocation)`

Method Summary

Methods
Modifier and Type	Method and Description
`ForeachNonemptyNode`	`copy(CopyState copyState)` 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()` Returns the variable definition.
`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, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNode
getId, getSourceLocation, setId, toString

Methods inherited from class com.google.template.soy.basetree.AbstractNode
couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.basetree.ParentNode
addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from interface com.google.template.soy.basetree.Node
couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

- Constructor Detail
  - ForeachNonemptyNode
```
public ForeachNonemptyNode(int id,
                   String varName,
                   SourceLocation sourceLocation)
```
    Parameters:
    id - The id for this node.
    varName - The variable name of the loop index variable
    sourceLocation - The node's source location.
- 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()
```
    Description copied from interface: SoyNode.LocalVarNode
    
    Returns the variable definition.
    
    Specified by:
    
    getVar in interface SoyNode.LocalVarNode
  - 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, 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.
    
    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.
  - copy
```
public ForeachNonemptyNode copy(CopyState copyState)
```
    Description copied from interface: SoyNode
    Copies this node. The copy's parent pointer is set to null.
    All copy() 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 copy(CopyState copyState) { return new T(this, copyState); }
    - all non-leaf copy constructors should be protected
    TODO(lukes): The usecases for a copy method are few and far between. Making the AST nodes immutable (or at least unmodifiable) would be preferable to maintaining our copy() methods.
    Don't clone nodes unless you know what you're doing. The Soy AST is not actually a tree (it contains back edges from variables to their definitions), and naively copying nodes can result in pointers into stale ASTs
    The copied nodes will have the same ids as the original nodes. If you need to copy a subtree with new ids assigned to the copied nodes, use SoytreeUtils.cloneWithNewIds(T, com.google.template.soy.base.internal.IdGenerator).
    Specified by:
    
    copy in interface Node
    
    Specified by:
    
    copy in interface SoyNode
    
    Returns:
    A clone of this code.

Class ForeachNonemptyNode

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

ForeachNonemptyNode

Method Detail

getKind

getForeachNodeId

getVar

getVarName

getExprText

getExpr

toSourceString

getParent

copy