com.google.template.soy.data

Class SoyMapData

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.SoyData

com.google.template.soy.data.restricted.CollectionData

com.google.template.soy.data.SoyMapData

All Implemented Interfaces:

SoyDict, SoyLegacyObjectMap, SoyRecord, SoyValue, SoyValueProvider

public class SoyMapData
extends CollectionData
implements SoyDict

A map data node in a Soy data tree.

Important: Even though this class is not marked 'final', do not extend this class.

Constructor Summary

Constructors

Constructor and Description
SoyMapData()
SoyMapData(Map<String,?> data) Constructor that initializes this SoyMapData from an existing map.
SoyMapData(Object... data) Constructor that directly takes the keys/values as parameters.

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,SoyData>	asMap() Important: Please treat this method as superpackage-private.
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	equals(Object other) Compares this value against another for equality in the sense of the '==' operator of Soy.
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<StringData>	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.
Set<String>	getKeys() Gets the keys in this map data.
SoyData	getSingle(String key) Important: Do not use outside of Soy code (treat as superpackage-private).
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.
void	putSingle(String key, SoyData value) Important: Do not use outside of Soy code (treat as superpackage-private).
void	removeSingle(String key) Important: Do not use outside of Soy code (treat as superpackage-private).
void	render(LoggingAdvisingAppendable appendable) Renders this value to the given appendable.
String	toString()

Methods inherited from class com.google.template.soy.data.restricted.CollectionData

ensureValidValue, get, getBoolean, getFloat, getInteger, getListData, getLong, getMapData, getString, put, put, put, put, put, put, put, remove

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

createFromExistingData

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

Constructor Detail

SoyMapData

public SoyMapData()

SoyMapData

public SoyMapData(Map<String,?> data)

Constructor that initializes this SoyMapData from an existing map.

Parameters:

data - The initial data in an existing map.

SoyMapData

public SoyMapData(Object... data)

Constructor that directly takes the keys/values as parameters.

Parameters:

data - The initial data, with alternating keys/values.

Method Detail

asMap

public Map<String,SoyData> asMap()

Important: Please treat this method as superpackage-private. Do not call this method from outside the 'tofu' and 'data' packages.

Returns a view of this SoyMapData object as a Map.

getKeys

public Set<String> getKeys()

Gets the keys in this map data.

Returns:

A set containing the keys in this map data.

toString

public String toString()

This method should only be used for debugging purposes.

Overrides:

toString in class Object

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

coerceToBoolean

public boolean coerceToBoolean()

Coerces this value into a boolean.

A map is always truthy.

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.

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

putSingle

public void putSingle(String key,
                      SoyData value)

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

Puts data into this data object at the specified key.

Specified by:

putSingle in class CollectionData

Parameters:

key - An individual key.

value - The data to put at the specified key.

removeSingle

public void removeSingle(String key)

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

Removes the data at the specified key.

Specified by:

removeSingle in class CollectionData

Parameters:

key - An individual key.

getSingle

public SoyData getSingle(String key)

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

Gets the data at the specified key.

Specified by:

getSingle in class CollectionData

Parameters:

key - An individual key.

Returns:

The data at the specified key, or null if the key is not defined.

asJavaStringMap

@Nonnull
public 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 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.

hasField

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

Description copied from interface: SoyLegacyObjectMap

Gets the number of items in this SoyMap.

Specified by:

getItemCnt in interface SoyLegacyObjectMap

Returns:

The number of items.

getItemKeys

@Nonnull
public Iterable<StringData> getItemKeys()

Description copied from interface: SoyLegacyObjectMap

Gets an iterable over all item keys in this SoyMap.

Important: Iteration order is undefined.

Specified by:

getItemKeys in interface SoyLegacyObjectMap

Returns:

An iterable over all item keys.

hasItem

public boolean hasItem(SoyValue key)

Description copied from interface: SoyLegacyObjectMap

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

Specified by:

hasItem in interface SoyLegacyObjectMap

Parameters:

key - The item key to check.

Returns:

Whether this SoyMap has an item with the given key.

getItem

public SoyValue getItem(SoyValue key)

Description copied from interface: SoyLegacyObjectMap

Gets an item value of this SoyMap.

Specified by:

getItem in interface SoyLegacyObjectMap

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 SoyValueProvider getItemProvider(SoyValue key)

Description copied from interface: SoyLegacyObjectMap

Gets a provider of an item value of this SoyMap.

Specified by:

getItemProvider in interface SoyLegacyObjectMap

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.