TemplateBasicNodeBuilder (Closure Templates)

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

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, errorReporter, id, isMarkedV1, isSoyDocSet, params, soyDoc, soyDocDesc, soyFileHeaderInfo, syntaxVersionBound, templateNameForUserMsgs, visibility

Constructor Summary

Constructors
Constructor and Description
`TemplateBasicNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo, SourceLocation sourceLocation, ErrorReporter errorReporter)`
`TemplateBasicNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo, SourceLocation sourceLocation, ErrorReporter errorReporter, SoyTypeRegistry typeRegistry)`

Method Summary

Methods
Modifier and Type	Method and Description
`TemplateBasicNodeBuilder`	`addParams(Iterable<? extends TemplateParam> allParams)` Helper for `setSoyDoc()` and `setHeaderDecls()`.
`TemplateBasicNode`	`build()` Builds the template node.
`TemplateBasicNodeBuilder`	`setCmdText(String cmdText)` Sets the command text for the node to be built.
`TemplateBasicNodeBuilder`	`setCmdTextInfo(String templateName, String partialTemplateName, Visibility visibility, 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.
`TemplateBasicNodeBuilder`	`setHeaderDecls(TemplateNodeBuilder.DeclInfo... declInfos)` Sets the template header decls.
`TemplateBasicNodeBuilder`	`setId(int id)` Sets the id for the node to be built.
`TemplateBasicNodeBuilder`	`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, setHeaderDecls, setRequireCssCmdText, setRequiredCssNamespaces, setTemplateNames, setV1Marker

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,
                        SourceLocation sourceLocation,
                        ErrorReporter errorReporter)
```
    Parameters:
    soyFileHeaderInfo - Info from the containing Soy file's header declarations.
    sourceLocation - The template's source location.
  - TemplateBasicNodeBuilder
```
public TemplateBasicNodeBuilder(TemplateNode.SoyFileHeaderInfo soyFileHeaderInfo,
                        SourceLocation sourceLocation,
                        ErrorReporter errorReporter,
                        SoyTypeRegistry typeRegistry)
```
    Parameters:
    soyFileHeaderInfo - Info from the containing Soy file's header declarations.
    sourceLocation - The template's source location.
    typeRegistry - Type registry used for parsing type expressions.
- 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.
  - setCmdText
```
public TemplateBasicNodeBuilder 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 TemplateBasicNodeBuilder setCmdTextInfo(String templateName,
                                      @Nullable
                                      String partialTemplateName,
                                      Visibility visibility,
                                      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:
    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)
```
    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 TemplateBasicNodeBuilder setHeaderDecls(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.
  - 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
    
    Parameters:
    allParams - The params to add.
  - 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

Class TemplateBasicNodeBuilder

Nested Class Summary

Nested classes/interfaces inherited from class com.google.template.soy.soytree.TemplateNodeBuilder

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

TemplateBasicNodeBuilder

TemplateBasicNodeBuilder

Method Detail

setId

setCmdText

setCmdTextInfo

setSoyDoc

setHeaderDecls

addParams

build