com.google.template.soy.data.internal

Class DictImpl

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.internal.DictImpl

All Implemented Interfaces:

SoyDict, SoyMap, SoyNewMap, SoyRecord, SoyValue, SoyValueProvider

@ParametersAreNonnullByDefault
public final class DictImpl
extends SoyAbstractValue
implements SoyDict, SoyNewMap

Internal implementation of SoyDict in terms of a map. Do not use directly; instead, use SoyValueConverter.convert(java.lang.Object).

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.

Method Summary

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.
boolean	coerceToBoolean() Coerces this value into a boolean.
String	coerceToString() Coerces this value into a string.
boolean	containsKey(SoyValue key) Checks whether this SoyMap has an item with the given key.
boolean	equals(Object other) Compares this value against another for equality in the sense of the '==' operator of Soy.
static DictImpl	forProviderMap(Map<String,? extends SoyValueProvider> providerMap) Creates a SoyDict implementation for a particular underlying provider map.
SoyValue	get(SoyValue key) Gets an item value of this SoyMap.
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(SoyValue key) Gets a provider of an item value of this SoyMap.
protected String	getStringKey(SoyValue key)
boolean	hasField(String name) Checks whether this SoyRecord has a field of the given name.
int	hashCode()
boolean	hasItem(SoyValue key) Checks whether this SoyMap has an item with the given key.
Iterable<? extends SoyValue>	keys() Gets an iterable over all item keys in this SoyMap.
void	render(LoggingAdvisingAppendable appendable) Renders this value to the given appendable.
int	size() Gets the number of items in this SoyMap.
String	toString()

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

booleanValue, floatValue, integerValue, longValue, numberValue, render, renderAndResolve, resolve, status, stringValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Method Detail

forProviderMap

public static DictImpl forProviderMap(Map<String,? extends SoyValueProvider> providerMap)

Creates a SoyDict implementation for a particular underlying provider map.

The map may be mutable, but will not be mutated by the DictImpl.

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.

size

public int size()

Description copied from interface: SoyNewMap

Gets the number of items in this SoyMap.

Specified by:

size in interface SoyNewMap

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.

keys

@Nonnull
public Iterable<? extends SoyValue> keys()

Description copied from interface: SoyNewMap

Gets an iterable over all item keys in this SoyMap.

Important: Iteration order is undefined.

Specified by:

keys in interface SoyNewMap

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.

containsKey

public boolean containsKey(SoyValue key)

Description copied from interface: SoyNewMap

Checks whether this SoyMap has an item with the given key.

Specified by:

containsKey in interface SoyNewMap

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

Parameters:

key - The item key to get.

Returns:

The item value for the given item key, or null if no such item key.

get

public SoyValue get(SoyValue key)

Description copied from interface: SoyNewMap

Gets an item value of this SoyMap.

Specified by:

get in interface SoyNewMap

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.

getProvider

public SoyValueProvider getProvider(SoyValue key)

Description copied from interface: SoyNewMap

Gets a provider of an item value of this SoyMap.

Specified by:

getProvider in interface SoyNewMap

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

Specified by:

asJavaStringMap in interface SoyNewMap

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

Specified by:

asResolvedJavaStringMap in interface SoyNewMap

Returns:

A Java map of all items, where mappings are string to value.

getStringKey

protected final String getStringKey(SoyValue key)

coerceToBoolean

public final boolean coerceToBoolean()

Description copied from interface: SoyValue

Coerces this value into a boolean.

Specified by:

coerceToBoolean in interface SoyValue

Returns:

This value coerced into a boolean.

coerceToString

public final String coerceToString()

Description copied from interface: SoyValue

Coerces this value into a string.

Specified by:

coerceToString in interface SoyValue

Returns:

This value coerced into a string.

render

public void render(LoggingAdvisingAppendable appendable)
            throws IOException

Description copied from interface: SoyValue

Renders this value to the given appendable.

This should behave identically to appendable.append(coerceToString()) but is provided separately to allow more incremental approaches.

Specified by:

render in interface SoyValue

Parameters:

appendable - The appendable to render to.

Throws:

IOException

equals

public final boolean equals(Object other)

Description copied from interface: SoyValue

Compares this value against another for equality in the sense of the '==' operator of Soy.

Specified by:

equals in interface SoyValue

Specified by:

equals in class SoyAbstractValue

Parameters:

other - The other value to compare against.

Returns:

True if this value is equal to the other in the sense of Soy.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object