SoyValueHelper (Closure Templates)

java.lang.Object
- com.google.template.soy.data.SoyValueHelper

All Implemented Interfaces:

SoyValueConverter
```
@ParametersAreNonnullByDefault
public final class SoyValueHelper
extends Object
implements SoyValueConverter
```
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. Helpers for creating or converting existing data to SoyValue. Replaces the static utilities in the old class SoyData.

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 SoyValueHelper`	`UNCUSTOMIZED_INSTANCE` Static instance of this class that does not include any custom value converters.

Constructor Summary

Constructors
Constructor and Description

SoyValueHelper()

Constructors
Constructor and Description
`SoyValueHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`SoyValueProvider`	`convert(Object obj)` Converts a Java object into an equivalent SoyValueProvider.
`SoyEasyDict`	`newEasyDict()` IMPORTANT: Do not use this method.
`SoyEasyDict`	`newEasyDict(Object... alternatingKeysAndValues)` IMPORTANT: Do not use this method.
`SoyEasyDict`	`newEasyDictFromDict(SoyDict dict)` IMPORTANT: Do not use this method.
`SoyEasyDict`	`newEasyDictFromJavaStringMap(Map<String,?> javaStringMap)` IMPORTANT: Do not use this method.
`SoyEasyList`	`newEasyList()` IMPORTANT: Do not use this method.
`SoyEasyList`	`newEasyList(Object... values)` IMPORTANT: Do not use this method.
`SoyEasyList`	`newEasyListFromJavaIterable(Iterable<?> javaIterable)` IMPORTANT: Do not use this method.
`SoyEasyList`	`newEasyListFromList(SoyList list)` IMPORTANT: Do not use this method.

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 SoyValueHelper UNCUSTOMIZED_INSTANCE
```
    Static instance of this class that does not include any custom value converters.
  - EMPTY_DICT
```
public static final SoyDict EMPTY_DICT
```
    An immutable empty dict.
  - EMPTY_LIST
```
public static final SoyList EMPTY_LIST
```
    An immutable empty list.
- Constructor Detail
  - SoyValueHelper
```
@Inject
public SoyValueHelper()
```
- Method Detail
  - newEasyDict
```
public SoyEasyDict newEasyDict()
```
    IMPORTANT: Do not use this method. Consider it internal to Soy. Creates a new empty SoyEasyDict.
    
    Returns:
    A new empty SoyEasyDict.
  - newEasyDict
```
public SoyEasyDict newEasyDict(Object... alternatingKeysAndValues)
```
    IMPORTANT: Do not use this method. Consider it internal to Soy. Creates a new SoyEasyDict initialized from the given keys and values.
    
    Parameters:
    alternatingKeysAndValues - An alternating list of keys and values.
    
    Returns:
    A new SoyEasyDict initialized from the given keys and values.
  - newEasyDictFromDict
```
public SoyEasyDict newEasyDictFromDict(SoyDict dict)
```
    IMPORTANT: Do not use this method. Consider it internal to Soy. Creates a new SoyEasyDict initialized from a SoyDict.
    
    Parameters:
    dict - The dict of initial items.
    
    Returns:
    A new SoyEasyDict initialized from the given SoyDict.
  - newEasyDictFromJavaStringMap
```
public SoyEasyDict newEasyDictFromJavaStringMap(Map<String,?> javaStringMap)
```
    IMPORTANT: Do not use this method. Consider it internal to Soy. Creates a new SoyEasyDict initialized from a Java string-keyed map.
    
    Parameters:
    javaStringMap - The map of initial items.
    
    Returns:
    A new SoyEasyDict initialized from the given Java string-keyed map.
  - newEasyList
```
public SoyEasyList newEasyList()
```
    IMPORTANT: Do not use this method. Consider it internal to Soy. Creates a new empty SoyEasyList.
    
    Returns:
    A new empty SoyEasyList.
  - newEasyList
```
public SoyEasyList newEasyList(Object... values)
```
    IMPORTANT: Do not use this method. Consider it internal to Soy. Creates a new SoyEasyList initialized from the given values.
    
    Parameters:
    values - A list of values.
    
    Returns:
    A new SoyEasyList initialized from the given values.
  - newEasyListFromList
```
public SoyEasyList newEasyListFromList(SoyList list)
```
    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.
  - newEasyListFromJavaIterable
```
public SoyEasyList newEasyListFromJavaIterable(Iterable<?> javaIterable)
```
    IMPORTANT: Do not use this method. Consider it internal to Soy. Creates a new SoyEasyList initialized from a Java iterable.
    
    Parameters:
    javaIterable - The Java iterable of initial values.
    
    Returns:
    A new SoyEasyList initialized from the given Java iterable.
  - convert
```
@Nonnull
public SoyValueProvider convert(@Nullable
                               Object obj)
```
    Converts a Java object into an equivalent SoyValueProvider.
    
    Specified by:
    
    convert in interface SoyValueConverter
    
    Parameters:
    obj - The object to convert.
    
    Returns:
    An equivalent SoyValueProvider.
    
    Throws:
    
    SoyDataException - If the given object cannot be converted.

Class SoyValueHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNCUSTOMIZED_INSTANCE

EMPTY_DICT

EMPTY_LIST

Constructor Detail

SoyValueHelper

Method Detail

newEasyDict

newEasyDict

newEasyDictFromDict

newEasyDictFromJavaStringMap

newEasyList

newEasyList

newEasyListFromList

newEasyListFromJavaIterable

convert