com.google.template.soy.basicfunctions

Class MapToLegacyObjectMapFunction

java.lang.Object

com.google.template.soy.basicfunctions.MapToLegacyObjectMapFunction

All Implemented Interfaces:

SoyJbcSrcFunction, SoyJsSrcFunction, SoyLibraryAssistedJsSrcFunction, SoyPySrcFunction, SoyFunction, SoyJavaFunction

public final class MapToLegacyObjectMapFunction
extends Object
implements SoyJavaFunction, SoyJbcSrcFunction, SoyPySrcFunction, SoyLibraryAssistedJsSrcFunction

Converts values of type map to values of type legacy_object_map.

(This is the inverse of LegacyObjectMapToMapFunction.)

The two map types are designed to be incompatible in the Soy type system; the long-term plan is to migrate all legacy_object_maps to maps and delete legacy_object_map. To allow template-level migrations of legacy_object_map parameters to map, we need plugins to convert between the two maps, so that converting one template doesn't require converting its transitive callees.

NOTE: this function has special support in the type checker for calculating the return type

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

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.

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

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.

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.

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.