com.google.template.soy.basicfunctions

Class DebugSoyTemplateInfoFunction

java.lang.Object

com.google.template.soy.shared.restricted.TypedSoyFunction

com.google.template.soy.basicfunctions.DebugSoyTemplateInfoFunction

All Implemented Interfaces:

SoyJbcSrcFunction, SoyJsSrcFunction, SoyLibraryAssistedJsSrcFunction, SoyPySrcFunction, SoyFunction, SoyJavaFunction

public final class DebugSoyTemplateInfoFunction
extends TypedSoyFunction
implements SoyJavaFunction, SoyLibraryAssistedJsSrcFunction, SoyPySrcFunction, SoyJbcSrcFunction

Soy special function for internal usages.

This function is explicitly not registered with BasicFunctionsModule. It exists for inspecting the Soy template information from the rendered page, and should not be used in any templates.

Field Summary

Fields

Modifier and Type	Field and Description
static DebugSoyTemplateInfoFunction	INSTANCE
static String	NAME

Method Summary

Modifier and Type	Method and Description
SoyValue	computeForJava(List<SoyValue> args) Computes this function on the given arguments.
SoyExpression	computeForJbcSrc(JbcSrcPluginContext context, List<SoyExpression> args) Computes this function on the given arguments for the Jbcsrc Source backend.
JsExpr	computeForJsSrc(List<JsExpr> args) Computes this function on the given arguments for the JS Source backend.
PyExpr	computeForPySrc(List<PyExpr> args) Computes this function on the given arguments for the Python Source backend.
com.google.common.collect.ImmutableSet<String>	getRequiredJsLibNames() Returns a list of Closure library names to require when this function is used.

Methods inherited from class com.google.template.soy.shared.restricted.TypedSoyFunction

getName, getValidArgsSizes

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.template.soy.shared.restricted.SoyFunction

getName, getValidArgsSizes

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

INSTANCE

public static final DebugSoyTemplateInfoFunction INSTANCE

Method Detail

computeForJava

public SoyValue computeForJava(List<SoyValue> args)

Description copied from interface: SoyJavaFunction

Computes this function on the given arguments.

Specified by:

computeForJava in interface SoyJavaFunction

Parameters:

args - The function arguments.

Returns:

The computed result of this function.

computeForJsSrc

public JsExpr computeForJsSrc(List<JsExpr> args)

Description copied from interface: SoyJsSrcFunction

Computes this function on the given arguments for the JS Source backend.

Specified by:

computeForJsSrc in interface SoyJsSrcFunction

Parameters:

args - The function arguments.

Returns:

The computed result of this function.

getRequiredJsLibNames

public com.google.common.collect.ImmutableSet<String> getRequiredJsLibNames()

Description copied from interface: SoyLibraryAssistedJsSrcFunction

Returns a list of Closure library names to require when this function is used.

Note: Return the raw Closure library names, Soy will wrap them in goog.require for you.

Specified by:

getRequiredJsLibNames in interface SoyLibraryAssistedJsSrcFunction

Returns:

A collection of strings representing Closure JS library names

computeForPySrc

public PyExpr computeForPySrc(List<PyExpr> args)

Description copied from interface: SoyPySrcFunction

Computes this function on the given arguments for the Python Source backend.

Specified by:

computeForPySrc in interface SoyPySrcFunction

Parameters:

args - The function arguments.

Returns:

The computed result of this function.

computeForJbcSrc

public SoyExpression computeForJbcSrc(JbcSrcPluginContext context,
                                      List<SoyExpression> args)

Description copied from interface: SoyJbcSrcFunction

Computes this function on the given arguments for the Jbcsrc Source backend.

Specified by:

computeForJbcSrc in interface SoyJbcSrcFunction

Parameters:

context - Contextual data for the current render operation.

args - The function arguments.

Returns:

The computed result of this function.