com.google.template.soy.data

Interface SoyEasyDict

All Superinterfaces:

SoyDict, SoyMap, SoyRecord, SoyValue, SoyValueProvider

All Known Implementing Classes:

EasyDictImpl

@ParametersAreNonnullByDefault
public interface SoyEasyDict
extends SoyDict

A mutable SoyDict with additional methods for ease-of-use.

In map usage, the item keys are the record field names in the form of StringData.

Important: Until this API is more stable and this note is removed, users must not define classes that implement this interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.data.SoyValueProvider

SoyValueProvider.ResolveStatus

Method Summary

Modifier and Type	Method and Description
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.
SoyValueProvider	getProvider(String dottedName) Gets a provider of a subfield value of this dict.
boolean	has(String dottedName) Checks whether this dict has a subfield at the given dotted name.
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 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, render, stringValue

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

equals, resolve, status

Method Detail

setField

void setField(String name,
              SoyValueProvider valueProvider)

Sets a field of this dict.

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

void delField(String name)

Deletes a field of this dict.

Parameters:

name - The field name to delete.

setItemsFromDict

void setItemsFromDict(SoyDict dict)

Sets items in this dict from another dict.

Parameters:

dict - A dict of the fields to set.

setFieldsFromJavaStringMap

void setFieldsFromJavaStringMap(Map<String,?> javaStringMap)

Sets fields on this dict from a Java string-keyed map.

Parameters:

javaStringMap - A Java string-keyed map of the fields to set.

set

void set(String dottedName,
         @Nullable
         Object value)

Sets a subfield of this dict.

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

void del(String dottedName)

Deletes a subfield of this dict.

Parameters:

dottedName - The dotted name to delete (one or more field names, dot-separated).

has

boolean has(String dottedName)

Checks whether this dict has a subfield at the given dotted name.

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

SoyValue get(String dottedName)

Gets a subfield value of this dict.

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

SoyValueProvider getProvider(String dottedName)

Gets a provider of a subfield value of this dict.

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

SoyEasyDict makeImmutable()

Makes this dict immutable.

Returns:

This dict, for convenience.