Method Detail

• getNamespace

  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.

  Returns:

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

• forNamespace

  SoyTofu forNamespace(@Nullable
                     String namespace)

  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.

  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

  SoyTofu.Renderer newRenderer(SoyTemplateInfo templateInfo)

  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.

  Parameters:

  templateInfo - Info for the template to render.

  Returns:

  A new renderer for the given template.

• newRenderer

  SoyTofu.Renderer newRenderer(String templateName)

  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.

  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

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

  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.

  Parameters:

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

  Returns:

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

• getUsedIjParamsForTemplate

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

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

  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
  String render(SoyTemplateInfo templateInfo,
                         @Nullable
                         SoyRecord data,
                         @Nullable
                         SoyMsgBundle msgBundle)

  Deprecated. Use newRenderer(SoyTemplateInfo).
  Renders a template.

  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
  String render(String templateName,
                         @Nullable
                         Map<String,?> data,
                         @Nullable
                         SoyMsgBundle msgBundle)

  Deprecated. Use newRenderer(String).
  Renders a template.

  Note: If you call this method instead of 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 render(String, SoyRecord, SoyMsgBundle).

  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
  String render(String templateName,
                         @Nullable
                         SoyRecord data,
                         @Nullable
                         SoyMsgBundle msgBundle)

  Deprecated. Use newRenderer(String).
  Renders a template.

  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.