com.google.template.soy.data

Interface SoyValueProvider

All Known Subinterfaces:

SoyDict, SoyEasyList, SoyLegacyObjectMap, SoyList, SoyMap, SoyProtoValue, SoyRecord, SoyString, SoyValue

All Known Implementing Classes:

AugmentedParamStore, BasicParamStore, BooleanData, CollectionData, DetachableContentProvider, DetachableSoyValueProvider, DictImpl, EasyListImpl, FloatData, IntegerData, ListImpl, NullData, NumberData, ParamStore, PrimitiveData, SanitizedContent, SoyAbstractCachingValueProvider, SoyAbstractValue, SoyData, SoyFutureValueProvider, SoyListData, SoyMapData, SoyMapImpl, SoyProtoValueImpl, StringData, UndefinedData

@ParametersAreNonnullByDefault
public interface SoyValueProvider

A provider of a Soy value.

This allows for adding providers of late-resolved values (e.g. Futures) to records/maps/lists that are only resolved if the values are actually retrieved. Note that each Soy value object should itself be a provider (of itself).

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

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

resolve

@Nonnull
SoyValue resolve()

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.

Returns:

The resolved value.

status

@Nonnull
RenderResult status()

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

renderAndResolve

RenderResult renderAndResolve(LoggingAdvisingAppendable appendable,
                              boolean isLast)
                       throws IOException

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.

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