com.google.template.soy.data

Class SoyAbstractValue

java.lang.Object

com.google.template.soy.data.SoyAbstractValue

All Implemented Interfaces:

SoyValue, SoyValueProvider

Direct Known Subclasses:

SoyAbstractList, SoyAbstractMap, SoyAbstractRecord, SoyData

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

Nested Class Summary

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

SoyValueProvider.ResolveStatus

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.
boolean	equals(SoyValueProvider other) Note: Even though we provide a default implementation for equals(SoyValueProvider), subclasses must still implement equals(SoyValue).
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.
SoyValue	resolve() Usually, this method is a no-op that simply returns this object.
SoyValueProvider.ResolveStatus	status() Returns SoyValueProvider.ResolveStatus.isReady() 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

coerceToBoolean, coerceToString, equals, 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 SoyValueProvider.ResolveStatus status()

Description copied from interface: SoyValueProvider

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

Note, once this method returns SoyValueProvider.ResolveStatus.isReady() all future calls must also return SoyValueProvider.ResolveStatus.isReady().

Specified by:

status in interface SoyValueProvider

equals

public boolean equals(SoyValueProvider other)

Note: Even though we provide a default implementation for equals(SoyValueProvider), subclasses must still implement equals(SoyValue). Compares this value against another for equality for the purposes of Soy.

Specified by:

equals in interface SoyValueProvider

Parameters:

other - The other value to compare against.

Returns:

True if the two values are equal.

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.

render

public RenderResult render(AdvisingAppendable appendable,
                           boolean isLast)
                    throws IOException

Description copied from interface: SoyValue

Renders this value to the given AdvisingAppendable, possibly partially.

This should render the exact same content as SoyValue.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 SoyValue.render(Appendable), since the renderable content is small/trivial.

Specified by:

render in interface SoyValue

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