SoyDocParam (Closure Templates)

java.lang.Object
- com.google.template.soy.soytree.defn.TemplateParam
- - com.google.template.soy.soytree.defn.SoyDocParam

All Implemented Interfaces:

VarDefn
```
@Immutable
public final class SoyDocParam
extends TemplateParam
```
A parameter declared in the template SoyDoc.
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

SoyDocParam(String name, boolean isRequired, String desc)

Constructors
Constructor and Description
`SoyDocParam(String name, boolean isRequired, String desc)`

Method Summary

Methods
Modifier and Type	Method and Description
`SoyDocParam`	`clone()`
`SoyDocParam`	`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.

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

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - type
```
protected SoyType type
```
    The data type of the value.
- Constructor Detail
  - SoyDocParam
```
public SoyDocParam(String name,
           boolean isRequired,
           @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
  - type
```
public SoyType type()
```
    Description copied from interface: VarDefn
    
    Returns the data type of this variable.
    
    Specified by:
    
    type in interface VarDefn
  - copyEssential
```
public SoyDocParam copyEssential()
```
    Specified by:
    
    copyEssential in class TemplateParam
  - clone
```
public SoyDocParam clone()
```
    Overrides:
    
    clone in class Object
  - name
```
public String name()
```
    Description copied from interface: VarDefn
    
    The name of this variable.
    
    Specified by:
    
    name 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 SoyDocParam

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

SoyDocParam

Method Detail

declLoc

type

copyEssential

clone

name

setLocalVariableIndex

localVariableIndex

toString

equals

hashCode