com.google.template.soy.data

Interface SoyValue

All Superinterfaces:

SoyValueProvider

All Known Subinterfaces:

SoyDict, SoyEasyDict, SoyEasyList, SoyList, SoyMap, SoyRecord

All Known Implementing Classes:

AugmentedParamStore, BasicParamStore, BooleanData, CollectionData, DictImpl, EasyDictImpl, EasyListImpl, FloatData, IntegerData, ListImpl, NullData, NumberData, ParamStore, PrimitiveData, SanitizedContent, SoyAbstractCachingRecord, SoyAbstractList, SoyAbstractMap, SoyAbstractRecord, SoyAbstractValue, SoyData, SoyListData, SoyMapData, StringData, UndefinedData

@ParametersAreNonnullByDefault
public interface SoyValue
extends SoyValueProvider

Superinterface of all Soy value interfaces/classes. Replaces the old SoyData.

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
boolean	booleanValue() Precondition: Only call this method if you know that this SoyValue object is a boolean.
boolean	coerceToBoolean() Coerces this value into a boolean.
String	coerceToString() Coerces this value into a string.
boolean	equals(SoyValue other) Compares this value against another for equality in the sense of the '==' operator of Soy.
double	floatValue() Precondition: Only call this method if you know that this SoyValue object is a float.
int	integerValue() Precondition: Only call this method if you know that this SoyValue object is a 32-bit integer.
long	longValue() Precondition: Only call this method if you know that this SoyValue object is an integer or long.
double	numberValue() Precondition: Only call this method if you know that this SoyValue object is a number.
RenderResult	render(AdvisingAppendable appendable, boolean isLast) Renders this value to the given AdvisingAppendable, possibly partially.
void	render(Appendable appendable) Renders this value to the given appendable.
String	stringValue() Precondition: Only call this method if you know that this SoyValue object is a string.

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

equals, resolve, status

Method Detail

equals

boolean equals(SoyValue other)

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.

coerceToBoolean

boolean coerceToBoolean()

Coerces this value into a boolean.

Returns:

This value coerced into a boolean.

coerceToString

String coerceToString()

Coerces this value into a string.

Returns:

This value coerced into a string.

render

void render(Appendable appendable)
     throws IOException

Renders this value to the given appendable.

This should behave identically to appendable.append(coerceToString()) but is provided separately to allow more incremental approaches.

Parameters:

appendable - The appendable to render to.

Throws:

IOException

render

RenderResult render(AdvisingAppendable appendable,
                    boolean isLast)
             throws IOException

Renders this value to the given AdvisingAppendable, possibly partially.

This should render the exact same content as render(Appendable) but may optionally detach part of the way through rendering. Note, this means that this method is stateful and if it returns something besides RenderResult.done() then the next call to this method will resume rendering from the previous point.

It is expected that most implementations will simply delegate to render(Appendable), since the renderable content is small/trivial.

Parameters:

appendable - The appendable to render to.

isLast - True if this is definitely the last time this value will be rendered. Used as a hint to implementations to not optimize for later calls (for example, by storing render results in a buffer for faster re-renders). The value of this parameter should not affect behavior of this method, only performance.

Throws:

IOException - If the appendable throws an IOException

booleanValue

boolean booleanValue()

Precondition: Only call this method if you know that this SoyValue object is a boolean. This method gets the boolean value of this boolean object.

Returns:

The boolean value of this boolean object.

Throws:

SoyDataException - If this object is not actually a boolean.

integerValue

int integerValue()

Precondition: Only call this method if you know that this SoyValue object is a 32-bit integer. This method gets the integer value of this integer object.

Returns:

The integer value of this integer object.

Throws:

SoyDataException - If this object is not actually an integer.

longValue

long longValue()

Precondition: Only call this method if you know that this SoyValue object is an integer or long. This method gets the integer value of this integer object.

Returns:

The integer value of this integer object.

Throws:

SoyDataException - If this object is not actually an integer.

floatValue

double floatValue()

Precondition: Only call this method if you know that this SoyValue object is a float. This method gets the float value of this float object.

Returns:

The float value of this float object.

Throws:

SoyDataException - If this object is not actually a float.

numberValue

double numberValue()

Precondition: Only call this method if you know that this SoyValue object is a number. This method gets the float value of this number object (converting integer to float if necessary).

Returns:

The float value of this number object.

Throws:

SoyDataException - If this object is not actually a number.

stringValue

String stringValue()

Precondition: Only call this method if you know that this SoyValue object is a string. This method gets the string value of this string object.

Returns:

The string value of this string object.

Throws:

SoyDataException - If this object is not actually a string.