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(SoyValueHelper valueHelper,
                        Future<?> future)

  Parameters:

  valueHelper - The instance of SoyValueHelper 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