com.google.template.soy.basicfunctions

Class FloatFunction

java.lang.Object

com.google.template.soy.basicfunctions.FloatFunction

All Implemented Interfaces:

SoyJbcSrcFunction, SoyJsSrcFunction, SoyPySrcFunction, SoyFunction, SoyJavaFunction

public final class FloatFunction
extends Object
implements SoyJavaFunction, SoyJsSrcFunction, SoyPySrcFunction, SoyJbcSrcFunction

Soy special function for automatic coercion of an int into a float.

This function is explicitly not registered with BasicFunctionsModule. It exists mostly to enable adding return types to commonly used functions without breaking type-checking for existing templates. It is not meant to be used directly in Soy templates.

Field Summary

Fields

Modifier and Type	Field and Description
static FloatFunction	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.
String	getName() Gets the name of the Soy function.
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 FloatFunction 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.

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.

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.