com.google.template.soy.soytree.defn

Class HeaderParam

java.lang.Object

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

com.google.template.soy.soytree.defn.HeaderParam

All Implemented Interfaces:

VarDefn

@Immutable
public final class HeaderParam
extends TemplateParam

A parameter declared in the template header.

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

Nested Class Summary

Nested classes/interfaces inherited from class com.google.template.soy.soytree.defn.TemplateParam

TemplateParam.DeclLoc

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

Method Summary

Modifier and Type	Method and Description
HeaderParam	copyEssential()
TemplateParam.DeclLoc	declLoc() Returns the location of the parameter declaration.
boolean	equals(Object obj)
TypeNode	getTypeNode() Returns the TypeNode.
int	hashCode()
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.

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

desc, isInjected, isRequired, kind, nameLocation, toString

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

HeaderParam

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

Method Detail

declLoc

public TemplateParam.DeclLoc declLoc()

Description copied from class: TemplateParam

Returns the location of the parameter declaration.

Specified by:

declLoc in class TemplateParam

getTypeNode

@Nullable
public TypeNode getTypeNode()

Returns the TypeNode.

May be null if type parsing failed.

copyEssential

public HeaderParam copyEssential()

Specified by:

copyEssential in class TemplateParam

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