com.google.template.soy.soytree.defn

Class LocalVar

java.lang.Object

com.google.template.soy.soytree.defn.LocalVar

All Implemented Interfaces:

VarDefn

Direct Known Subclasses:

LoopVar

public class LocalVar
extends Object

A local variable declaration.

Nested Class Summary

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

VarDefn.Kind

Field Summary

Fields

Modifier and Type	Field and Description
protected SoyType	type The data type of the value.

Constructor Summary

Constructors

Constructor and Description
LocalVar(LocalVar localVar, SoyNode.LocalVarNode declaringNode) Copy constructor for when the declaring node is being cloned.
LocalVar(String name, SoyNode.LocalVarNode declaringNode, SoyType type)

Method Summary

Modifier and Type	Method and Description
SoyNode.LocalVarNode	declaringNode()
boolean	equals(Object obj)
int	hashCode()
boolean	isInjected() Returns true if this is an $ij variable or an @inject param.
VarDefn.Kind	kind() What kind of variable this is (param, local var, etc).
int	localVariableIndex() Returns the index of this variable in the local variable table of the template or -1 for ij params.
String	name() The name of this variable.
void	setLocalVariableIndex(int i) Assigns the index of this variable in the local variable table for its containing template.
void	setType(SoyType type) Setter for the type - this is necessary because sometimes we don't know the variable type until after analysis.
String	toString()
SoyType	type() Returns the data type of this variable.

Methods inherited from class java.lang.Object

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

Field Detail

type

protected SoyType type

The data type of the value.

Constructor Detail

LocalVar

public LocalVar(String name,
                SoyNode.LocalVarNode declaringNode,
                SoyType type)

Parameters:

name - The variable name.

declaringNode - The statement in which this variable is defined.

type - The data type of the variable.

LocalVar

public LocalVar(LocalVar localVar,
                SoyNode.LocalVarNode declaringNode)

Copy constructor for when the declaring node is being cloned.

Method Detail

kind

public VarDefn.Kind kind()

Description copied from interface: VarDefn

What kind of variable this is (param, local var, etc).

setType

public void setType(SoyType type)

Setter for the type - this is necessary because sometimes we don't know the variable type until after analysis.

Parameters:

type - The data type of the variable.

declaringNode

public SoyNode.LocalVarNode declaringNode()

isInjected

public boolean isInjected()

Description copied from interface: VarDefn

Returns true if this is an $ij variable or an @inject param.

name

public String name()

Description copied from interface: VarDefn

The name of this variable.

Specified by:

name in interface VarDefn

type

public SoyType type()

Description copied from interface: VarDefn

Returns the data type of this variable.

Specified by:

type in interface VarDefn

setLocalVariableIndex

public void setLocalVariableIndex(int i)

Description copied from interface: VarDefn

Assigns the index of this variable in the local variable table for its containing template.

Specified by:

setLocalVariableIndex in interface VarDefn

localVariableIndex

public int localVariableIndex()

Description copied from interface: VarDefn

Returns the index of this variable in the local variable table of the template or -1 for ij params.

Specified by:

localVariableIndex in interface VarDefn

toString

public String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object