com.google.template.soy.soytree

Class LetNode

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

All Implemented Interfaces:

Node, SoyNode, SoyNode.CommandNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.StandaloneNode, SoyNode.StatementNode

Direct Known Subclasses:

LetContentNode, LetValueNode

public abstract class LetNode
extends AbstractCommandNode
implements SoyNode.StandaloneNode, SoyNode.StatementNode, SoyNode.LocalVarInlineNode

Abstract node representing a 'let' statement.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LetNode.CommandTextParseResult Return value for parseCommandTextHelper().

Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode

SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode, SoyNode.Kind, SoyNode.LocalVarBlockNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.LoopNode, SoyNode.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Field Summary

Fields

Modifier and Type	Field and Description
static SoyError	INVALID_COMMAND_TEXT
protected LocalVar	var The local variable defined by this node.

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

SPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LetNode(int id, String localVarName, String commandText)
protected	LetNode(LetNode orig) Copy constructor.

Method Summary

Modifier and Type	Method and Description
SoyNode.BlockNode	getParent() Gets this node's parent.
String	getUniqueVarName() Gets a unique version of the local var name (e.g.
LocalVar	getVar() Get the local variable defined by this node.
protected static LetNode.CommandTextParseResult	parseCommandTextHelper(String commandText, ErrorReporter errorReporter, SourceLocation sourceLocation) Helper used by subclass constructors to parse the command text.

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

buildTagStringHelper, buildTagStringHelper, getCommandName, getCommandText, getTagString, toSourceString

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

clone, getId, getSourceLocation, setId, setSourceLocation, toString

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

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

Methods inherited from class java.lang.Object

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

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

getVarName

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

clone, getId, getKind, getSourceLocation, setId, setSourceLocation

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

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

Field Detail

INVALID_COMMAND_TEXT

public static final SoyError INVALID_COMMAND_TEXT

var

protected final LocalVar var

The local variable defined by this node.

Constructor Detail

LetNode

protected LetNode(int id,
                  String localVarName,
                  String commandText)

Parameters:

id - The id for this node.

commandText - The command text.

LetNode

protected LetNode(LetNode orig)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

parseCommandTextHelper

protected static LetNode.CommandTextParseResult parseCommandTextHelper(String commandText,
                                                                       ErrorReporter errorReporter,
                                                                       SourceLocation sourceLocation)

Helper used by subclass constructors to parse the command text.

Parameters:

commandText - The command text.

Returns:

An info object containing the parse results.

getUniqueVarName

public String getUniqueVarName()

Gets a unique version of the local var name (e.g. appending "__soy##" if necessary).

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.

getVar

public final LocalVar getVar()

Get the local variable defined by this node.