com.google.template.soy.data.internal

Class SoyMapImpl

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.internal.SoyMapImpl

All Implemented Interfaces:

SoyMap, SoyValue, SoyValueProvider

@ParametersAreNonnullByDefault
public final class SoyMapImpl
extends SoyAbstractValue
implements SoyMap

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).

This is a new implementation (compared to DictImpl) that was designed for supporting proto map. There are two different Soy map types, one uses ES6 map in JS, and another uses plain object.

Method Summary

Modifier and Type	Method and Description
Map<? extends SoyValue,? extends SoyValueProvider>	asJavaMap() Gets a Java map of all items in this SoyMap, where mappings are value to value provider.
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 SoyMapImpl	forProviderMap(Map<? extends SoyValue,? extends SoyValueProvider> providerMap) Creates a SoyDict implementation for a particular underlying provider map.
SoyValue	get(SoyValue key) Gets an item value of this SoyMap.
SoyValueProvider	getProvider(SoyValue key) Gets a provider of an item value of this SoyMap.
int	hashCode()
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

Method Detail

forProviderMap

public static SoyMapImpl forProviderMap(Map<? extends SoyValue,? extends SoyValueProvider> providerMap)

Creates a SoyDict implementation for a particular underlying provider map.

size

public int size()

Description copied from interface: SoyMap

Gets the number of items in this SoyMap.

Specified by:

size in interface SoyMap

Returns:

The number of items.

keys

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

Description copied from interface: SoyMap

Gets an iterable over all item keys in this SoyMap.

Important: Iteration order is undefined.

Specified by:

keys in interface SoyMap

Returns:

An iterable over all item keys.

containsKey

public boolean containsKey(SoyValue key)

Description copied from interface: SoyMap

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

Specified by:

containsKey in interface SoyMap

Parameters:

key - The item key to check.

Returns:

Whether this SoyMap has an item with the given key.

get

public SoyValue get(SoyValue key)

Description copied from interface: SoyMap

Gets an item value of this SoyMap.

Specified by:

get 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.

getProvider

public SoyValueProvider getProvider(SoyValue key)

Description copied from interface: SoyMap

Gets a provider of an item value of this SoyMap.

Specified by:

getProvider 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.

asJavaMap

@Nonnull
public Map<? extends SoyValue,? extends SoyValueProvider> asJavaMap()

Description copied from interface: SoyMap

Gets a Java map of all items in this SoyMap, where mappings are value to value provider. Note that value providers are often just the values themselves, since all values are also providers.

Specified by:

asJavaMap in interface SoyMap

Returns:

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

coerceToBoolean

public 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 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 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 int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object