com.google.template.soy.data

Class SoyData

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

com.google.template.soy.data.SoyData

All Implemented Interfaces:

SoyValue, SoyValueProvider

Direct Known Subclasses:

CollectionData, PrimitiveData, SanitizedContent

public abstract class SoyData
extends SoyAbstractValue

Abstract base class for all nodes in a Soy data tree.

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

Nested Class Summary

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

SoyValueProvider.ResolveStatus

Constructor Summary

Constructors

Constructor and Description
SoyData()

Method Summary

Modifier and Type	Method and Description
boolean	coerceToBoolean() Coerces this value into a boolean.
String	coerceToString() Coerces this value into a string.
static SoyData	createFromExistingData(Object obj) Creation function for creating a SoyData object out of any existing primitive, data object, or data structure.
abstract boolean	equals(Object other) This was a required method in the old SoyData interface.
boolean	equals(SoyValue other) Compares this value against another for equality in the sense of the '==' operator of Soy.
abstract boolean	toBoolean() Deprecated.
abstract String	toString() This was a required method in the old SoyData interface.

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

booleanValue, equals, floatValue, integerValue, longValue, numberValue, render, resolve, status, stringValue

Methods inherited from class java.lang.Object

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

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

render

Constructor Detail

SoyData

public SoyData()

Method Detail

createFromExistingData

public static SoyData createFromExistingData(Object obj)

Creation function for creating a SoyData object out of any existing primitive, data object, or data structure.

Important: Avoid using this function if you know the type of the object at compile time. For example, if the object is a primitive, it can be passed directly to methods such as SoyMapData.put() or SoyListData.add(). If the object is a Map or an Iterable, you can directly create the equivalent SoyData object using the constructor of SoyMapData or SoyListData.

If the given object is already a SoyData object, then it is simply returned. Otherwise a new SoyData object will be created that is equivalent to the given primitive, data object, or data structure (even if the given object is null!).

Note that in order for the conversion process to succeed, the given data structure must correspond to a valid SoyData tree. Some requirements include: (a) all Maps within your data structure must have string keys that are identifiers, (b) all non-leaf nodes must be Maps or Lists, (c) all leaf nodes must be null, boolean, int, double, or String (corresponding to Soy primitive data types null, boolean, integer, float, string).

Any object returned from this function should be regarded as immutable; Avoid downcasting to specific types unless you know what you're doing.

Parameters:

obj - The existing object or data structure to convert.

Returns:

A SoyData object or tree that corresponds to the given object.

Throws:

SoyDataException - If the given object cannot be converted to SoyData.

equals

public boolean equals(SoyValue other)

Description copied from interface: SoyValue

Compares this value against another for equality in the sense of the '==' operator of Soy.

Parameters:

other - The other value to compare against.

Returns:

True if this value is equal to the other in the sense of Soy.

equals

public abstract boolean equals(Object other)

This was a required method in the old SoyData interface. For new data classes, please use interface SoyValue, which has the method equals(SoyValue). Compares this data object against another for equality in the sense of the operator '==' for Soy expressions.

Overrides:

equals in class Object

Parameters:

other - The other data object to compare against.

Returns:

True if the two objects are equal.

coerceToBoolean

public boolean coerceToBoolean()

Description copied from interface: SoyValue

Coerces this value into a boolean.

Returns:

This value coerced into a boolean.

toBoolean

@Deprecated
public abstract boolean toBoolean()

Deprecated.

This was a required method in the old SoyData interface. For new data classes, please use interface SoyValue, which has the method coerceToBoolean(). Converts this data object into a boolean (e.g. when used in a boolean context). In other words, this method tells whether this object is truthy.

Returns:

The value of this data object if coerced into a boolean. I.e. true if this object is truthy, false if this object is falsy.

coerceToString

public String coerceToString()

Description copied from interface: SoyValue

Coerces this value into a string.

Returns:

This value coerced into a string.

toString

public abstract String toString()

This was a required method in the old SoyData interface. For new data classes, please use interface SoyValue, which has the method coerceToString(). Converts this data object into a string (e.g. when used in a string context).

Overrides:

toString in class Object

Returns:

The value of this data object if coerced into a string.