com.google.template.soy.soytree.defn

Class HeaderParam

java.lang.Object

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

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

type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HeaderParam	clone()
HeaderParam	cloneEssential()
TemplateParam.DeclLoc	declLoc() Returns the location of the parameter declaration.
boolean	equals(Object o)
int	hashCode()
String	typeSrc() Returns the original source string for the param type.

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

abstractEquals, abstractHashCode, desc, isInjected, isRequired, kind

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

localVariableIndex, name, setLocalVariableIndex, type

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderParam

public HeaderParam(String name,
                   String typeSrc,
                   SoyType type,
                   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

typeSrc

public String typeSrc()

Returns the original source string for the param type. May be null if unavailable.

cloneEssential

public HeaderParam cloneEssential()

Specified by:

cloneEssential in class TemplateParam

equals

public boolean equals(Object o)

Specified by:

equals in class TemplateParam

hashCode

public int hashCode()

Specified by:

hashCode in class TemplateParam

clone

public HeaderParam clone()

Specified by:

clone in class AbstractVarDefn