com.google.template.soy.data

Class SoyValueConverter

java.lang.Object

com.google.template.soy.data.SoyValueConverter

public final class SoyValueConverter
extends Object

A converter that knows how to convert all expected Java objects into SoyValues or SoyValueProviders.

IMPORTANT: This class is partially open for public use. Specifically, you may use the method convert(java.lang.Object) and the static fields. But do not use the new* methods. Consider the new* methods internal to Soy, since we haven't yet decided whether or not to make them directly available.

Field Summary

Fields

Modifier and Type	Field and Description
static SoyDict	EMPTY_DICT An immutable empty dict.
static SoyList	EMPTY_LIST An immutable empty list.
static SoyMapImpl	EMPTY_MAP An immutable empty map.
static SoyValueConverter	INSTANCE
static SoyValueConverter	UNCUSTOMIZED_INSTANCE Static instance of this class that does not include any custom value converters.

Method Summary

Modifier and Type	Method and Description
SoyValueProvider	convert(Object obj) Converts a Java object into an equivalent SoyValueProvider.
static Object	markAsSoyMap(Map<?,?> delegate) Signals to the Java rendering API that the wrapped java.util.Map represents a Soy map, and not a legacy_object_map or record.
SoyDict	newDictFromMap(Map<String,?> javaStringMap) Creates a Soy dictionary from a Java string map.
SoyEasyList	newEasyListFromList(SoyList list) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNCUSTOMIZED_INSTANCE

public static final SoyValueConverter UNCUSTOMIZED_INSTANCE

Static instance of this class that does not include any custom value converters.

INSTANCE

public static final SoyValueConverter INSTANCE

EMPTY_DICT

public static final SoyDict EMPTY_DICT

An immutable empty dict.

EMPTY_LIST

public static final SoyList EMPTY_LIST

An immutable empty list.

EMPTY_MAP

public static final SoyMapImpl EMPTY_MAP

An immutable empty map.

Method Detail

newDictFromMap

public SoyDict newDictFromMap(Map<String,?> javaStringMap)

Creates a Soy dictionary from a Java string map. While this is O(n) in the map's shallow size, the Java values are converted into Soy values lazily and only once.

markAsSoyMap

public static Object markAsSoyMap(Map<?,?> delegate)

Signals to the Java rendering API that the wrapped java.util.Map represents a Soy map, and not a legacy_object_map or record. In particular, this allows the map to contain non-string keys. See discussion in DictImpl.

If you want to use non-string keys in a map in Soy, you need to do three things:

• Change the type of your map from legacy_object_map to map
• Change the map passed in from JS from a plain JS object to an ES6 Map
• Wrap the map passed in from Java with markAsSoyMap

newEasyListFromList

@Deprecated
public SoyEasyList newEasyListFromList(SoyList list)

Deprecated.

IMPORTANT: Do not use this method. Consider it internal to Soy.

Creates a new SoyEasyList initialized from a SoyList.

Parameters:

list - The list of initial values.

Returns:

A new SoyEasyList initialized from the given SoyList.

convert

@Nonnull
public SoyValueProvider convert(@Nullable
                                         Object obj)

Converts a Java object into an equivalent SoyValueProvider.

Parameters:

obj - The object to convert.

Returns:

An equivalent SoyValueProvider.

Throws:

SoyDataException - If the given object cannot be converted.