VarNode (Closure Templates)

java.lang.Object
- com.google.template.soy.basetree.AbstractNode
- - com.google.template.soy.exprtree.AbstractExprNode
  - - com.google.template.soy.exprtree.VarNode

All Implemented Interfaces:

Node, ExprNode
```
public final class VarNode
extends AbstractExprNode
```
Node representing a variable.
Important: Do not use outside of Soy code (treat as superpackage-private).
Important: This type of node never appears in expression parse trees. It is only created if you explicitly parse an input as a variable using ExpressionParser.parseVariable().

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 VarNode ERROR
- Fields inherited from class com.google.template.soy.basetree.AbstractNode
  SPACES

Fields
Modifier and Type	Field and Description
`static VarNode`	`ERROR`

Constructor Summary

Constructors
Constructor and Description

VarNode(String name, SourceLocation sourceLocation)

Constructors
Constructor and Description
`VarNode(String name, SourceLocation sourceLocation)`

Method Summary

Methods
Modifier and Type	Method and Description
`VarNode`	`copy(CopyState copyState)` See `Node.copy(CopyState)` for a description of the copy contract.
`ExprNode.Kind`	`getKind()` Gets this node's kind (corresponding to this node's specific type).
`String`	`getName()` Returns the variable name (without the dollar sign).
`SoyType`	`getType()` Gets the data type of this node.
`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

- Field Detail
  - ERROR
```
public static final VarNode ERROR
```
- Constructor Detail
  - VarNode
```
public VarNode(String name,
       SourceLocation sourceLocation)
```
    Parameters:
    name - The variable name (without the dollar sign).
    sourceLocation - The node's source location.
- 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 variable name (without the dollar sign).
  - 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 VarNode 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.

Class VarNode

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ERROR

Constructor Detail

VarNode

Method Detail

getKind

getType

getName

toSourceString

copy