com.google.template.soy.soytree.defn

Class SoyDocParam

java.lang.Object

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

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

type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SoyDocParam	clone()
SoyDocParam	cloneEssential()
TemplateParam.DeclLoc	declLoc() Returns the location of the parameter declaration.
boolean	equals(Object o)
int	hashCode()
SoyType	type() Returns the data type of this variable.

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

Methods inherited from class java.lang.Object

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

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

Overrides:

type in class AbstractVarDefn

cloneEssential

public SoyDocParam 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 SoyDocParam clone()

Specified by:

clone in class AbstractVarDefn