HeaderParam (Closure Templates)

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.

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, String typeSrc, SoyType type, boolean isRequired, boolean isInjected, String desc)`

Method Summary

Methods
Modifier and Type	Method and Description
`HeaderParam`	`copyEssential()`
`TemplateParam.DeclLoc`	`declLoc()` Returns the location of the parameter declaration.
`boolean`	`equals(Object obj)`
`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.
`String`	`toString()`
`SoyType`	`type()` Returns the data type of this variable.
`String`	`typeSrc()` Returns the original source string for the param type.

Methods inherited from class com.google.template.soy.soytree.defn.TemplateParam
desc, isInjected, isRequired, kind

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,
           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.
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class HeaderParam

Nested Class Summary

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

Nested classes/interfaces inherited from interface com.google.template.soy.exprtree.VarDefn

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

type

Constructor Detail

HeaderParam

Method Detail

declLoc

typeSrc

copyEssential

name

type

setLocalVariableIndex

localVariableIndex

toString

equals

hashCode