com.google.template.soy.soytree

Class TemplateNodeBuilder

java.lang.Object

com.google.template.soy.soytree.TemplateNodeBuilder

Direct Known Subclasses:

TemplateBasicNodeBuilder, TemplateDelegateNodeBuilder

public abstract class TemplateNodeBuilder
extends Object

Builder for TemplateNode.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cmdText The command text.
protected static com.google.common.collect.ImmutableSet<String>	COMMON_ATTRIBUTE_NAMES
protected ErrorReporter	errorReporter For reporting parse errors.
protected Integer	id The id for this node.
protected boolean	isMarkedV1
protected com.google.common.collect.ImmutableList<TemplateParam>	params The params from template header and/or SoyDoc.
protected String	soyDoc The full SoyDoc, including the start/end tokens, or null.
protected String	soyDocDesc The description portion of the SoyDoc (before declarations), or null.
protected TemplateNode.SoyFileHeaderInfo	soyFileHeaderInfo Info from the containing Soy file's header declarations.
protected boolean	strictHtmlDisabled
protected SyntaxVersionUpperBound	syntaxVersionBound The lowest known syntax version bound.
protected String	templateNameForUserMsgs A string suitable for display in user msgs as the template name.
protected Visibility	visibility This template's visibility level.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
TemplateNodeBuilder	addParams(Iterable<? extends TemplateParam> newParams) Helper for setSoyDoc() and setHeaderDecls().
abstract TemplateNode	build() Builds the template node.
protected AutoescapeMode	getAutoescapeMode()
SanitizedContentKind	getContentKind()
protected String	getCssBaseNamespace()
protected String	getPartialTemplateName()
protected com.google.common.collect.ImmutableList<String>	getRequiredCssNamespaces()
protected boolean	getStrictHtmlDisabled()
protected String	getTemplateName()
String	getTemplateNameForUserMsgs() Returns a template name suitable for display in user msgs.
protected void	markDeprecatedV1(boolean isDeprecatedV1)
protected void	setAutoescapeInfo(AutoescapeMode autoescapeMode, SanitizedContentKind contentKind, SourceLocation kindLocation)
abstract TemplateNodeBuilder	setCommandValues(Identifier name, List<CommandTagAttribute> attrs) Set the parsed data from the command tag.
protected void	setCommonCommandValues(List<CommandTagAttribute> attrs)
protected void	setCssBaseNamespace(String cssBaseNamespace)
TemplateNodeBuilder	setId(int id) Sets the id for the node to be built.
protected void	setRequiredCssNamespaces(com.google.common.collect.ImmutableList<String> requiredCssNamespaces)
TemplateNodeBuilder	setSourceLocation(SourceLocation location) Sets the source location.
TemplateNodeBuilder	setSoyDoc(String soyDoc, SourceLocation soyDocLocation) Sets the SoyDoc for the node to be built.
protected void	setTemplateNames(String templateName, SourceLocation nameLocation, String partialTemplateName)

Methods inherited from class java.lang.Object

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

Field Detail

soyFileHeaderInfo

protected final TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo

Info from the containing Soy file's header declarations.

errorReporter

protected final ErrorReporter errorReporter

For reporting parse errors.

id

protected Integer id

The id for this node.

syntaxVersionBound

@Nullable
protected SyntaxVersionUpperBound syntaxVersionBound

The lowest known syntax version bound. Value may be adjusted multiple times.

cmdText

protected String cmdText

The command text.

templateNameForUserMsgs

protected String templateNameForUserMsgs

A string suitable for display in user msgs as the template name.

visibility

protected Visibility visibility

This template's visibility level.

soyDoc

protected String soyDoc

The full SoyDoc, including the start/end tokens, or null.

soyDocDesc

protected String soyDocDesc

The description portion of the SoyDoc (before declarations), or null.

params

@Nullable
protected com.google.common.collect.ImmutableList<TemplateParam> params

The params from template header and/or SoyDoc. Null if no decls and no SoyDoc.

isMarkedV1

protected boolean isMarkedV1

strictHtmlDisabled

protected boolean strictHtmlDisabled

COMMON_ATTRIBUTE_NAMES

protected static final com.google.common.collect.ImmutableSet<String> COMMON_ATTRIBUTE_NAMES

Constructor Detail

TemplateNodeBuilder

protected TemplateNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo,
                              ErrorReporter errorReporter)

Parameters:

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

Method Detail

setId

public TemplateNodeBuilder setId(int id)

Sets the id for the node to be built.

Returns:

This builder.

setSourceLocation

public TemplateNodeBuilder setSourceLocation(SourceLocation location)

Sets the source location.

setCommandValues

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

Set the parsed data from the command tag.

Parameters:

name - The template name

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

setCommonCommandValues

protected void setCommonCommandValues(List<CommandTagAttribute> attrs)

getTemplateNameForUserMsgs

public String getTemplateNameForUserMsgs()

Returns a template name suitable for display in user msgs.

Note: This public getter exists because this info is needed by SoyFileParser for error reporting before the TemplateNode is ready to be built.

setSoyDoc

public TemplateNodeBuilder setSoyDoc(String soyDoc,
                                     SourceLocation soyDocLocation)

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

Returns:

This builder.

addParams

public TemplateNodeBuilder addParams(Iterable<? extends TemplateParam> newParams)

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.

Parameters:

params - The params to add.

build

public abstract TemplateNode build()

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

markDeprecatedV1

protected final void markDeprecatedV1(boolean isDeprecatedV1)

setAutoescapeInfo

protected void setAutoescapeInfo(AutoescapeMode autoescapeMode,
                                 @Nullable
                                 SanitizedContentKind contentKind,
                                 @Nullable
                                 SourceLocation kindLocation)

getAutoescapeMode

protected AutoescapeMode getAutoescapeMode()

Returns:

The mode of autoescaping for this template.

getContentKind

@Nullable
public SanitizedContentKind getContentKind()

Returns:

Strict mode context. Nonnull iff autoescapeMode is strict.

getRequiredCssNamespaces

protected com.google.common.collect.ImmutableList<String> getRequiredCssNamespaces()

Returns:

Required CSS namespaces.

setRequiredCssNamespaces

protected void setRequiredCssNamespaces(com.google.common.collect.ImmutableList<String> requiredCssNamespaces)

getCssBaseNamespace

protected String getCssBaseNamespace()

Returns:

Base CSS namespace for package-relative CSS selectors.

setCssBaseNamespace

protected void setCssBaseNamespace(String cssBaseNamespace)

setTemplateNames

protected final void setTemplateNames(String templateName,
                                      SourceLocation nameLocation,
                                      @Nullable
                                      String partialTemplateName)

getStrictHtmlDisabled

protected boolean getStrictHtmlDisabled()

getTemplateName

protected String getTemplateName()

getPartialTemplateName

@Nullable
protected String getPartialTemplateName()