com.google.template.soy.data

Class SoyFutureValueProvider

java.lang.Object

com.google.template.soy.data.SoyAbstractCachingValueProvider

com.google.template.soy.data.SoyFutureValueProvider

All Implemented Interfaces:

SoyValueProvider

public final class SoyFutureValueProvider
extends SoyAbstractCachingValueProvider

Important: Do not use outside of Soy code (treat as superpackage-private).

SoyValueProvider implementation that represents a wrapped future.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SoyFutureValueProvider.FutureBlockCallback A callback that gets fired just before this provider will block on a future.

Nested classes/interfaces inherited from class com.google.template.soy.data.SoyAbstractCachingValueProvider

SoyAbstractCachingValueProvider.ValueAssertion

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<SoyFutureValueProvider.FutureBlockCallback>	futureBlockCallback Allows threads to register a SoyFutureValueProvider.FutureBlockCallback.

Constructor Summary

Constructors

Constructor and Description
SoyFutureValueProvider(Future<?> future)

Method Summary

Modifier and Type	Method and Description
protected SoyValue	compute() Calls Future.get() and then converts the result to SoyValue.
RenderResult	status() Returns RenderResult.done() if the value provider can be resolved without blocking on a future.

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

addValueAssertion, hashCode, isComputed, renderAndResolve, resolve

Methods inherited from class java.lang.Object

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

Field Detail

futureBlockCallback

public static final ThreadLocal<SoyFutureValueProvider.FutureBlockCallback> futureBlockCallback

Allows threads to register a SoyFutureValueProvider.FutureBlockCallback.

When calling SoyAbstractCachingValueProvider.resolve() on this SoyFutureValueProvider, if the thread needs to block on the future (because Future.isDone() is false), then it will call the currently registered block callback immediately prior blocking. See RenderVisitor.exec for the motivating usecase for this hook.

Important: Do not use outside of Soy code (treat as superpackage-private).

Constructor Detail

SoyFutureValueProvider

public SoyFutureValueProvider(Future<?> future)

Parameters:

valueConverter - The instance of SoyValueConverter to use for converting the future value (after retrieval).

future - The underlying Future object.

Method Detail

status

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

compute

@Nonnull
protected final SoyValue compute()

Calls Future.get() and then converts the result to SoyValue. Note that this result can never return null, since null converts to NullData.INSTANCE.

Specified by:

compute in class SoyAbstractCachingValueProvider