com.google.template.soy.soytree

Class TemplateNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractCommandNode

com.google.template.soy.soytree.AbstractParentCommandNode<SoyNode.StandaloneNode>

com.google.template.soy.soytree.AbstractBlockCommandNode

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 AbstractBlockCommandNode
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.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.LoopNode, SoyNode.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PRIORITY Priorities range from 0 to MAX_PRIORITY, inclusive.

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

SPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateNode(TemplateNode orig) Copy constructor.

Method Summary

Modifier and Type	Method and Description
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, if any, done for this template.
SanitizedContent.ContentKind	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.
List<TemplateParam>	getInjectedParams() Returns the injected params from template header.
int	getMaxLocalVariableTableSize()
List<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.
String	getTemplateName() Returns this template's name.
String	getTemplateNameForUserMsgs() Returns a template name suitable for display in user msgs.
Visibility	getVisibility() Returns the visibility of this template.
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.AbstractParentCommandNode

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild, toTreeString

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

buildTagStringHelper, buildTagStringHelper, getCommandName, getCommandText, getTagString

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

clone, getId, getSourceLocation, setId, setSourceLocation, toString

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent

Methods inherited from class java.lang.Object

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

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

getCommandName, getCommandText, getTagString

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

clone, getId, getKind, getSourceLocation, setId, setSourceLocation

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

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

Field Detail

MAX_PRIORITY

public static final int MAX_PRIORITY

Priorities range from 0 to MAX_PRIORITY, inclusive.

See Also:

Constant Field Values

Constructor Detail

TemplateNode

protected TemplateNode(TemplateNode orig)

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 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, if any, done for this template.

getContentKind

@Nullable
public SanitizedContent.ContentKind 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

public String getSoyDoc()

Returns the SoyDoc, or null.

getSoyDocDesc

public String getSoyDocDesc()

Returns the description portion of the SoyDoc (before @param tags), or null.

getParams

public List<TemplateParam> getParams()

Returns the params from template header or SoyDoc.

getInjectedParams

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

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

Overrides:

toSourceString in class AbstractParentCommandNode<SoyNode.StandaloneNode>

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.