com.google.template.soy.soytree

Class ForNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractCommandNode

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

com.google.template.soy.soytree.AbstractBlockCommandNode

com.google.template.soy.soytree.ForNode

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode, SoyNode.LocalVarBlockNode, SoyNode.LocalVarNode, SoyNode.LoopNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

public final class ForNode
extends AbstractBlockCommandNode
implements SoyNode.StandaloneNode, SoyNode.StatementNode, SoyNode.ConditionalBlockNode, SoyNode.LoopNode, SoyNode.ExprHolderNode, SoyNode.LocalVarBlockNode

Node representing a 'for' 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
ForNode(int id, String commandText, SourceLocation sourceLocation, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
ForNode	clone() Copies this node.
List<ExprUnion>	getAllExprUnions() Returns the list of expressions in this node.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
SoyNode.BlockNode	getParent() Gets this node's parent.
List<ExprRootNode<?>>	getRangeArgs() Returns the parsed range args.
List<String>	getRangeArgTexts() Returns the texts of the individual range args (sort of canonicalized).
LocalVar	getVar()
String	getVarName() Returns the name of this node's local variable (without the preceding '$').

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

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

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

buildTagStringHelper, buildTagStringHelper, getCommandName, getCommandText, getTagString

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, toSourceString, toTreeString

Methods inherited from interface com.google.template.soy.soytree.SoyNode.CommandNode

getCommandName, getCommandText, getTagString

Constructor Detail

ForNode

public ForNode(int id,
               String commandText,
               SourceLocation sourceLocation,
               ErrorReporter errorReporter)

Parameters:

id - The id for this node.

commandText - The command text.

sourceLocation - The source location for the for node.

errorReporter - For reporting errors.

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

getVar

public final LocalVar 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

getRangeArgTexts

public List<String> getRangeArgTexts()

Returns the texts of the individual range args (sort of canonicalized).

getRangeArgs

public List<ExprRootNode<?>> getRangeArgs()

Returns the parsed range args.

getAllExprUnions

public List<ExprUnion> getAllExprUnions()

Description copied from interface: SoyNode.ExprHolderNode

Returns the list of expressions in this node.

Specified by:

getAllExprUnions in interface SoyNode.ExprHolderNode

getParent

public SoyNode.BlockNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Specified by:

getParent in interface SoyNode.StandaloneNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

clone

public ForNode 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.