com.google.template.soy.soytree.defn

Class TemplateParam

java.lang.Object

com.google.template.soy.soytree.defn.TemplateParam

All Implemented Interfaces:

VarDefn

Direct Known Subclasses:

HeaderParam, SoyDocParam

@Immutable
public abstract class TemplateParam
extends Object

An explicitly declared template parameter.

Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateParam.DeclLoc Enum for the location of the declaration.

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
TemplateParam(String name, SoyType type, boolean isRequired, boolean isInjected, String desc, SourceLocation nameLocation)

Method Summary

Modifier and Type	Method and Description
abstract TemplateParam	copyEssential()
abstract TemplateParam.DeclLoc	declLoc() Returns the location of the parameter declaration.
String	desc()
boolean	equals(Object obj)
int	hashCode()
boolean	isInjected() Returns whether the param is required.
boolean	isRequired() Returns whether the param is required.
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.
SourceLocation	nameLocation() Returns the location of the name.
void	setLocalVariableIndex(int i) Assigns the index of this variable in the local variable table for its containing template.
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

TemplateParam

public TemplateParam(String name,
                     SoyType type,
                     boolean isRequired,
                     boolean isInjected,
                     @Nullable
                     String desc,
                     @Nullable
                     SourceLocation nameLocation)

Method Detail

kind

public VarDefn.Kind kind()

Description copied from interface: VarDefn

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

nameLocation

public SourceLocation nameLocation()

Returns the location of the name.

May be null if this is a param from a copyEssential() call.

declLoc

public abstract TemplateParam.DeclLoc declLoc()

Returns the location of the parameter declaration.

isRequired

public boolean isRequired()

Returns whether the param is required.

isInjected

public boolean isInjected()

Returns whether the param is required.

desc

public String desc()

toString

public String toString()

copyEssential

public abstract TemplateParam copyEssential()

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

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object