com.google.template.soy.soytree

Class TemplateBasicNodeBuilder

java.lang.Object

com.google.template.soy.soytree.TemplateNodeBuilder

com.google.template.soy.soytree.TemplateBasicNodeBuilder

public class TemplateBasicNodeBuilder
extends TemplateNodeBuilder

Builder for TemplateBasicNode.

Important: Do not use outside of Soy code (treat as superpackage-private).

Field Summary

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

cmdText, COMMON_ATTRIBUTE_NAMES, errorReporter, id, isMarkedV1, params, soyDoc, soyDocDesc, soyFileHeaderInfo, strictHtmlDisabled, syntaxVersionBound, visibility

Constructor Summary

Constructors

Constructor and Description
TemplateBasicNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
TemplateBasicNodeBuilder	addParams(Iterable<? extends TemplateParam> allParams) Helper for setSoyDoc() and setHeaderDecls().
TemplateBasicNode	build() Builds the template node.
TemplateBasicNodeBuilder	setCmdTextInfo(String templateName, String partialTemplateName, Visibility visibility, AutoescapeMode autoescapeMode, SanitizedContentKind 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.
TemplateNodeBuilder	setCommandValues(Identifier templateName, List<CommandTagAttribute> attrs) Set the parsed data from the command tag.
TemplateBasicNodeBuilder	setId(int id) Sets the id for the node to be built.
TemplateBasicNodeBuilder	setSourceLocation(SourceLocation location) Sets the source location.
TemplateBasicNodeBuilder	setSoyDoc(String soyDoc, SourceLocation soyDocLocation) Sets the SoyDoc for the node to be built.

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

getAutoescapeMode, getContentKind, getCssBaseNamespace, getPartialTemplateName, getRequiredCssNamespaces, getStrictHtmlDisabled, getTemplateName, markDeprecatedV1, setAutoescapeInfo, setCommonCommandValues, setCssBaseNamespace, setRequiredCssNamespaces, setTemplateNames

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateBasicNodeBuilder

public TemplateBasicNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo,
                                ErrorReporter errorReporter)

Parameters:

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

Method Detail

setId

public TemplateBasicNodeBuilder 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.

setSourceLocation

public TemplateBasicNodeBuilder setSourceLocation(SourceLocation location)

Description copied from class: TemplateNodeBuilder

Sets the source location.

Overrides:

setSourceLocation in class TemplateNodeBuilder

setCommandValues

public TemplateNodeBuilder setCommandValues(Identifier templateName,
                                            List<CommandTagAttribute> attrs)

Description copied from class: TemplateNodeBuilder

Set the parsed data from the command tag.

Specified by:

setCommandValues in class TemplateNodeBuilder

Parameters:

templateName - The template name

attrs - The attributes that are set on the tag {e.g. kind="strict"}

setCmdTextInfo

public TemplateBasicNodeBuilder setCmdTextInfo(String templateName,
                                               @Nullable
                                               String partialTemplateName,
                                               Visibility visibility,
                                               AutoescapeMode autoescapeMode,
                                               SanitizedContentKind 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:

templateName - This template's name.

partialTemplateName - This template's partial name. Only applicable for V2; null for V1.

visibility - Visibility of this template.

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 TemplateBasicNodeBuilder setSoyDoc(String soyDoc,
                                          SourceLocation soyDocLocation)

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.

addParams

public TemplateBasicNodeBuilder addParams(Iterable<? extends TemplateParam> allParams)

Description copied from class: TemplateNodeBuilder

Helper for setSoyDoc() and setHeaderDecls(). This method is intended to be called at most once for SoyDoc params and at most once for header params.

Overrides:

addParams in class TemplateNodeBuilder

build

public TemplateBasicNode 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