com.google.template.soy.soytree.defn

Class TemplateParam

java.lang.Object

com.google.template.soy.soytree.defn.AbstractVarDefn

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

All Implemented Interfaces:

VarDefn

Direct Known Subclasses:

HeaderParam, SoyDocParam

@Immutable
public abstract class TemplateParam
extends AbstractVarDefn

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 inherited from class com.google.template.soy.soytree.defn.AbstractVarDefn

type

Constructor Summary

Constructors

Constructor and Description
TemplateParam(String name, SoyType type, boolean isRequired, boolean isInjected, String desc)

Method Summary

Modifier and Type	Method and Description
protected boolean	abstractEquals(Object o)
protected int	abstractHashCode()
abstract TemplateParam	cloneEssential()
abstract TemplateParam.DeclLoc	declLoc() Returns the location of the parameter declaration.
String	desc()
abstract boolean	equals(Object o)
abstract 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).

Methods inherited from class com.google.template.soy.soytree.defn.AbstractVarDefn

clone, localVariableIndex, name, setLocalVariableIndex, type

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateParam

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

Method Detail

kind

public VarDefn.Kind kind()

Description copied from interface: VarDefn

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

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

cloneEssential

public abstract TemplateParam cloneEssential()

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

abstractEquals

protected boolean abstractEquals(Object o)

abstractHashCode

protected int abstractHashCode()