com.google.template.soy.soytree

Class TemplateDelegateNodeBuilder

java.lang.Object

com.google.template.soy.soytree.TemplateNodeBuilder

com.google.template.soy.soytree.TemplateDelegateNodeBuilder

public class TemplateDelegateNodeBuilder
extends TemplateNodeBuilder

Builder for TemplateDelegateNode.

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.TemplateNodeBuilder

TemplateNodeBuilder.DeclInfo

Field Summary

Fields inherited from class com.google.template.soy.soytree.TemplateNodeBuilder

cmdText, id, isSoyDocSet, params, soyDoc, soyDocDesc, soyFileHeaderInfo, syntaxVersionBound, templateNameForUserMsgs, visibility

Constructor Summary

Constructors

Constructor and Description
TemplateDelegateNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo, SourceLocation sourceLocation)
TemplateDelegateNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo, SourceLocation sourceLocation, SoyTypeRegistry typeRegistry)

Method Summary

Modifier and Type	Method and Description
TemplateDelegateNode	build() Builds the template node.
TemplateDelegateNodeBuilder	setCmdText(String cmdText) Sets the command text for the node to be built.
TemplateDelegateNodeBuilder	setCmdTextInfo(String delTemplateName, String delTemplateVariant, int delPriority, AutoescapeMode autoescapeMode, SanitizedContent.ContentKind contentKind, com.google.common.collect.ImmutableList<String> requiredCssNamespaces) Alternative to setCmdText() that sets command text info directly as opposed to having it parsed from the command text string.
TemplateDelegateNodeBuilder	setHeaderDecls(List<TemplateNodeBuilder.DeclInfo> declInfos) Sets the template header decls.
TemplateDelegateNodeBuilder	setId(int id) Sets the id for the node to be built.
TemplateDelegateNodeBuilder	setSoyDoc(String soyDoc) Sets the SoyDoc for the node to be built.

Methods inherited from class com.google.template.soy.soytree.TemplateNodeBuilder

getAutoescapeMode, getContentKind, getCssBaseNamespace, getPartialTemplateName, getRequiredCssNamespaces, getTemplateName, getTemplateNameForUserMsgs, setAutoescapeCmdText, setAutoescapeInfo, setCssBaseCmdText, setCssBaseNamespace, setRequireCssCmdText, setRequiredCssNamespaces, setTemplateNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateDelegateNodeBuilder

public TemplateDelegateNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo,
                                   SourceLocation sourceLocation)

Parameters:

soyFileHeaderInfo - Info from the containing Soy file's header declarations.

sourceLocation - The template's source location.

TemplateDelegateNodeBuilder

public TemplateDelegateNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo,
                                   SourceLocation sourceLocation,
                                   SoyTypeRegistry typeRegistry)

Parameters:

soyFileHeaderInfo - Info from the containing Soy file's header declarations.

sourceLocation - The template's source location.

Method Detail

setId

public TemplateDelegateNodeBuilder setId(int id)

Description copied from class: TemplateNodeBuilder

Sets the id for the node to be built.

Overrides:

setId in class TemplateNodeBuilder

Returns:

This builder.

setCmdText

public TemplateDelegateNodeBuilder setCmdText(String cmdText)

Description copied from class: TemplateNodeBuilder

Sets the command text for the node to be built. The command text will be parsed to fill in fields such as templateName and autoescapeMode.

Specified by:

setCmdText in class TemplateNodeBuilder

Returns:

This builder.

setCmdTextInfo

public TemplateDelegateNodeBuilder setCmdTextInfo(String delTemplateName,
                                                  String delTemplateVariant,
                                                  int delPriority,
                                                  AutoescapeMode autoescapeMode,
                                                  SanitizedContent.ContentKind contentKind,
                                                  com.google.common.collect.ImmutableList<String> requiredCssNamespaces)

Alternative to setCmdText() that sets command text info directly as opposed to having it parsed from the command text string. The cmdText field will be set to a canonical string generated from the given info.

Parameters:

delTemplateName - The delegate template name.

delTemplateVariant - The delegate template variant.

delPriority - The delegate priority.

autoescapeMode - The mode of autoescaping for this template.

contentKind - Strict mode context. Nonnull iff autoescapeMode is strict.

requiredCssNamespaces - CSS namespaces required to render the template.

Returns:

This builder.

setSoyDoc

public TemplateDelegateNodeBuilder setSoyDoc(String soyDoc)

Description copied from class: TemplateNodeBuilder

Sets the SoyDoc for the node to be built. The SoyDoc will be parsed to fill in SoyDoc param info.

Overrides:

setSoyDoc in class TemplateNodeBuilder

Returns:

This builder.

setHeaderDecls

public TemplateDelegateNodeBuilder setHeaderDecls(List<TemplateNodeBuilder.DeclInfo> declInfos)

Description copied from class: TemplateNodeBuilder

Sets the template header decls.

Overrides:

setHeaderDecls in class TemplateNodeBuilder

Parameters:

declInfos - DeclInfo objects for the decls found in the template header.

Returns:

This builder.

build

public TemplateDelegateNode build()

Description copied from class: TemplateNodeBuilder

Builds the template node. Will error if not enough info as been set on this builder.

Specified by:

build in class TemplateNodeBuilder