Class TimeoutFuture<V>

All Implemented Interfaces:
AbstractFuture.Trusted<V>, ListenableFuture<V>, Future<V>

final class TimeoutFuture<V> extends FluentFuture.TrustedFuture<V>
Implementation of Futures#withTimeout.

Future that delegates to another but will finish early (via a TimeoutException wrapped in an ExecutionException) if the specified duration expires. The delegate future is interrupted and cancelled if it times out.

  • Field Details

  • Constructor Details

  • Method Details

    • create

      static <V> ListenableFuture<V> create(ListenableFuture<V> delegate, long time, TimeUnit unit, ScheduledExecutorService scheduledExecutor)
    • pendingToString

      @CheckForNull protected String pendingToString()
      Description copied from class: AbstractFuture
      Provide a human-readable explanation of why this future has not yet completed.
      Overrides:
      pendingToString in class AbstractFuture<V>
      Returns:
      null if an explanation cannot be provided (e.g. because the future is done).
    • afterDone

      protected void afterDone()
      Description copied from class: AbstractFuture
      Callback method that is called exactly once after the future is completed.

      If AbstractFuture.interruptTask() is also run during completion, AbstractFuture.afterDone() runs after it.

      The default implementation of this method in AbstractFuture does nothing. This is intended for very lightweight cleanup work, for example, timing statistics or clearing fields. If your task does anything heavier consider, just using a listener with an executor.

      Overrides:
      afterDone in class AbstractFuture<V>