KeysFunction (Closure Templates)

java.lang.Object
- com.google.template.soy.basicfunctions.KeysFunction

All Implemented Interfaces:

SoyJsSrcFunction, SoyPySrcFunction, SoyFunction, SoyJavaFunction
```
@Singleton
public final class KeysFunction
extends Object
implements SoyJavaFunction, SoyJsSrcFunction, SoyPySrcFunction
```
Soy function that gets the keys in a map.
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. {foreach $key in keys($myMap)} ... {/foreach}

Method Summary

Methods
Modifier and Type	Method and Description
`SoyValue`	`computeForJava(List<SoyValue> args)` Computes this function on the given arguments.
`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.
`static List<SoyValue>`	`keys(SoyMap map)` Returns a list of all the keys in the given map.

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.
  - 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.
  - keys
```
public static List<SoyValue> keys(SoyMap map)
```
    Returns a list of all the keys in the given map.
  - 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.

Class KeysFunction

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getValidArgsSizes

computeForJava

keys

computeForJsSrc

computeForPySrc