com.google.template.soy.jssrc.internal

Class VeLogFunction

java.lang.Object

com.google.template.soy.jssrc.internal.VeLogFunction

All Implemented Interfaces:

SoyJsSrcFunction, SoyLibraryAssistedJsSrcFunction, SoyFunction

public final class VeLogFunction
extends Object
implements SoyLibraryAssistedJsSrcFunction

Soy special function for internal usages.

This function is explicitly not registered with BasicFunctionsModule. It exists for client-side VE logging, and should not be used by Soy users.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
JsExpr	computeForJsSrc(List<JsExpr> args) Computes this function on the given arguments for the JS Source backend.
String	getName() Gets the name of the Soy function.
com.google.common.collect.ImmutableSet<String>	getRequiredJsLibNames() Returns a list of Closure library names to require when this function is used.
Set<Integer>	getValidArgsSizes() Gets the set of valid args list sizes.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

INSTANCE

public static final VeLogFunction INSTANCE

Method Detail

getName

public String getName()

Description copied from interface: SoyFunction

Gets the name of the Soy function.

Specified by:

getName in interface SoyFunction

Returns:

The name of the Soy function.

getValidArgsSizes

public Set<Integer> getValidArgsSizes()

Description copied from interface: SoyFunction

Gets the set of valid args list sizes. For example, the set {0, 2} would indicate that this function can take 0 or 2 arguments (but not 1).

Specified by:

getValidArgsSizes in interface SoyFunction

Returns:

The set of valid args list sizes.

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