A

add(Object...) - Method in class com.google.template.soy.data.SoyListData

Convenience function to add multiple values in one call.

add(SoyData) - Method in class com.google.template.soy.data.SoyListData

Adds a data value.

add(boolean) - Method in class com.google.template.soy.data.SoyListData

Adds a data value.

add(int) - Method in class com.google.template.soy.data.SoyListData

Adds a data value.

add(double) - Method in class com.google.template.soy.data.SoyListData

Adds a data value.

add(String) - Method in class com.google.template.soy.data.SoyListData

Adds a data value.

add(InputSupplier<? extends Reader>, String) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given an InputSupplier for the file content, as well as the desired file path for messages.

add(File) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given a File.

add(URL, String) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given a resource URL, as well as the desired file path for messages.

add(URL) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given a resource URL.

add(CharSequence, String) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given the file content provided as a string, as well as the desired file path for messages.

addToCache(SoyMsgBundle, SoyCssRenamingMap) - Method in interface com.google.template.soy.tofu.SoyTofu

Primes the cache with the given combination of SoyMsgBundle and SoyCssRenamingMap.

addVolatile(File) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file that the system will watch for changes, given a File.

addVolatileWithKind(File, SoyFileKind) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file that the system will watch for changes, given a File.

addWithKind(InputSupplier<? extends Reader>, SoyFileKind, String) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given an InputSupplier for the file content, as well as the desired file path for messages.

addWithKind(File, SoyFileKind) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given a File.

addWithKind(URL, SoyFileKind, String) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given a resource URL, as well as the desired file path for messages.

addWithKind(URL, SoyFileKind) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given a resource URL.

addWithKind(CharSequence, SoyFileKind, String) - Method in class com.google.template.soy.SoyFileSet.Builder

Adds an input Soy file, given the file content provided as a string, as well as the desired file path for messages.

allowExternalCalls() - Method in class com.google.template.soy.shared.SoyGeneralOptions

Returns whether to allow external calls (calls to undefined templates).

asList() - Method in class com.google.template.soy.data.SoyListData

Important: Please treat this method as superpackage-private.

asMap() - Method in class com.google.template.soy.data.SoyMapData

Important: Please treat this method as superpackage-private.

associateMetaInfo(SourceLocation, String, String) - Method in exception com.google.template.soy.base.SoySyntaxException

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

B

booleanValue() - Method in class com.google.template.soy.data.SoyData

Precondition: Only call this method if you know that this SoyData object is a boolean.

build() - Method in class com.google.template.soy.SoyFileSet.Builder

Builds the new SoyFileSet.

C

clone() - Method in class com.google.template.soy.javasrc.SoyJavaSrcOptions

 

clone() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

 

clone() - Method in class com.google.template.soy.shared.SoyGeneralOptions

 

clone() - Method in class com.google.template.soy.tofu.SoyTofuOptions

 

com.google.template.soy - package com.google.template.soy

Root package with main API entry point and Guice module.

com.google.template.soy.data - package com.google.template.soy.data

Java representation of Soy data types.

com.google.template.soy.javasrc - package com.google.template.soy.javasrc

Java Source backend (experimental).

com.google.template.soy.jssrc - package com.google.template.soy.jssrc

JavaScript Source backend.

com.google.template.soy.msgs - package com.google.template.soy.msgs

Support for message translation (i.e. localization).

com.google.template.soy.parseinfo - package com.google.template.soy.parseinfo

Classes to represent parse info (see SoyParseInfoGenerator).

com.google.template.soy.shared - package com.google.template.soy.shared

Classes shared between multiple backends or between frontend and backend.

com.google.template.soy.tofu - package com.google.template.soy.tofu

Java Object backend (a.k.a. Tofu).

com.google.template.soy.xliffmsgplugin - package com.google.template.soy.xliffmsgplugin

Message plugin for the XLIFF file format.

compileToJavaObj() - Method in class com.google.template.soy.SoyFileSet

Deprecated. Use SoyFileSet.compileToTofu().

compileToJavaObj(boolean) - Method in class com.google.template.soy.SoyFileSet

Deprecated. Use SoyFileSet.compileToTofu(com.google.template.soy.tofu.SoyTofuOptions).

compileToJavaSrc(SoyJavaSrcOptions, SoyMsgBundle) - Method in class com.google.template.soy.SoyFileSet

Warning: The Java Src backend is experimental (incomplete, repetitive, untested, undocumented).

compileToJsSrc(SoyJsSrcOptions, SoyMsgBundle) - Method in class com.google.template.soy.SoyFileSet

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

compileToRuntimes(String, SoyJavaSrcOptions, SoyMsgBundle) - Method in class com.google.template.soy.SoyFileSet

Warning: The Java Src backend is experimental (incomplete, repetitive, untested, undocumented).

compileToTofu() - Method in class com.google.template.soy.SoyFileSet

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

compileToTofu(SoyTofuOptions) - Method in class com.google.template.soy.SoyFileSet

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

configure() - Method in class com.google.template.soy.SoyModule

 

configure() - Method in class com.google.template.soy.xliffmsgplugin.XliffMsgPluginModule

 

createCausedWithMetaInfo(String, Throwable, SourceLocation, String, String) - Static method in exception com.google.template.soy.base.SoySyntaxException

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

createCausedWithoutMetaInfo(String, Throwable) - Static method in exception com.google.template.soy.base.SoySyntaxException

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

createFromExistingData(Object) - Static method in class com.google.template.soy.data.SoyData

Creation function for creating a SoyData object out of any existing primitive, data object, or data structure.

createFromExistingData(String) - Static method in class com.google.template.soy.data.SoyData

A special case of SoyData.createFromExistingData(Object).

createFromFile(File) - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler

Reads an input messages file and creates a SoyMsgBundle.

createFromResource(URL) - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler

Reads an input messages resource and creates a SoyMsgBundle.

createWithMetaInfo(String, SourceLocation, String, String) - Static method in exception com.google.template.soy.base.SoySyntaxException

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

createWithoutMetaInfo(String) - Static method in exception com.google.template.soy.base.SoySyntaxException

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

E

EMPTY - Static variable in interface com.google.template.soy.msgs.SoyMsgBundle

Null object for SoyMsgBundle.

emptyString(SanitizedContent.ContentKind) - Static method in class com.google.template.soy.data.SanitizedContents

Creates an empty string constant.

equals(Object) - Method in class com.google.template.soy.data.SanitizedContent

 

equals(Object) - Method in class com.google.template.soy.data.SoyData

Compares this data object against another for equality in the sense of the operator '==' for Soy expressions.

equals(Object) - Method in class com.google.template.soy.data.SoyListData

 

equals(Object) - Method in class com.google.template.soy.data.SoyMapData

 

extractMsgs() - Method in class com.google.template.soy.SoyFileSet

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

F

floatValue() - Method in class com.google.template.soy.data.SoyData

Precondition: Only call this method if you know that this SoyData object is a float.

forNamespace(String) - Method in interface com.google.template.soy.tofu.SoyTofu

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

fromResource(Class<?>, String, Charset, SanitizedContent.ContentKind) - Static method in class com.google.template.soy.data.SanitizedContents

Loads assumed-safe content from a Java resource.

G

generateCompileTimeGlobalsFile(Map<String, ?>, Appendable) - Static method in class com.google.template.soy.SoyUtils

Generates the text for a compile-time globals file in the format expected by the Soy compiler and appends the generated text to the given Appendable.

generateCompileTimeGlobalsFile(Map<String, ?>, File) - Static method in class com.google.template.soy.SoyUtils

Generates a compile-time globals file in the format expected by the Soy compiler.

generateExtractedMsgsFile(SoyMsgBundle, SoyMsgBundleHandler.OutputFileOptions) - Method in interface com.google.template.soy.msgs.SoyMsgPlugin

Builds the content of an output message file (one that will be sent for translation) from a given message bundle object containing messages extracted from source files.

generateExtractedMsgsFile(SoyMsgBundle, SoyMsgBundleHandler.OutputFileOptions) - Method in class com.google.template.soy.xliffmsgplugin.XliffMsgPlugin

 

generateParseInfo(String, String) - Method in class com.google.template.soy.SoyFileSet

Generates Java classes containing parse info (param names, template names, meta info).

get(int) - Method in class com.google.template.soy.data.SoyListData

Gets the data value at a given index.

get(String) - Method in interface com.google.template.soy.shared.SoyCssRenamingMap

Gets the string that should be substituted for key.

getBidiGlobalDir() - Method in class com.google.template.soy.javasrc.SoyJavaSrcOptions

Returns the static bidi global directionality, 1: ltr, -1: rtl, 0: unspecified.

getBidiGlobalDir() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns the static bidi global directionality, 1: ltr, -1: rtl, 0: unspecified.

getBoolean(int) - Method in class com.google.template.soy.data.SoyListData

Precondition: The specified index contains a boolean.

getCodeStyle() - Method in class com.google.template.soy.javasrc.SoyJavaSrcOptions

Returns the currently set code style.

getCodeStyle() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns the currently set code style.

getCompileTimeGlobals() - Method in class com.google.template.soy.shared.SoyGeneralOptions

Returns the map from compile-time global name to value.

getContent() - Method in class com.google.template.soy.data.SanitizedContent

Returns a string of valid content with kind SanitizedContent.getContentKind().

getContentKind() - Method in class com.google.template.soy.data.SanitizedContent

Returns the kind of content.

getContentKind() - Method in interface com.google.template.soy.data.SanitizedContentOperator

The kind of content consumed and produced.

getCssHandlingScheme() - Method in class com.google.template.soy.shared.SoyGeneralOptions

Returns the scheme for handling css commands.

getCssNames() - Method in class com.google.template.soy.parseinfo.SoyFileInfo

Returns a map from each CSS name appearing in this file to its CssTagsPrefixPresence state.

getCssRenamingHints() - Method in class com.google.template.soy.javasrc.SoyJavaSrcOptions

Returns the CSS renaming map that specifies at compile time how to rename CSS selectors.

getFileName() - Method in class com.google.template.soy.parseinfo.SoyFileInfo

Returns the source Soy file's name.

getFileOrResourceName() - Method in exception com.google.template.soy.msgs.SoyMsgException

Returns the name of the file or resource associated with this error.

getFloat(int) - Method in class com.google.template.soy.data.SoyListData

Precondition: The specified index contains a float.

getInteger(int) - Method in class com.google.template.soy.data.SoyListData

Precondition: The specified index contains an integer.

getKeys() - Method in class com.google.template.soy.data.SoyMapData

Gets the keys in this map data.

getListData(int) - Method in class com.google.template.soy.data.SoyListData

Precondition: The specified index contains a SoyListData object.

getLocaleString() - Method in interface com.google.template.soy.msgs.SoyMsgBundle

Gets the language/locale string of this bundle of messages.

getMapData(int) - Method in class com.google.template.soy.data.SoyListData

Precondition: The specified index contains a SoyMapData object.

getMessage() - Method in exception com.google.template.soy.base.SoySyntaxException

 

getMessage() - Method in exception com.google.template.soy.data.SoyDataException

 

getMessage() - Method in exception com.google.template.soy.msgs.SoyMsgException

 

getMessage() - Method in exception com.google.template.soy.tofu.SoyTofuException

 

getMsg(long) - Method in interface com.google.template.soy.msgs.SoyMsgBundle

Retrieves a message by its unique message id.

getName() - Method in class com.google.template.soy.parseinfo.SoyTemplateInfo

Returns the full template name, e.g.

getNamespace() - Method in class com.google.template.soy.parseinfo.SoyFileInfo

Returns the Soy file's namespace.

getNamespace() - Method in interface com.google.template.soy.tofu.SoyTofu

Gets the namespace of this SoyTofu object.

getNumMsgs() - Method in interface com.google.template.soy.msgs.SoyMsgBundle

Gets the number of messages in this bundle.

getOriginalMessage() - Method in exception com.google.template.soy.base.SoySyntaxException

 

getParams() - Method in class com.google.template.soy.parseinfo.SoyTemplateInfo

Returns a map from each param to whether it's required for this template.

getParamsFromAllTemplates() - Method in class com.google.template.soy.parseinfo.SoyFileInfo

Returns the set of params from all templates in this Soy file.

getPartialName() - Method in class com.google.template.soy.parseinfo.SoyTemplateInfo

Returns the partial template name (starting from the last dot), e.g.

getSingle(String) - Method in class com.google.template.soy.data.SoyListData

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

getSingle(String) - Method in class com.google.template.soy.data.SoyMapData

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

getSourceLocaleString() - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler.OutputFileOptions

Returns the source locale string.

getSourceLocation() - Method in exception com.google.template.soy.base.SoySyntaxException

The source location at which the error occurred or SourceLocation.UNKNOWN.

getSoyMsgBundleForLocale(Locale) - Method in interface com.google.template.soy.msgs.SoyMsgBundleLoader

Gets the Message bundle for a particular locale.

getString(int) - Method in class com.google.template.soy.data.SoyListData

Precondition: The specified index contains a string.

getTargetLocaleString() - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler.OutputFileOptions

Returns the target locale string.

getTemplateName() - Method in exception com.google.template.soy.base.SoySyntaxException

The name of the template in which the problem occurred or null if not known.

getTemplateName() - Method in exception com.google.template.soy.tofu.SoyTofuException

The name of the template in which the problem occurred or null if not known.

getTemplates() - Method in class com.google.template.soy.parseinfo.SoyFileInfo

Returns the list of templates in this Soy file.

getUsedIjParams() - Method in class com.google.template.soy.parseinfo.SoyTemplateInfo

Returns the set of injected params used by this template (or a transitive callee).

getUsedIjParamsForTemplate(SoyTemplateInfo) - Method in interface com.google.template.soy.tofu.SoyTofu

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

getUsedIjParamsForTemplate(String) - Method in interface com.google.template.soy.tofu.SoyTofu

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

getUseGoogIsRtlForBidiGlobalDir() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether to determine the bidi global direction at template runtime by evaluating goog.i18n.bidi.IS_RTL.

googMsgsAreExternal() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether the generated Closure Library message definitions are for external messages (only applicable if shouldGenerateGoogMsgDefs is true).

H

hashCode() - Method in class com.google.template.soy.data.SanitizedContent

 

I

IDENTITY - Static variable in interface com.google.template.soy.shared.SoyCssRenamingMap

A renaming map that maps every name to itself.

integerValue() - Method in class com.google.template.soy.data.SoyData

Precondition: Only call this method if you know that this SoyData object is an integer.

isCaching() - Method in interface com.google.template.soy.tofu.SoyTofu

Gets whether this instance caches intermediate Soy trees after substitutions from the SoyMsgBundle and the SoyCssRenamingMap.

isUsingIjData() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether use of injected data is currently enabled.

iterator() - Method in class com.google.template.soy.data.SoyListData

 

iterator() - Method in interface com.google.template.soy.msgs.SoyMsgBundle

Returns an iterator over all the messages.

L

length() - Method in class com.google.template.soy.data.SoyListData

Gets the length of this list.

M

main(String...) - Static method in class com.google.template.soy.SoyMsgExtractor

Extracts messages from a set of Soy files into an output messages file.

main(String[]) - Static method in class com.google.template.soy.SoyParseInfoGenerator

Generates Java classes containing Soy parse info.

main(String[]) - Static method in class com.google.template.soy.SoyToJavaSrcCompilerExperimental

 

main(String[]) - Static method in class com.google.template.soy.SoyToJsSrcCompiler

Compiles a set of Soy files into corresponding JS source files.

mayHaveIjParamsInExternalCalls() - Method in class com.google.template.soy.parseinfo.SoyTemplateInfo

Returns whether this template may have injected params indirectly used in external basic calls (i.e.

mayHaveIjParamsInExternalDelCalls() - Method in class com.google.template.soy.parseinfo.SoyTemplateInfo

Returns whether this template may have injected params indirectly used in external delegate calls (i.e.

N

newRenderer(String) - Method in interface com.google.template.soy.javasrc.SoyTemplateRuntimes

Create a new template renderer.

newRenderer(SoyTemplateInfo) - Method in interface com.google.template.soy.tofu.SoyTofu

Gets a new Renderer for a template.

newRenderer(String) - Method in interface com.google.template.soy.tofu.SoyTofu

Gets a new Renderer for a template.

numberValue() - Method in class com.google.template.soy.data.SoyData

Precondition: Only call this method if you know that this SoyData object is a number.

O

ordainAsSafe(String, SanitizedContent.ContentKind) - Static method in class com.google.template.soy.data.UnsafeSanitizedContentOrdainer

Faithfully assumes the provided value is "safe" and marks it not to be re-escaped.

P

parseCompileTimeGlobals(InputSupplier<? extends Reader>) - Static method in class com.google.template.soy.SoyUtils

Parses a globals file in the format created by SoyUtils.generateCompileTimeGlobalsFile(java.util.Map, java.lang.Appendable) into a map from global name to primitive value.

parseTranslatedMsgsFile(String) - Method in interface com.google.template.soy.msgs.SoyMsgPlugin

Parses the content of an input message file (one that has been translated) and builds a message bundle object.

parseTranslatedMsgsFile(String) - Method in class com.google.template.soy.xliffmsgplugin.XliffMsgPlugin

 

prependIndexToDataPath(int) - Method in exception com.google.template.soy.data.SoyDataException

Prepends an index to the data path where this error occurred.

prependKeyToDataPath(String) - Method in exception com.google.template.soy.data.SoyDataException

Prepends a key to the data path where this error occurred.

putSingle(String, SoyData) - Method in class com.google.template.soy.data.SoyListData

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

putSingle(String, SoyData) - Method in class com.google.template.soy.data.SoyMapData

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

R

remove(int) - Method in class com.google.template.soy.data.SoyListData

Removes the data value at a given index.

removeSingle(String) - Method in class com.google.template.soy.data.SoyListData

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

removeSingle(String) - Method in class com.google.template.soy.data.SoyMapData

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

render(StringBuilder) - Method in interface com.google.template.soy.javasrc.SoyTemplateRuntime

Applies the template to the given data to append output to the given buffer.

render() - Method in interface com.google.template.soy.javasrc.SoyTemplateRuntime

Applies the template to the given data to produce an output.

render(SoyTemplateInfo, Map<String, ?>, SoyMsgBundle) - Method in interface com.google.template.soy.tofu.SoyTofu

Deprecated. Use SoyTofu.newRenderer(SoyTemplateInfo).

render(SoyTemplateInfo, SoyMapData, SoyMsgBundle) - Method in interface com.google.template.soy.tofu.SoyTofu

Deprecated. Use SoyTofu.newRenderer(SoyTemplateInfo).

render(String, Map<String, ?>, SoyMsgBundle) - Method in interface com.google.template.soy.tofu.SoyTofu

Deprecated. Use SoyTofu.newRenderer(String).

render(String, SoyMapData, SoyMsgBundle) - Method in interface com.google.template.soy.tofu.SoyTofu

Deprecated. Use SoyTofu.newRenderer(String).

render() - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Renders the template using the data, injected data, and message bundle previously set.

render(Appendable) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Renders the template using the data, injected data, and message bundle previously set into the given Appendable.

renderAsSanitizedContent() - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Renders the strict-mode template as a SanitizedContent object, which can be used as an input to another Soy template, or used to verify that the output type is correct.

S

SanitizedContent - Class in com.google.template.soy.data

A chunk of sanitized content of a known kind, e.g.

SanitizedContent.ContentKind - Enum in com.google.template.soy.data

A kind of textual content.

SanitizedContentOperator - Interface in com.google.template.soy.data

An operator that takes sanitized content of a particular kind and produces sanitized content of the same kind.

SanitizedContents - Class in com.google.template.soy.data

Creation utilities for SanitizedContent objects for common use cases.

set(int, SoyData) - Method in class com.google.template.soy.data.SoyListData

Sets a data value at a given index.

set(int, boolean) - Method in class com.google.template.soy.data.SoyListData

Sets a data value at a given index.

set(int, int) - Method in class com.google.template.soy.data.SoyListData

Sets a data value at a given index.

set(int, double) - Method in class com.google.template.soy.data.SoyListData

Sets a data value at a given index.

set(int, String) - Method in class com.google.template.soy.data.SoyListData

Sets a data value at a given index.

setActiveDelegatePackageNames(Set<String>) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Sets the set of active delegate package names.

setAllowExternalCalls(boolean) - Method in class com.google.template.soy.shared.SoyGeneralOptions

Sets whether to allow external calls (calls to undefined templates).

setAllowExternalCalls(boolean) - Method in class com.google.template.soy.SoyFileSet.Builder

Sets whether to allow external calls (calls to undefined templates).

setBidiGlobalDir(int) - Method in class com.google.template.soy.javasrc.SoyJavaSrcOptions

Sets the bidi global directionality to a static value, 1: ltr, -1: rtl, 0: unspecified.

setBidiGlobalDir(int) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets the bidi global directionality to a static value, 1: ltr, -1: rtl, 0: unspecified.

setCodeStyle(SoyJavaSrcOptions.CodeStyle) - Method in class com.google.template.soy.javasrc.SoyJavaSrcOptions

Sets the output variable code style to use.

setCodeStyle(SoyJsSrcOptions.CodeStyle) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets the output variable code style to use.

setCompileTimeGlobals(Map<String, ?>) - Method in class com.google.template.soy.shared.SoyGeneralOptions

Sets the map from compile-time global name to value.

setCompileTimeGlobals(File) - Method in class com.google.template.soy.shared.SoyGeneralOptions

Sets the file containing compile-time globals.

setCompileTimeGlobals(URL) - Method in class com.google.template.soy.shared.SoyGeneralOptions

Sets the resource file containing compile-time globals.

setCompileTimeGlobals(Map<String, ?>) - Method in class com.google.template.soy.SoyFileSet.Builder

Sets the map from compile-time global name to value.

setCompileTimeGlobals(File) - Method in class com.google.template.soy.SoyFileSet.Builder

Sets the file containing compile-time globals.

setCompileTimeGlobals(URL) - Method in class com.google.template.soy.SoyFileSet.Builder

Sets the resource file containing compile-time globals.

setCssHandlingScheme(SoyGeneralOptions.CssHandlingScheme) - Method in class com.google.template.soy.shared.SoyGeneralOptions

Sets the scheme for handling css commands.

setCssHandlingScheme(SoyGeneralOptions.CssHandlingScheme) - Method in class com.google.template.soy.SoyFileSet.Builder

Sets the scheme for handling css commands.

setCssRenamingHints(SoyCssRenamingMap) - Method in class com.google.template.soy.javasrc.SoyJavaSrcOptions

Sets the CSS renaming map that specifies at compile time how CSS selectors should be renamed.

setCssRenamingMap(SoyCssRenamingMap) - Method in interface com.google.template.soy.javasrc.SoyTemplateRuntime

 

setCssRenamingMap(SoyCssRenamingMap) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Sets the CSS renaming map.

setData(SoyMapData) - Method in interface com.google.template.soy.javasrc.SoyTemplateRuntime

 

setData(Map<String, ?>) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Sets the data to call the template with.

setData(SoyMapData) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Sets the data to call the template with.

setDontAddToCache(boolean) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

If set to true, indicates that we should not add the current combination of SoyMsgBundle and SoyCssRenamingMap to the cache if it's not already there.

setFileOrResourceName(String) - Method in exception com.google.template.soy.msgs.SoyMsgException

Sets the name of the file or resource associated with this error.

setGoogMsgsAreExternal(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether the generated Closure Library message definitions are for external messages (only applicable if shouldGenerateGoogMsgDefs is true).

setIjData(SoyMapData) - Method in interface com.google.template.soy.javasrc.SoyTemplateRuntime

 

setIjData(Map<String, ?>) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Sets the injected data to call the template with.

setIjData(SoyMapData) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Sets the injected data to call the template with.

setIsUsingIjData(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether to enable use of injected data (syntax is '$ij.*').

setMsgBundle(SoyMsgBundle) - Method in interface com.google.template.soy.tofu.SoyTofu.Renderer

Sets the bundle of translated messages, or null to use the messages from the Soy source.

setShouldAllowDeprecatedSyntax(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether to allow deprecated syntax (semi backwards compatible mode).

setShouldDeclareTopLevelNamespaces(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether we should generate code to declare the top level namespace.

setShouldGenerateGoogMsgDefs(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether we should generate Closure Library message definitions (i.e.

setShouldGenerateJsdoc(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether we should generate JSDoc with type info for the Closure Compiler.

setShouldProvideBothSoyNamespacesAndJsFunctions(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether we should generate code to provide both Soy namespaces and JS functions.

setShouldProvideRequireJsFunctions(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether we should generate code to provide/require template JS functions.

setShouldProvideRequireSoyNamespaces(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets whether we should generate code to provide/require Soy namespaces.

setSourceLocaleString(String) - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler.OutputFileOptions

Sets the source locale string for an output message bundle file.

setTargetLocaleString(String) - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler.OutputFileOptions

Sets the target locale string f0or an output message bundle file.

setTemplateName(String) - Method in exception com.google.template.soy.tofu.SoyTofuException

Sets the template name for this error.

setUseCaching(boolean) - Method in class com.google.template.soy.tofu.SoyTofuOptions

Sets whether the resulting SoyTofu instance should cache intermediate results after substitutions from the SoyMsgBundle and the SoyCssRenamingMap.

setUseGoogIsRtlForBidiGlobalDir(boolean) - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Sets the Javascript code snippet that will evaluate at template runtime to a boolean value indicating whether the bidi global direction is rtl.

shouldAllowDeprecatedSyntax() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether we're set to allow deprecated syntax (semi backwards compatible mode).

shouldDeclareTopLevelNamespaces() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether we should attempt to declare the top level namespace.

shouldGenerateGoogMsgDefs() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether we should generate Closure Library message definitions (i.e.

shouldGenerateJsdoc() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether we should generate JSDoc with type info for the Closure Compiler.

shouldProvideBothSoyNamespacesAndJsFunctions() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether we should generate code to provide both Soy namespaces and JS functions.

shouldProvideRequireJsFunctions() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether we're set to generate code to provide/require template JS functions.

shouldProvideRequireSoyNamespaces() - Method in class com.google.template.soy.jssrc.SoyJsSrcOptions

Returns whether we're set to generate code to provide/require Soy namespaces.

SoyCssRenamingMap - Interface in com.google.template.soy.shared

An interface for a one-to-one string mapping function used to rename CSS selectors.

SoyData - Class in com.google.template.soy.data

Abstract base class for all nodes in a Soy data tree.

SoyData() - Constructor for class com.google.template.soy.data.SoyData

 

SoyDataException - Exception in com.google.template.soy.data

Exception thrown when an error occurs in the data package.

SoyDataException(String) - Constructor for exception com.google.template.soy.data.SoyDataException

 

SoyDataException(String, String) - Constructor for exception com.google.template.soy.data.SoyDataException

 

SoyDataException(String, Throwable) - Constructor for exception com.google.template.soy.data.SoyDataException

 

SoyDataException(String, String, Throwable) - Constructor for exception com.google.template.soy.data.SoyDataException

 

SoyFileInfo - Class in com.google.template.soy.parseinfo

Parsed info about a Soy file.

SoyFileInfo(String, String, ImmutableSortedSet<String>, ImmutableList<SoyTemplateInfo>, ImmutableMap<String, SoyFileInfo.CssTagsPrefixPresence>) - Constructor for class com.google.template.soy.parseinfo.SoyFileInfo

Constructor for internal use only.

SoyFileInfo.CssTagsPrefixPresence - Enum in com.google.template.soy.parseinfo

Enum for whether there are prefix expressions in the 'css' tags that a CSS name appears in.

SoyFileSet - Class in com.google.template.soy

Represents a complete set of Soy files for compilation as one bundle.

SoyFileSet.Builder - Class in com.google.template.soy

Builder for a SoyFileSet.

SoyFileSet.Builder() - Constructor for class com.google.template.soy.SoyFileSet.Builder

Constructs a builder that starts with a default SoyGeneralOptions object (options can be modified via methods on the builder).

SoyFileSet.Builder(SoyGeneralOptions) - Constructor for class com.google.template.soy.SoyFileSet.Builder

Constructs a builder with a specified SoyGeneralOptions object.

SoyGeneralOptions - Class in com.google.template.soy.shared

Compilation options applicable to the Soy frontend and/or to multiple Soy backends.

SoyGeneralOptions() - Constructor for class com.google.template.soy.shared.SoyGeneralOptions

 

SoyGeneralOptions.CssHandlingScheme - Enum in com.google.template.soy.shared

Schemes for handling css commands.

SoyJavaSrcOptions - Class in com.google.template.soy.javasrc

Compilation options for the Java Src output target (backend).

SoyJavaSrcOptions() - Constructor for class com.google.template.soy.javasrc.SoyJavaSrcOptions

 

SoyJavaSrcOptions.CodeStyle - Enum in com.google.template.soy.javasrc

The two supported code styles.

SoyJsSrcOptions - Class in com.google.template.soy.jssrc

Compilation options for the JS Src output target (backend).

SoyJsSrcOptions() - Constructor for class com.google.template.soy.jssrc.SoyJsSrcOptions

 

SoyJsSrcOptions.CodeStyle - Enum in com.google.template.soy.jssrc

The two supported code styles.

SoyListData - Class in com.google.template.soy.data

A list data node in a Soy data tree.

SoyListData() - Constructor for class com.google.template.soy.data.SoyListData

 

SoyListData(Iterable<?>) - Constructor for class com.google.template.soy.data.SoyListData

Constructor that initializes this SoyListData from an existing list.

SoyListData(Object...) - Constructor for class com.google.template.soy.data.SoyListData

Constructor that initializes this SoyListData with the given elements.

SoyMapData - Class in com.google.template.soy.data

A map data node in a Soy data tree.

SoyMapData() - Constructor for class com.google.template.soy.data.SoyMapData

 

SoyMapData(Map<String, ?>) - Constructor for class com.google.template.soy.data.SoyMapData

Constructor that initializes this SoyMapData from an existing map.

SoyMapData(Object...) - Constructor for class com.google.template.soy.data.SoyMapData

Constructor that directly takes the keys/values as parameters.

SoyModule - Class in com.google.template.soy

Guice module for Soy's programmatic interface.

SoyModule() - Constructor for class com.google.template.soy.SoyModule

 

SoyMsgBundle - Interface in com.google.template.soy.msgs

Represents a full set of messages in some language/locale.

SoyMsgBundleHandler - Class in com.google.template.soy.msgs

Handler for writing SoyMsgBundles to file format and for creating SoyMsgBundles from files or resources.

SoyMsgBundleHandler(SoyMsgPlugin) - Constructor for class com.google.template.soy.msgs.SoyMsgBundleHandler

 

SoyMsgBundleHandler.OutputFileOptions - Class in com.google.template.soy.msgs

Options for generating an output message bundle file.

SoyMsgBundleHandler.OutputFileOptions() - Constructor for class com.google.template.soy.msgs.SoyMsgBundleHandler.OutputFileOptions

This constructor sets default values for the source locale string and target locale string.

SoyMsgBundleLoader - Interface in com.google.template.soy.msgs

Contract for any object that can load a SoyMsgBundle given a locale.

SoyMsgException - Exception in com.google.template.soy.msgs

Exception for errors related to messages/translation.

SoyMsgException(String) - Constructor for exception com.google.template.soy.msgs.SoyMsgException

 

SoyMsgException(String, Throwable) - Constructor for exception com.google.template.soy.msgs.SoyMsgException

 

SoyMsgException(Throwable) - Constructor for exception com.google.template.soy.msgs.SoyMsgException

 

SoyMsgExtractor - Class in com.google.template.soy

Executable for extracting messages from a set of Soy files into an output messages file.

SoyMsgPlugin - Interface in com.google.template.soy.msgs

Plugin for implementing a specific message file format.

SoyParseInfoGenerator - Class in com.google.template.soy

Executable for generating Java classes containing Soy parse info.

SoySyntaxException - Exception in com.google.template.soy.base

Exception for Soy syntax errors.

SoySyntaxException(String) - Constructor for exception com.google.template.soy.base.SoySyntaxException

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

SoySyntaxException(String, Throwable) - Constructor for exception com.google.template.soy.base.SoySyntaxException

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

SoySyntaxException(Throwable) - Constructor for exception com.google.template.soy.base.SoySyntaxException

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

SoyTemplateInfo - Class in com.google.template.soy.parseinfo

Parsed info about a template.

SoyTemplateInfo(String, ImmutableMap<String, SoyTemplateInfo.ParamRequisiteness>) - Constructor for class com.google.template.soy.parseinfo.SoyTemplateInfo

Deprecated. Users should not be creating SoyTemplateInfo objects. If you're constructing SoyTemplateInfo objects from non-Soy-internal code, your code will be broken by future Soy changes.

SoyTemplateInfo(String, ImmutableMap<String, SoyTemplateInfo.ParamRequisiteness>, ImmutableSortedSet<String>, boolean, boolean) - Constructor for class com.google.template.soy.parseinfo.SoyTemplateInfo

Constructor for internal use only, for the general case.

SoyTemplateInfo.ParamRequisiteness - Enum in com.google.template.soy.parseinfo

Enum for whether a param is required or optional for a specific template.

SoyTemplateRuntime - Interface in com.google.template.soy.javasrc

A compiled Soy template.

SoyTemplateRuntimes - Interface in com.google.template.soy.javasrc

A compiled bundle of templates.

SoyTofu - Interface in com.google.template.soy.tofu

SoyTofu is the public interface for a Java object that represents a compiled Soy file set.

SoyTofu.Renderer - Interface in com.google.template.soy.tofu

Renderer for a template.

SoyTofuException - Exception in com.google.template.soy.tofu

Exception thrown when an error occurs during template rendering.

SoyTofuException(String) - Constructor for exception com.google.template.soy.tofu.SoyTofuException

 

SoyTofuException(String, Throwable) - Constructor for exception com.google.template.soy.tofu.SoyTofuException

 

SoyTofuException(RenderException) - Constructor for exception com.google.template.soy.tofu.SoyTofuException

Creates an instance by copying a RenderException.

SoyTofuOptions - Class in com.google.template.soy.tofu

Compilation options for the Tofu backend.

SoyTofuOptions() - Constructor for class com.google.template.soy.tofu.SoyTofuOptions

 

SoyToJavaSrcCompilerExperimental - Class in com.google.template.soy

Experimental Soy to Java Src compiler.

SoyToJsSrcCompiler - Class in com.google.template.soy

Executable for compiling a set of Soy files into corresponding JS source files.

SoyUtils - Class in com.google.template.soy

Public utilities for Soy users.

stringValue() - Method in class com.google.template.soy.data.SoyData

Precondition: Only call this method if you know that this SoyData object is a string.

T

toBoolean() - Method in class com.google.template.soy.data.SanitizedContent

 

toBoolean() - Method in class com.google.template.soy.data.SoyData

Converts this data object into a boolean (e.g.

toBoolean() - Method in class com.google.template.soy.data.SoyListData

Converts this data object into a boolean (e.g.

toBoolean() - Method in class com.google.template.soy.data.SoyMapData

Converts this data object into a boolean (e.g.

toString() - Method in class com.google.template.soy.data.SanitizedContent

 

toString() - Method in class com.google.template.soy.data.SoyData

Converts this data object into a string (e.g.

toString() - Method in class com.google.template.soy.data.SoyListData

Converts this data object into a string (e.g.

toString() - Method in class com.google.template.soy.data.SoyMapData

Converts this data object into a string (e.g.

toStringHelper(Map<String, SoyData>) - Method in class com.google.template.soy.data.SoyMapData

Protected helper for {toString()}.

U

UnsafeSanitizedContentOrdainer - Class in com.google.template.soy.data

Restricted class to create SanitizedContent objects.

useCaching() - Method in class com.google.template.soy.tofu.SoyTofuOptions

Returns whether the resulting SoyTofu instance should cache intermediate results after substitutions from the SoyMsgBundle and the SoyCssRenamingMap.

V

valueOf(String) - Static method in enum com.google.template.soy.data.SanitizedContent.ContentKind

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.template.soy.javasrc.SoyJavaSrcOptions.CodeStyle

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.template.soy.jssrc.SoyJsSrcOptions.CodeStyle

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.template.soy.parseinfo.SoyFileInfo.CssTagsPrefixPresence

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.template.soy.parseinfo.SoyTemplateInfo.ParamRequisiteness

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.template.soy.shared.SoyGeneralOptions.CssHandlingScheme

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.google.template.soy.data.SanitizedContent.ContentKind

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.template.soy.javasrc.SoyJavaSrcOptions.CodeStyle

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.template.soy.jssrc.SoyJsSrcOptions.CodeStyle

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.template.soy.parseinfo.SoyFileInfo.CssTagsPrefixPresence

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.template.soy.parseinfo.SoyTemplateInfo.ParamRequisiteness

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.template.soy.shared.SoyGeneralOptions.CssHandlingScheme

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeToFile(SoyMsgBundle, File) - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler

Converts a message bundle to output file format and writes it to file.

writeToFile(SoyMsgBundle, SoyMsgBundleHandler.OutputFileOptions, File) - Method in class com.google.template.soy.msgs.SoyMsgBundleHandler

Converts a message bundle to output file format and writes it to file.

X

XliffMsgPlugin - Class in com.google.template.soy.xliffmsgplugin

Message plugin for XLIFF format.

XliffMsgPlugin() - Constructor for class com.google.template.soy.xliffmsgplugin.XliffMsgPlugin

 

XliffMsgPluginModule - Class in com.google.template.soy.xliffmsgplugin

Guice module to bind the XliffMsgPlugin.

XliffMsgPluginModule() - Constructor for class com.google.template.soy.xliffmsgplugin.XliffMsgPluginModule

 

© 2009 Google - Privacy Policy - Terms and Conditions - About Google