EasyDictImpl (Closure Templates)

java.lang.Object
- com.google.template.soy.data.SoyAbstractValue
- - com.google.template.soy.data.SoyAbstractMap
  - - com.google.template.soy.data.internal.EasyDictImpl

All Implemented Interfaces:

SoyDict, SoyEasyDict, SoyMap, SoyRecord, SoyValue, SoyValueProvider
```
@ParametersAreNonnullByDefault
public final class EasyDictImpl
extends SoyAbstractMap
implements SoyEasyDict
```
Internal implementation of SoyEasyDict. Do not use directly. Instead, use SoyValueHelper.newEasyDict*().
Important: Do not use outside of Soy code (treat as superpackage-private).

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,? extends SoyValueProvider> providerMap
Map containing each data provider.

Fields
Modifier and Type	Field and Description
`protected Map<String,? extends SoyValueProvider>`	`providerMap` Map containing each data provider.

Constructor Summary

Constructors
Constructor and Description

EasyDictImpl(SoyValueHelper valueHelper)
Important: Do not use outside of Soy code (treat as superpackage-private).\

Constructors
Constructor and Description
`EasyDictImpl(SoyValueHelper valueHelper)` Important: Do not use outside of Soy code (treat as superpackage-private).\

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,? extends SoyValueProvider>`	`asJavaStringMap()` Gets a Java map of all items in this SoyDict, where mappings are string to value provider.
`Map<String,? extends SoyValue>`	`asResolvedJavaStringMap()` Gets a Java map of all items in this SoyDict, where mappings are string to value.
`void`	`del(String dottedName)` Deletes a subfield of this dict.
`void`	`delField(String name)` Deletes a field of this dict.
`SoyValue`	`get(String dottedName)` Gets a subfield value of this dict.
`SoyValue`	`getField(String name)` Gets a field value of this SoyRecord.
`SoyValueProvider`	`getFieldProvider(String name)` Gets a provider of a field value of this SoyRecord.
`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.
`SoyValueProvider`	`getProvider(String dottedName)` Gets a provider of a subfield value of this dict.
`protected String`	`getStringKey(SoyValue key)`
`boolean`	`has(String dottedName)` Checks whether this dict has a subfield at the given dotted name.
`boolean`	`hasField(String name)` Checks whether this SoyRecord has a field of the given name.
`boolean`	`hasItem(SoyValue key)` Checks whether this SoyMap has an item with the given key.
`SoyEasyDict`	`makeImmutable()` Makes this dict immutable.
`void`	`set(String dottedName, Object value)` Sets a subfield of this dict.
`void`	`setField(String name, SoyValueProvider valueProvider)` Sets a field of this dict.
`void`	`setFieldsFromJavaStringMap(Map<String,?> javaStringMap)` Sets fields on this dict from a Java string-keyed map.
`void`	`setItemsFromDict(SoyDict dict)` Sets items in this dict from another dict.

Methods inherited from class com.google.template.soy.data.SoyAbstractMap
coerceToBoolean, coerceToString, equals, render, toString

Methods inherited from class com.google.template.soy.data.SoyAbstractValue
booleanValue, floatValue, integerValue, longValue, numberValue, renderAndResolve, resolve, status, stringValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.data.SoyDict
asJavaStringMap, asResolvedJavaStringMap

Methods inherited from interface com.google.template.soy.data.SoyRecord
getField, getFieldProvider, hasField

Methods inherited from interface com.google.template.soy.data.SoyMap
getItem, getItemCnt, getItemKeys, getItemProvider, hasItem

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

- Field Detail
  - providerMap
```
protected final Map<String,? extends SoyValueProvider> providerMap
```
    Map containing each data provider.
- Constructor Detail
  - EasyDictImpl
```
public EasyDictImpl(SoyValueHelper valueHelper)
```
    Important: Do not use outside of Soy code (treat as superpackage-private).\
    
    Parameters:
    valueHelper - The instance of SoyValueHelper to use for internal conversions.
- Method Detail
  - setField
```
public void setField(String name,
            SoyValueProvider valueProvider)
```
    Description copied from interface: SoyEasyDict
    
    Sets a field of this dict.
    
    Specified by:
    
    setField in interface SoyEasyDict
    
    Parameters:
    name - The field name to set.
    valueProvider - A provider of the field value for the given field name. Note that this is often just the field value itself, since all values are also providers.
  - delField
```
public void delField(String name)
```
    Description copied from interface: SoyEasyDict
    
    Deletes a field of this dict.
    
    Specified by:
    
    delField in interface SoyEasyDict
    
    Parameters:
    name - The field name to delete.
  - setItemsFromDict
```
public void setItemsFromDict(SoyDict dict)
```
    Description copied from interface: SoyEasyDict
    
    Sets items in this dict from another dict.
    
    Specified by:
    
    setItemsFromDict in interface SoyEasyDict
    
    Parameters:
    dict - A dict of the fields to set.
  - setFieldsFromJavaStringMap
```
public void setFieldsFromJavaStringMap(Map<String,?> javaStringMap)
```
    Description copied from interface: SoyEasyDict
    
    Sets fields on this dict from a Java string-keyed map.
    
    Specified by:
    
    setFieldsFromJavaStringMap in interface SoyEasyDict
    
    Parameters:
    javaStringMap - A Java string-keyed map of the fields to set.
  - set
```
public void set(String dottedName,
       @Nullable
       Object value)
```
    Description copied from interface: SoyEasyDict
    
    Sets a subfield of this dict.
    
    Specified by:
    
    set in interface SoyEasyDict
    
    Parameters:
    dottedName - The dotted name to set (one or more field names, dot-separated).
    value - The subfield value for the given dotted name. If it's not a SoyValueProvider (includes SoyValue), it will be converted.
  - del
```
public void del(String dottedName)
```
    Description copied from interface: SoyEasyDict
    
    Deletes a subfield of this dict.
    
    Specified by:
    
    del in interface SoyEasyDict
    
    Parameters:
    dottedName - The dotted name to delete (one or more field names, dot-separated).
  - has
```
public boolean has(String dottedName)
```
    Description copied from interface: SoyEasyDict
    
    Checks whether this dict has a subfield at the given dotted name.
    
    Specified by:
    
    has in interface SoyEasyDict
    
    Parameters:
    dottedName - The dotted name to check (one or more field names, dot-separated).
    
    Returns:
    Whether this dict has a subfield at the given dotted name.
  - get
```
public SoyValue get(String dottedName)
```
    Description copied from interface: SoyEasyDict
    
    Gets a subfield value of this dict.
    
    Specified by:
    
    get in interface SoyEasyDict
    
    Parameters:
    dottedName - The dotted name to get (one or more field names, dot-separated).
    
    Returns:
    The subfield value for the given dotted name, or null if no such subfield.
  - getProvider
```
public SoyValueProvider getProvider(String dottedName)
```
    Description copied from interface: SoyEasyDict
    
    Gets a provider of a subfield value of this dict.
    
    Specified by:
    
    getProvider in interface SoyEasyDict
    
    Parameters:
    dottedName - The dotted name to get (one or more field names, dot-separated).
    
    Returns:
    A provider of the subfield value for the given dotted name, or null if no such subfield.
  - makeImmutable
```
public SoyEasyDict makeImmutable()
```
    Description copied from interface: SoyEasyDict
    
    Makes this dict immutable.
    
    Specified by:
    
    makeImmutable in interface SoyEasyDict
    
    Returns:
    This dict, for convenience.
  - hasField
```
public final boolean hasField(String name)
```
    Description copied from interface: SoyRecord
    
    Checks whether this SoyRecord has a field of the given name.
    
    Specified by:
    
    hasField in interface SoyRecord
    
    Parameters:
    name - The field name to check.
    
    Returns:
    Whether this SoyRecord has a field of the given name.
  - getField
```
public final SoyValue getField(String name)
```
    Description copied from interface: SoyRecord
    
    Gets a field value of this SoyRecord.
    
    Specified by:
    
    getField in interface SoyRecord
    
    Parameters:
    name - The field name to get.
    
    Returns:
    The field value for the given field name, or null if no such field name.
  - getFieldProvider
```
public final SoyValueProvider getFieldProvider(String name)
```
    Description copied from interface: SoyRecord
    
    Gets a provider of a field value of this SoyRecord.
    
    Specified by:
    
    getFieldProvider in interface SoyRecord
    
    Parameters:
    name - The field name to get.
    
    Returns:
    A provider of the field value for the given field name, or null if no such field name.
  - getItemCnt
```
public final int getItemCnt()
```
    Description copied from interface: SoyMap
    
    Gets the number of items in this SoyMap.
    
    Specified by:
    
    getItemCnt in interface SoyMap
    
    Returns:
    The number of items.
  - getItemKeys
```
@Nonnull
public final Iterable<? extends SoyValue> getItemKeys()
```
    Description copied from interface: SoyMap
    
    Gets an iterable over all item keys in this SoyMap. Important: Iteration order is undefined.
    
    Specified by:
    
    getItemKeys in interface SoyMap
    
    Returns:
    An iterable over all item keys.
  - hasItem
```
public final boolean hasItem(SoyValue key)
```
    Description copied from interface: SoyMap
    
    Checks whether this SoyMap has an item with the given key.
    
    Specified by:
    
    hasItem in interface SoyMap
    
    Parameters:
    key - The item key to check.
    
    Returns:
    Whether this SoyMap has an item with the given key.
  - getItem
```
public final SoyValue getItem(SoyValue key)
```
    Description copied from interface: SoyMap
    
    Gets an item value of this SoyMap.
    
    Specified by:
    
    getItem in interface SoyMap
    
    Overrides:
    
    getItem in class SoyAbstractMap
    
    Parameters:
    key - The item key to get.
    
    Returns:
    The item value for the given item key, or null if no such item key.
  - getItemProvider
```
public final SoyValueProvider getItemProvider(SoyValue key)
```
    Description copied from interface: SoyMap
    
    Gets a provider of an item value of this SoyMap.
    
    Specified by:
    
    getItemProvider in interface 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.
  - asJavaStringMap
```
@Nonnull
public final Map<String,? extends SoyValueProvider> asJavaStringMap()
```
    Description copied from interface: SoyDict
    
    Gets a Java map of all items in this SoyDict, where mappings are string to value provider. Note that value providers are often just the values themselves, since all values are also providers.
    
    Specified by:
    
    asJavaStringMap in interface SoyDict
    
    Returns:
    A Java map of all items, where mappings are string to value provider.
  - asResolvedJavaStringMap
```
@Nonnull
public final Map<String,? extends SoyValue> asResolvedJavaStringMap()
```
    Description copied from interface: SoyDict
    
    Gets a Java map of all items in this SoyDict, where mappings are string to value. All value providers will be eagerly resolved.
    
    Specified by:
    
    asResolvedJavaStringMap in interface SoyDict
    
    Returns:
    A Java map of all items, where mappings are string to value.
  - getStringKey
```
protected final String getStringKey(SoyValue key)
```

Class EasyDictImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.google.template.soy.data.SoyAbstractMap

Methods inherited from class com.google.template.soy.data.SoyAbstractValue

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.template.soy.data.SoyDict

Methods inherited from interface com.google.template.soy.data.SoyRecord

Methods inherited from interface com.google.template.soy.data.SoyMap

Methods inherited from interface com.google.template.soy.data.SoyValue

Methods inherited from interface com.google.template.soy.data.SoyValueProvider

Field Detail

providerMap

Constructor Detail

EasyDictImpl

Method Detail

setField

delField

setItemsFromDict

setFieldsFromJavaStringMap

set

del

has

get

getProvider

makeImmutable

hasField

getField

getFieldProvider

getItemCnt

getItemKeys

hasItem

getItem

getItemProvider

asJavaStringMap

asResolvedJavaStringMap

getStringKey