com.google.template.soy.tofu.internal

Class BaseTofu

java.lang.Object

com.google.template.soy.tofu.internal.BaseTofu

All Implemented Interfaces:

SoyTofu

public final class BaseTofu
extends Object
implements SoyTofu

Represents a compiled Soy file set. This is the result of compiling Soy to a Java object.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.tofu.SoyTofu

SoyTofu.Renderer

Constructor Summary

Constructors

Constructor and Description
BaseTofu(GuiceSimpleScope apiCallScope, TemplateRegistry templates, com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSortedSet<String>> templateToIjParamsInfoMap)

Method Summary

Modifier and Type	Method and Description
SoyTofu	forNamespace(String namespace) Gets a new SoyTofu instance with a different namespace (or no namespace).
String	getNamespace() Gets the namespace of this SoyTofu object.
com.google.common.collect.ImmutableSortedSet<String>	getUsedIjParamsForTemplate(SoyTemplateInfo templateInfo) Gets the set of injected param keys used by a template (and its transitive callees).
com.google.common.collect.ImmutableSortedSet<String>	getUsedIjParamsForTemplate(String templateName) Gets the set of injected param keys used by a template (and its transitive callees).
SoyTofu.Renderer	newRenderer(SoyTemplateInfo templateInfo) Gets a new Renderer for a template.
SoyTofu.Renderer	newRenderer(String templateName) Gets a new Renderer for a template.
String	render(SoyTemplateInfo templateInfo, SoyRecord data, SoyMsgBundle msgBundle) Deprecated.
String	render(String templateName, Map<String,?> data, SoyMsgBundle msgBundle) Deprecated.
String	render(String templateName, SoyRecord data, SoyMsgBundle msgBundle) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTofu

public BaseTofu(GuiceSimpleScope apiCallScope,
                TemplateRegistry templates,
                com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSortedSet<String>> templateToIjParamsInfoMap)

Parameters:

apiCallScope - The scope object that manages the API call scope.

Method Detail

getNamespace

public String getNamespace()

Gets the namespace of this SoyTofu object. The namespace is simply a convenience allowing newRenderer() to be called with a partial template name (e.g. ".fooTemplate"). Note: The namespace may be null, in which case newRenderer() must be called with the full template name.

For objects of this class, the namespace is always null.

Specified by:

getNamespace in interface SoyTofu

Returns:

The namespace of this SoyTofu object, or null if no namespace.

forNamespace

public SoyTofu forNamespace(@Nullable
                            String namespace)

Description copied from interface: SoyTofu

Gets a new SoyTofu instance with a different namespace (or no namespace). Note: The new SoyTofu instance will still be backed by the same compiled Soy file set.

Specified by:

forNamespace in interface SoyTofu

Parameters:

namespace - The namespace for the new SoyTofu instance, or null for no namespace.

Returns:

A new SoyTofu instance with a different namespace (or no namespace).

newRenderer

public SoyTofu.Renderer newRenderer(SoyTemplateInfo templateInfo)

Description copied from interface: SoyTofu

Gets a new Renderer for a template.

The usage pattern is soyTofu.newRenderer(...).setData(...).setInjectedData(...).setMsgBundle(...).render() where any of the set* parts can be omitted if it's null.

Specified by:

newRenderer in interface SoyTofu

Parameters:

templateInfo - Info for the template to render.

Returns:

A new renderer for the given template.

newRenderer

public SoyTofu.Renderer newRenderer(String templateName)

Description copied from interface: SoyTofu

Gets a new Renderer for a template.

The usage pattern is soyTofu.newRenderer(...).setData(...).setInjectedData(...).setMsgBundle(...).render() where any of the set* parts can be omitted if it's null.

Specified by:

newRenderer in interface SoyTofu

Parameters:

templateName - The name of the template to render. If this SoyTofu instance is not namespaced, then this parameter should be the full name of the template including the namespace. If this SoyTofu instance is namespaced, then this parameter should be a partial name beginning with a dot (e.g. ".fooTemplate").

Returns:

A new renderer for the given template.

getUsedIjParamsForTemplate

public com.google.common.collect.ImmutableSortedSet<String> getUsedIjParamsForTemplate(SoyTemplateInfo templateInfo)

Description copied from interface: SoyTofu

Gets the set of injected param keys used by a template (and its transitive callees).

Note: The SoyTemplateInfo object already has a method getUsedIjParams(). That method should produce the same results as this method, unless the bundle of Soy files included when running the SoyParseInfoGenerator is different from the bundle of Soy files included when creating this SoyTofu object.

Specified by:

getUsedIjParamsForTemplate in interface SoyTofu

Parameters:

templateInfo - Info for the template to get injected params of.

Returns:

The set of injected param keys used by the given template.

getUsedIjParamsForTemplate

public com.google.common.collect.ImmutableSortedSet<String> getUsedIjParamsForTemplate(String templateName)

Description copied from interface: SoyTofu

Gets the set of injected param keys used by a template (and its transitive callees).

Specified by:

getUsedIjParamsForTemplate in interface SoyTofu

Parameters:

templateName - The name of the template to get injected params of.

Returns:

The set of injected param keys used by the given template.

render

@Deprecated
public String render(SoyTemplateInfo templateInfo,
                                 @Nullable
                                 SoyRecord data,
                                 @Nullable
                                 SoyMsgBundle msgBundle)

Deprecated.

Description copied from interface: SoyTofu

Renders a template.

Specified by:

render in interface SoyTofu

Parameters:

templateInfo - Info for the template to render.

data - The data to call the template with. Can be null if the template has no parameters.

msgBundle - The bundle of translated messages, or null to use the messages from the Soy source.

Returns:

The rendered text.

render

@Deprecated
public String render(String templateName,
                                 @Nullable
                                 Map<String,?> data,
                                 @Nullable
                                 SoyMsgBundle msgBundle)

Deprecated.

Description copied from interface: SoyTofu

Renders a template.

Note: If you call this method instead of SoyTofu.render(String, SoyRecord, SoyMsgBundle), your template data will be converted to a SoyRecord object on each call. This may not be a big deal if you only need to use the data object once. But if you need to reuse the same data object for multiple calls, it's more efficient to build your own SoyRecord object and reuse it with SoyTofu.render(String, SoyRecord, SoyMsgBundle).

Specified by:

render in interface SoyTofu

Parameters:

templateName - The name of the template to render. If this SoyTofu instance is namespaced, then this parameter should be a partial name beginning with a dot (e.g. ".fooTemplate").

data - The data to call the template with. Can be null if the template has no parameters.

msgBundle - The bundle of translated messages, or null to use the messages from the Soy source.

Returns:

The rendered text.

render

@Deprecated
public String render(String templateName,
                                 @Nullable
                                 SoyRecord data,
                                 @Nullable
                                 SoyMsgBundle msgBundle)

Deprecated.

Description copied from interface: SoyTofu

Renders a template.

Specified by:

render in interface SoyTofu

Parameters:

templateName - The name of the template to render. If this SoyTofu instance is namespaced, then this parameter should be a partial name beginning with a dot (e.g. ".fooTemplate").

data - The data to call the template with. Can be null if the template has no parameters.

msgBundle - The bundle of translated messages, or null to use the messages from the Soy source.

Returns:

The rendered text.