com.google.template.soy.data

Class SoyAbstractValue

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

All Implemented Interfaces:

SoyValue, SoyValueProvider

Direct Known Subclasses:

DictImpl, EasyListImpl, ListImpl, ParamStore, SoyData, SoyMapImpl, SoyProtoValueImpl

@ParametersAreNonnullByDefault
public abstract class SoyAbstractValue
extends Object
implements SoyValue

Abstract implementation of SoyValue.

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

Constructor Summary

Constructors

Constructor and Description
SoyAbstractValue()

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.
abstract boolean	equals(Object 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.
void	render(Appendable appendable) Renders this value to the given appendable.
RenderResult	renderAndResolve(LoggingAdvisingAppendable appendable, boolean isLast) Renders this value to the given LoggingAdvisingAppendable, possibly partially.
SoyValue	resolve() Usually, this method is a no-op that simply returns this object.
RenderResult	status() Returns RenderResult.done() if the value provider can be resolved without blocking on a future.
String	stringValue() Precondition: Only call this method if you know that this SoyValue object is a string.

Methods inherited from class java.lang.Object

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

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

coerceToBoolean, coerceToString, render

Constructor Detail

SoyAbstractValue

public SoyAbstractValue()

Method Detail

resolve

@Nonnull
public SoyValue resolve()

Description copied from interface: SoyValueProvider

Usually, this method is a no-op that simply returns this object. However, if this value needs to be resolved at usage time, then this method resolves and returns the resolved value.

Specified by:

resolve in interface SoyValueProvider

Returns:

The resolved value.

status

@Nonnull
public RenderResult status()

Description copied from interface: SoyValueProvider

Returns RenderResult.done() if the value provider can be resolved without blocking on a future. Otherwise, returns a RenderResult that holds the future.

Note, once this method returns RenderResult.done() all future calls must also return RenderResult.done().

This method will never return a limited RenderResult

Specified by:

status in interface SoyValueProvider

render

public final void render(Appendable appendable)
                  throws IOException

Description copied from interface: SoyValue

Renders this value to the given appendable.

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

Specified by:

render in interface SoyValue

Parameters:

appendable - The appendable to render to.

Throws:

IOException

renderAndResolve

public RenderResult renderAndResolve(LoggingAdvisingAppendable appendable,
                                     boolean isLast)
                              throws IOException

Description copied from interface: SoyValueProvider

Renders this value to the given LoggingAdvisingAppendable, possibly partially.

This should render the exact same content as resolve().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.

Specified by:

renderAndResolve in interface SoyValueProvider

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.

Returns:

A RenderResult that describes whether or not rendering completed. If the returned result is not done, then to complete rendering you must call this method again.

Throws:

IOException - If the appendable throws an IOException

equals

public abstract boolean equals(Object other)

Description copied from interface: SoyValue

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

Specified by:

equals in interface SoyValue

Overrides:

equals in class Object

Parameters:

other - The other value to compare against.

Returns:

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

booleanValue

public boolean booleanValue()

Description copied from interface: SoyValue

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.

Specified by:

booleanValue in interface SoyValue

Returns:

The boolean value of this boolean object.

integerValue

public int integerValue()

Description copied from interface: SoyValue

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.

Specified by:

integerValue in interface SoyValue

Returns:

The integer value of this integer object.

longValue

public long longValue()

Description copied from interface: SoyValue

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.

Specified by:

longValue in interface SoyValue

Returns:

The integer value of this integer object.

floatValue

public double floatValue()

Description copied from interface: SoyValue

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.

Specified by:

floatValue in interface SoyValue

Returns:

The float value of this float object.

numberValue

public double numberValue()

Description copied from interface: SoyValue

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).

Specified by:

numberValue in interface SoyValue

Returns:

The float value of this number object.

stringValue

public String stringValue()

Description copied from interface: SoyValue

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.

Specified by:

stringValue in interface SoyValue

Returns:

The string value of this string object.