com.google.template.soy.basicfunctions

Class KeysFunction

java.lang.Object

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

com.google.template.soy.basicfunctions.KeysFunction

All Implemented Interfaces:

SoyJbcSrcFunction, SoyJsSrcFunction, SoyLibraryAssistedJsSrcFunction, SoyPySrcFunction, SoyFunction, SoyJavaFunction

@Singleton
public final class KeysFunction
extends TypedSoyFunction
implements SoyJavaFunction, SoyLibraryAssistedJsSrcFunction, SoyPySrcFunction, SoyJbcSrcFunction

Soy function that gets the keys in a map. This method is only used for legacy_object_map. For new map type (proto map and ES6 map in JS), use MapKeysFunction instead.

This function also supports list input to mimic JS behaviors. In JS, list is also an object, and iterating its keys returns a list of indices.

The keys are returned as a list with no guarantees on the order (may be different on each run or for each backend).

This enables iteration over the keys in a map, e.g. {for $key in keys($myMap)} ... {/for}

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

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.