com.google.template.soy.exprtree

Class VarRefNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.exprtree.AbstractExprNode

com.google.template.soy.exprtree.VarRefNode

All Implemented Interfaces:

Node, ExprNode

public final class VarRefNode
extends AbstractExprNode

Expression representing an unqualified variable name, e.g. $foo, $ij.foo.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.exprtree.ExprNode

ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Constructor Summary

Constructors

Constructor and Description
VarRefNode(String name, SourceLocation sourceLocation, boolean isDollarSignIjParameter, VarDefn defn)

Method Summary

Modifier and Type	Method and Description
VarRefNode	copy(CopyState copyState) See Node.copy(CopyState) for a description of the copy contract.
static VarRefNode	error(SourceLocation location)
VarDefn	getDefnDecl()
ExprNode.Kind	getKind() Gets this node's kind (corresponding to this node's specific type).
String	getName() Returns the name of the variable.
SoyType	getType() Gets the data type of this node.
boolean	isDollarSignIjParameter() Returns Whether this is an $ij parameter reference.
boolean	isInjected() Returns Whether this is an injected parameter reference.
boolean	isLocalVar() Returns whether this is a local variable reference.
Boolean	isPossibleParam() Returns whether this might be a local variable reference.
void	setDefn(VarDefn defn)
void	setSubstituteType(SoyType type) Override the type of the variable when used in this context.
String	toSourceString() Builds a Soy source string that could be the source for this node.

Methods inherited from class com.google.template.soy.exprtree.AbstractExprNode

getParent, getSourceLocation

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

couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

VarRefNode

public VarRefNode(String name,
                  SourceLocation sourceLocation,
                  boolean isDollarSignIjParameter,
                  @Nullable
                  VarDefn defn)

Parameters:

name - The name of the variable.

sourceLocation - The node's source location.

isDollarSignIjParameter - Whether this is an $ij variable.

defn - (optional) The variable declaration for this variable.

Method Detail

error

public static VarRefNode error(SourceLocation location)

getKind

public ExprNode.Kind getKind()

Description copied from interface: ExprNode

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

Returns:

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

getType

public SoyType getType()

Description copied from interface: ExprNode

Gets the data type of this node.

getName

public String getName()

Returns the name of the variable.

isDollarSignIjParameter

public boolean isDollarSignIjParameter()

Returns Whether this is an $ij parameter reference.

You almost certainly don't want to use this method and instead want isInjected().

isInjected

public boolean isInjected()

Returns Whether this is an injected parameter reference.

setDefn

public void setDefn(VarDefn defn)

Parameters:

defn - the varDecl to set

getDefnDecl

public VarDefn getDefnDecl()

Returns:

the varDecl

isLocalVar

public boolean isLocalVar()

Returns whether this is a local variable reference.

isPossibleParam

public Boolean isPossibleParam()

Returns whether this might be a local variable reference. If the variable definition is unknown, then it returns true.

setSubstituteType

public void setSubstituteType(SoyType type)

Override the type of the variable when used in this context. This is set by the flow analysis in the type resolution pass which can infer a stronger type.

Parameters:

type - The overridden type value.

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.

Returns:

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

copy

public VarRefNode copy(CopyState copyState)

Description copied from interface: ExprNode

See Node.copy(CopyState) for a description of the copy contract.

Returns:

A clone of this code.