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.ConstantNode, ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Field Summary

Fields

Modifier and Type	Field and Description
static VarRefNode	ERROR

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

SPACES

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
VarRefNode	clone() Copies this node.
boolean	equals(Object other)
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.
int	hashCode()
boolean	isInjected() Returns Whether this is an injected parameter reference.
Boolean	isLocalVar() Returns whether this is a local variable reference.
boolean	isNullSafeInjected() Returns whether this a null-safe access to an injected parameter.
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, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toString, toTreeString

Methods inherited from class java.lang.Object

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

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

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

Field Detail

ERROR

public static final VarRefNode ERROR

Constructor Detail

VarRefNode

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

Parameters:

name - The name of the variable.

sourceLocation - The node's source location.

injected - Whether this is an injected variable.

nullSafeInjected - Whether this a null-safe access to an injected parameter.

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

Method Detail

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.

isInjected

public boolean isInjected()

Returns Whether this is an injected parameter reference.

isNullSafeInjected

public boolean isNullSafeInjected()

Returns whether this a null-safe access to an injected parameter.

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

clone

public VarRefNode 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 ExprNode

Specified by:

clone in class AbstractExprNode

Returns:

A clone of this code.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object