TemplateNode (Closure Templates)

java.lang.Object
- com.google.template.soy.basetree.AbstractNode
- - com.google.template.soy.soytree.AbstractSoyNode
  - - com.google.template.soy.soytree.TemplateNode

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>, SoyNode.RenderUnitNode

Direct Known Subclasses:

TemplateBasicNode, TemplateDelegateNode
```
public abstract class TemplateNode
extends AbstractSoyNode
implements SoyNode.RenderUnitNode
```
Node representing a template.
Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TemplateNode.Priority` Priority for delegate templates.
`static class`	`TemplateNode.SoyFileHeaderInfo` Info from the containing Soy file's `delpackage` and `namespace` declarations.

Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode
SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode, SoyNode.Kind, SoyNode.LocalVarBlockNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Constructor Summary

Constructors
Modifier Constructor and Description

protected TemplateNode(TemplateNode orig, CopyState copyState)
Copy constructor.

Constructors
Modifier	Constructor and Description
`protected`	`TemplateNode(TemplateNode orig, CopyState copyState)` Copy constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(int index, N child)` Adds the given child at the given index (shifting existing children if necessary).
`void`	`addChild(N child)` Adds the given child.
`void`	`addChildren(int index, List<? extends N> children)` Adds the given children at the given index (shifting existing children if necessary).
`void`	`addChildren(List<? extends N> children)` Adds the given children.
`void`	`appendSourceStringForChildren(StringBuilder sb)` Appends the source strings for all the children to the given StringBuilder.
`void`	`clearChildren()` Clears the list of children.
`void`	`clearSoyDocStrings()` Clears the SoyDoc text, description, and param descriptions.
`StackTraceElement`	`createStackTraceElement(SourceLocation srcLocation)` Construct a StackTraceElement that will point to the given source location of the current template.
`Iterable<TemplateParam>`	`getAllParams()` Returns all params from template header or SoyDoc, both regular and injected.
`AutoescapeMode`	`getAutoescapeMode()` Returns the mode of autoescaping.
`N`	`getChild(int index)` Gets the child at the given index.
`int`	`getChildIndex(Node child)` Finds the index of the given child.
`List<N>`	`getChildren()` Gets the list of children.
`String`	`getCommandName()` Returns the Soy command name.
`String`	`getCommandText()` Returns the command text (may be the empty string).
`SanitizedContentKind`	`getContentKind()` Returns the content kind for strict autoescaping.
`String`	`getCssBaseNamespace()` Returns the base CSS namespace for resolving package-relative class names.
`String`	`getDelPackageName()` Returns the name of the containing delegate package, or null if none.
`com.google.common.collect.ImmutableList<TemplateParam>`	`getInjectedParams()` Returns the injected params from template header.
`int`	`getMaxLocalVariableTableSize()`
`com.google.common.collect.ImmutableList<TemplateParam>`	`getParams()` Returns the params from template header or SoyDoc.
`SoyFileNode`	`getParent()` Gets this node's parent.
`String`	`getPartialTemplateName()` Returns this template's partial name.
`com.google.common.collect.ImmutableList<String>`	`getRequiredCssNamespaces()` Returns required CSS namespaces.
`String`	`getSoyDoc()` Returns the SoyDoc, or null.
`String`	`getSoyDocDesc()` Returns the description portion of the SoyDoc (before @param tags), or null.
`TemplateNode.SoyFileHeaderInfo`	`getSoyFileHeaderInfo()` Returns info from the containing Soy file's header declarations.
`protected String`	`getTagString()`
`protected String`	`getTagString(boolean selfEnding)`
`String`	`getTemplateName()` Returns this template's name.
`abstract String`	`getTemplateNameForUserMsgs()` Returns a template name suitable for display in user msgs.
`Visibility`	`getVisibility()` Returns the visibility of this template.
`boolean`	`isStrictHtml()` Returns if this template is in strict html mode.
`int`	`numChildren()` Gets the number of children.
`void`	`removeChild(int index)` Removes the child at the given index.
`void`	`removeChild(N child)` Removes the given child.
`void`	`replaceChild(int index, N newChild)` Replaces the child at the given index with the given new child.
`void`	`replaceChild(N currChild, N newChild)` Replaces the given current child with the given new child.
`void`	`setMaxLocalVariableTableSize(int size)`
`String`	`toSourceString()` Builds a Soy source string that could be the source for this node.

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNode
getId, getSourceLocation, setId, toString

Methods inherited from class com.google.template.soy.basetree.AbstractNode
couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.soytree.SoyNode.CommandNode
getCommandName

Methods inherited from interface com.google.template.soy.soytree.SoyNode
copy, getId, getKind, setId

Methods inherited from interface com.google.template.soy.basetree.ParentNode
addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from interface com.google.template.soy.basetree.Node
couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

- Constructor Detail
  - TemplateNode
```
protected TemplateNode(TemplateNode orig,
                       CopyState copyState)
```
    Copy constructor.
    
    Parameters:
    
    orig - The node to copy.
- Method Detail
  - getSoyFileHeaderInfo
```
public TemplateNode.SoyFileHeaderInfo getSoyFileHeaderInfo()
```
    Returns info from the containing Soy file's header declarations.
  - getDelPackageName
```
public String getDelPackageName()
```
    Returns the name of the containing delegate package, or null if none.
  - getTemplateNameForUserMsgs
```
public abstract String getTemplateNameForUserMsgs()
```
    Returns a template name suitable for display in user msgs.
  - getTemplateName
```
public String getTemplateName()
```
    Returns this template's name.
  - getPartialTemplateName
```
@Nullable
public String getPartialTemplateName()
```
    Returns this template's partial name. Only applicable for V2 (null for V1).
  - getVisibility
```
public Visibility getVisibility()
```
    Returns the visibility of this template.
  - getAutoescapeMode
```
public AutoescapeMode getAutoescapeMode()
```
    Returns the mode of autoescaping.
  - isStrictHtml
```
public boolean isStrictHtml()
```
    Returns if this template is in strict html mode.
  - getContentKind
```
@Nullable
public SanitizedContentKind getContentKind()
```
    Returns the content kind for strict autoescaping. Nonnull iff autoescapeMode is strict.
    
    Specified by:
    
    getContentKind in interface SoyNode.RenderUnitNode
  - getRequiredCssNamespaces
```
public com.google.common.collect.ImmutableList<String> getRequiredCssNamespaces()
```
    Returns required CSS namespaces.
    CSS "namespaces" are monikers associated with CSS files that by convention, dot-separated lowercase names. They don't correspond to CSS features, but are processed by external tools that impose dependencies from templates to CSS.
  - getCssBaseNamespace
```
public String getCssBaseNamespace()
```
    Returns the base CSS namespace for resolving package-relative class names. Package relative class names are ones beginning with a percent (%). The compiler will replace the percent sign with the name of the current CSS package converted to camel-case form.
    Packages are defined using dotted-id syntax (foo.bar), which is identical to the syntax for required CSS namespaces. If no base CSS namespace is defined, it will use the first required css namespace, if any are present. If there is no base CSS name, and no required css namespaces, then use of package-relative class names will be reported as an error.
  - setMaxLocalVariableTableSize
```
public void setMaxLocalVariableTableSize(int size)
```
  - getMaxLocalVariableTableSize
```
public int getMaxLocalVariableTableSize()
```
  - clearSoyDocStrings
```
public void clearSoyDocStrings()
```
    Clears the SoyDoc text, description, and param descriptions.
  - getSoyDoc
```
@Nullable
public String getSoyDoc()
```
    Returns the SoyDoc, or null.
  - getSoyDocDesc
```
@Nullable
public String getSoyDocDesc()
```
    Returns the description portion of the SoyDoc (before @param tags), or null.
  - getParams
```
public com.google.common.collect.ImmutableList<TemplateParam> getParams()
```
    Returns the params from template header or SoyDoc.
  - getInjectedParams
```
public com.google.common.collect.ImmutableList<TemplateParam> getInjectedParams()
```
    Returns the injected params from template header.
  - getAllParams
```
@Nullable
public Iterable<TemplateParam> getAllParams()
```
    Returns all params from template header or SoyDoc, both regular and injected.
  - getParent
```
public SoyFileNode getParent()
```
    Description copied from interface: Node
    
    Gets this node's parent.
    
    Specified by:
    
    getParent in interface Node
    
    Specified by:
    
    getParent in interface SoyNode
    
    Overrides:
    
    getParent in class AbstractSoyNode
    
    Returns:
    
    This node's parent.
  - getCommandText
```
public String getCommandText()
```
    Description copied from interface: SoyNode.CommandNode
    
    Returns the command text (may be the empty string).
    
    Specified by:
    
    getCommandText in interface SoyNode.CommandNode
  - toSourceString
```
public String toSourceString()
```
    Description copied from interface: Node
    
    Builds a Soy source string that could be the source for this node. Note that this is not the actual original source string, but a (SORT OF, NOT QUITE) canonical equivalent.
    Note: Some nodes do not have a direct mapping to Soy source (such as nodes created during some optimization passes). Thus this method may not always be supported.
    
    Specified by:
    
    toSourceString in interface Node
    
    Returns:
    
    A Soy string that could be the source for this node.
  - createStackTraceElement
```
public StackTraceElement createStackTraceElement(SourceLocation srcLocation)
```
    Construct a StackTraceElement that will point to the given source location of the current template.
  - numChildren
```
public int numChildren()
```
    Description copied from interface: ParentNode
    
    Gets the number of children.
    
    Specified by:
    
    numChildren in interface ParentNode<N extends SoyNode>
    
    Returns:
    
    The number of children.
  - getChild
```
public N getChild(int index)
```
    Description copied from interface: ParentNode
    
    Gets the child at the given index.
    
    Specified by:
    
    getChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    index - The index of the child to get.
    
    Returns:
    
    The child at the given index.
  - getChildIndex
```
public int getChildIndex(Node child)
```
    Description copied from interface: ParentNode
    
    Finds the index of the given child.
    
    Specified by:
    
    getChildIndex in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    child - The child to find the index of.
    
    Returns:
    
    The index of the given child, or -1 if the given child is not a child of this node.
  - getChildren
```
public List<N> getChildren()
```
    Description copied from interface: ParentNode
    
    Gets the list of children.
    Note: The returned list may not be a copy. Please do not modify the list directly. Instead, use the other methods in this class that are intended for modifying children. Also, if you're iterating over the children list as you're modifying it, then you should first make a copy of the children list to iterate over, in order to avoid ConcurrentModificationException.
    
    Specified by:
    
    getChildren in interface ParentNode<N extends SoyNode>
    
    Returns:
    
    The list of children.
  - addChild
```
public void addChild(N child)
```
    Description copied from interface: ParentNode
    
    Adds the given child.
    
    Specified by:
    
    addChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    child - The child to add.
  - addChild
```
public void addChild(int index,
                     N child)
```
    Description copied from interface: ParentNode
    
    Adds the given child at the given index (shifting existing children if necessary).
    
    Specified by:
    
    addChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    index - The index to add the child at.
    
    child - The child to add.
  - removeChild
```
public void removeChild(int index)
```
    Description copied from interface: ParentNode
    
    Removes the child at the given index.
    
    Specified by:
    
    removeChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    index - The index of the child to remove.
  - removeChild
```
public void removeChild(N child)
```
    Description copied from interface: ParentNode
    
    Removes the given child.
    
    Specified by:
    
    removeChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    child - The child to remove.
  - replaceChild
```
public void replaceChild(int index,
                         N newChild)
```
    Description copied from interface: ParentNode
    
    Replaces the child at the given index with the given new child.
    
    Specified by:
    
    replaceChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    index - The index of the child to replace.
    
    newChild - The new child.
  - replaceChild
```
public void replaceChild(N currChild,
                         N newChild)
```
    Description copied from interface: ParentNode
    
    Replaces the given current child with the given new child.
    
    Specified by:
    
    replaceChild in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    currChild - The current child to be replaced.
    
    newChild - The new child.
  - clearChildren
```
public void clearChildren()
```
    Description copied from interface: ParentNode
    
    Clears the list of children.
    
    Specified by:
    
    clearChildren in interface ParentNode<N extends SoyNode>
  - addChildren
```
public void addChildren(List<? extends N> children)
```
    Description copied from interface: ParentNode
    
    Adds the given children.
    
    Specified by:
    
    addChildren in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    children - The children to add.
  - addChildren
```
public void addChildren(int index,
                        List<? extends N> children)
```
    Description copied from interface: ParentNode
    
    Adds the given children at the given index (shifting existing children if necessary).
    
    Specified by:
    
    addChildren in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    index - The index to add the children at.
    
    children - The children to add.
  - appendSourceStringForChildren
```
public void appendSourceStringForChildren(StringBuilder sb)
```
    Description copied from interface: ParentNode
    
    Appends the source strings for all the children to the given StringBuilder.
    
    Specified by:
    
    appendSourceStringForChildren in interface ParentNode<N extends SoyNode>
    
    Parameters:
    
    sb - The StringBuilder to which to append the children's source strings.
  - getCommandName
```
public String getCommandName()
```
    Description copied from interface: SoyNode.CommandNode
    
    Returns the Soy command name.
    
    Specified by:
    
    getCommandName in interface SoyNode.CommandNode
  - getTagString
```
protected String getTagString()
```
    Returns:
    
    A Soy tag string that could be the Soy tag for this node. Note that this may not necessarily be the actual original Soy tag, but a (sort of) canonical equivalent.
  - getTagString
```
protected final String getTagString(boolean selfEnding)
```

Class TemplateNode

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode

Constructor Summary

Method Summary

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

Methods inherited from class com.google.template.soy.basetree.AbstractNode

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.template.soy.soytree.SoyNode.CommandNode

Methods inherited from interface com.google.template.soy.soytree.SoyNode

Methods inherited from interface com.google.template.soy.basetree.ParentNode

Methods inherited from interface com.google.template.soy.basetree.Node

Constructor Detail

TemplateNode

Method Detail

getSoyFileHeaderInfo

getDelPackageName

getTemplateNameForUserMsgs

getTemplateName

getPartialTemplateName

getVisibility

getAutoescapeMode

isStrictHtml

getContentKind

getRequiredCssNamespaces

getCssBaseNamespace

setMaxLocalVariableTableSize

getMaxLocalVariableTableSize

clearSoyDocStrings

getSoyDoc

getSoyDocDesc

getParams

getInjectedParams

getAllParams

getParent

getCommandText

toSourceString

createStackTraceElement

numChildren

getChild

getChildIndex

getChildren

addChild

addChild

removeChild

removeChild

replaceChild

replaceChild

clearChildren

addChildren

addChildren

appendSourceStringForChildren

getCommandName

getTagString

getTagString