SoyMap (Closure Templates)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

SoyValue, SoyValueProvider

All Known Subinterfaces:

SoyDict, SoyEasyDict, SoyEasyList, SoyList

All Known Implementing Classes:

DictImpl, EasyDictImpl, EasyListImpl, ListImpl, SoyAbstractList, SoyAbstractMap, SoyListData, SoyMapData, SoyProtoValue
```
@ParametersAreNonnullByDefault
public interface SoyMap
extends SoyValue
```
A map containing key-to-value mappings referred to as items. Each key is a SoyValue (must be already resolved) and each value is a SoyValue (can be unresolved).
Important: Until this API is more stable and this note is removed, users must not define classes that implement this interface.

Method Summary

Methods
Modifier and Type	Method and Description
`SoyValue`	`getItem(SoyValue key)` Gets an item value of this SoyMap.
`int`	`getItemCnt()` Gets the number of items in this SoyMap.
`Iterable<? extends SoyValue>`	`getItemKeys()` Gets an iterable over all item keys in this SoyMap.
`SoyValueProvider`	`getItemProvider(SoyValue key)` Gets a provider of an item value of this SoyMap.
`boolean`	`hasItem(SoyValue key)` Checks whether this SoyMap has an item with the given key.

Methods inherited from interface com.google.template.soy.data.SoyValue
booleanValue, coerceToBoolean, coerceToString, equals, floatValue, integerValue, longValue, numberValue, render, stringValue

Methods inherited from interface com.google.template.soy.data.SoyValueProvider
renderAndResolve, resolve, status

- Method Detail
  - getItemCnt
```
int getItemCnt()
```
    Gets the number of items in this SoyMap.
    
    Returns:
    The number of items.
  - getItemKeys
```
@Nonnull
Iterable<? extends SoyValue> getItemKeys()
```
    Gets an iterable over all item keys in this SoyMap. Important: Iteration order is undefined.
    
    Returns:
    An iterable over all item keys.
  - hasItem
```
boolean hasItem(SoyValue key)
```
    Checks whether this SoyMap has an item with the given key.
    
    Parameters:
    key - The item key to check.
    
    Returns:
    Whether this SoyMap has an item with the given key.
  - getItem
```
SoyValue getItem(SoyValue key)
```
    Gets an item value of this SoyMap.
    
    Parameters:
    key - The item key to get.
    
    Returns:
    The item value for the given item key, or null if no such item key.
  - getItemProvider
```
SoyValueProvider getItemProvider(SoyValue key)
```
    Gets a provider of an item value of this SoyMap.
    
    Parameters:
    key - The item key to get.
    
    Returns:
    A provider of the item value for the given item key, or null if no such item key.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method