com.google.template.soy

Class SoyFileSet

java.lang.Object

com.google.template.soy.SoyFileSet

public final class SoyFileSet
extends Object

Represents a complete set of Soy files for compilation as one bundle. The files may depend on each other but should not have dependencies outside of the set.

Note: Soy file (or resource) contents must be encoded in UTF-8.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyFileSet.Builder Builder for a SoyFileSet.

Method Summary

Modifier and Type	Method and Description
static SoyFileSet.Builder	builder() Creates a builder with the standard set of Soy directives, functions, and types.
SoyTofu	compileToJavaObj() Deprecated. Use compileToTofu().
List<String>	compileToJsSrc(SoyJsSrcOptions jsSrcOptions, SoyMsgBundle msgBundle) Compiles this Soy file set into JS source code files and returns these JS files as a list of strings, one per file.
SoyTofu	compileToTofu() Compiles this Soy file set into a Java object (type SoyTofu) capable of rendering the compiled templates.
SoyTofu	compileToTofu(SoyTofuOptions tofuOptions) Compiles this Soy file set into a Java object (type SoyTofu) capable of rendering the compiled templates.
SoyMsgBundle	extractMsgs() Extracts all messages from this Soy file set into a SoyMsgBundle (which can then be turned into an extracted messages file with the help of a SoyMsgBundleHandler).
TemplateRegistry	generateTemplateRegistry() Parses the templates in this file set and generates a template registry.
SoyMsgBundle	pruneTranslatedMsgs(SoyMsgBundle origTransMsgBundle) Prunes messages from a given message bundle, keeping only messages used in this Soy file set.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SoyFileSet.Builder builder()

Creates a builder with the standard set of Soy directives, functions, and types.

If you need additional directives, functions, or types, create the Builder instance using Guice. If your project doesn't otherwise use Guice, you can just use Guice.createInjector with only the modules you need, similar to the implementation of this method.

generateTemplateRegistry

public TemplateRegistry generateTemplateRegistry()

Parses the templates in this file set and generates a template registry. Useful for tools that want to index Soy files without performing further compilation.

Throws:

SoySyntaxException - if the templates in this file set cannot be parsed according to SyntaxVersion.V2_0.

extractMsgs

public SoyMsgBundle extractMsgs()
                         throws SoySyntaxException

Extracts all messages from this Soy file set into a SoyMsgBundle (which can then be turned into an extracted messages file with the help of a SoyMsgBundleHandler).

Returns:

A SoyMsgBundle containing all the extracted messages (locale "en").

Throws:

SoySyntaxException - If a syntax error is found.

pruneTranslatedMsgs

public SoyMsgBundle pruneTranslatedMsgs(SoyMsgBundle origTransMsgBundle)
                                 throws SoySyntaxException

Prunes messages from a given message bundle, keeping only messages used in this Soy file set.

Important: Do not use directly. This is subject to change and your code will break.

Note: This method memoizes intermediate results to improve efficiency in the case that it is called multiple times (which is a common case). Thus, this method will not work correctly if the underlying Soy files are modified between calls to this method.

Parameters:

origTransMsgBundle - The message bundle to prune.

Returns:

The pruned message bundle. TODO(brndn): Instead of throwing, should return a structure with a list of errors that callers can inspect.

Throws:

SoySyntaxException

compileToTofu

public SoyTofu compileToTofu()
                      throws SoySyntaxException

Compiles this Soy file set into a Java object (type SoyTofu) capable of rendering the compiled templates. The resulting SoyTofu does not cache intermediate results after substitutions from the SoyMsgBundle and the SoyCssRenamingMap.

Returns:

The resulting SoyTofu object.

Throws:

SoySyntaxException - If a syntax error is found.

See Also:

compileToTofu(com.google.template.soy.tofu.SoyTofuOptions)

compileToTofu

public SoyTofu compileToTofu(SoyTofuOptions tofuOptions)
                      throws SoySyntaxException

Compiles this Soy file set into a Java object (type SoyTofu) capable of rendering the compiled templates.

Parameters:

tofuOptions - The compilation options for the Tofu backend.

Returns:

The resulting SoyTofu object.

Throws:

SoySyntaxException - If a syntax error is found. TODO(brndn): Instead of throwing, should return a structure with a list of errors that callers can inspect.

compileToJavaObj

@Deprecated
public SoyTofu compileToJavaObj()
                                     throws SoySyntaxException

Deprecated. Use compileToTofu().

Compiles this Soy file set into a Java object (type SoyTofu) capable of rendering the compiled templates. The resulting SoyTofu does not cache intermediate results after substitutions from the SoyMsgBundle and the SoyCssRenamingMap.

Returns:

The result of compiling this Soy file set into a Java object.

Throws:

SoySyntaxException - If a syntax error is found.

See Also:

compileToTofu()

compileToJsSrc

public List<String> compileToJsSrc(SoyJsSrcOptions jsSrcOptions,
                                   @Nullable
                                   SoyMsgBundle msgBundle)
                            throws SoySyntaxException

Compiles this Soy file set into JS source code files and returns these JS files as a list of strings, one per file.

Parameters:

jsSrcOptions - The compilation options for the JS Src output target.

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

Returns:

A list of strings where each string represents the JS source code that belongs in one JS file. The generated JS files correspond one-to-one to the original Soy source files.

Throws:

SoySyntaxException - If a syntax error is found. TODO(brndn): Instead of throwing, should return a structure with a list of errors that callers can inspect.