com.google.template.soy.exprtree

Interface VarDefn

All Known Implementing Classes:

HeaderParam, InjectedParam, LocalVar, LoopVar, SoyDocParam, TemplateParam, UndeclaredVar

public interface VarDefn

Interface for the definition of a variable, i.e. a value that can be referred to by name. Variables include params, injected params, and local vars. Note that a definition does not always have a corresponding declaration in user code. Some definitions are implicit, e.g. in the case of injected params.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VarDefn.Kind Enum used to distinguish subtypes.

Method Summary

Modifier and Type	Method and Description
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.
SoyType	type() Returns the data type of this variable.

Method Detail

kind

VarDefn.Kind kind()

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

name

String name()

The name of this variable.

type

SoyType type()

Returns the data type of this variable.

isInjected

boolean isInjected()

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

localVariableIndex

int localVariableIndex()

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

setLocalVariableIndex

void setLocalVariableIndex(int i)

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