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.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 AbstractSoyNode
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/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.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
protected LocalVar	var The local variable defined by this node.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LetNode(int id, SourceLocation sourceLocation, String localVarName)
protected	LetNode(LetNode orig, CopyState copyState) Copy constructor.

Method Summary

Modifier and Type	Method and Description
String	getCommandName() Returns the Soy command name.
String	getCommandText() Returns the command text (may be the empty string).
SoyNode.ParentSoyNode<SoyNode.StandaloneNode>	getParent() Gets this node's parent.
protected String	getTagString()
protected String	getTagString(boolean selfEnding)
String	getUniqueVarName() Gets a unique version of the local var name (e.g.
LocalVar	getVar() Get the local variable defined by this node.
String	getVarName() Return The local variable name (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.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.soytree.SoyNode

copy, getId, getKind, setId

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent, toSourceString

Field Detail

var

protected final LocalVar var

The local variable defined by this node.

Constructor Detail

LetNode

protected LetNode(int id,
                  SourceLocation sourceLocation,
                  String localVarName)

Parameters:

id - The id for this node.

sourceLocation - The node's source location.

localVarName - The let variable name.

LetNode

protected LetNode(LetNode orig,
                  CopyState copyState)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

getVarName

public final String getVarName()

Return The local variable name (without the preceding '$').

Specified by:

getVarName in interface SoyNode.LocalVarNode

getUniqueVarName

public String getUniqueVarName()

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

getParent

public SoyNode.ParentSoyNode<SoyNode.StandaloneNode> 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.

Specified by:

getVar in interface SoyNode.LocalVarNode

getCommandName

public String getCommandName()

Description copied from interface: SoyNode.CommandNode

Returns the Soy command name.

Specified by:

getCommandName in interface SoyNode.CommandNode

getCommandText

public String getCommandText()

Description copied from interface: SoyNode.CommandNode

Returns the command text (may be the empty string).

Specified by:

getCommandText in interface SoyNode.CommandNode

getTagString

protected String getTagString()

Returns:

A Soy tag string that could be the Soy tag for this node. Note that this may not necessarily be the actual original Soy tag, but a (sort of) canonical equivalent.

getTagString

protected final String getTagString(boolean selfEnding)

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.