Package org.docx4j.com.google.common.util.concurrent

Class TimeoutFuture<V>

java.lang.Object

org.docx4j.com.google.common.util.concurrent.internal.InternalFutureFailureAccess

org.docx4j.com.google.common.util.concurrent.AbstractFuture<V>

org.docx4j.com.google.common.util.concurrent.GwtFluentFutureCatchingSpecialization<V>

org.docx4j.com.google.common.util.concurrent.FluentFuture<V>

org.docx4j.com.google.common.util.concurrent.FluentFuture.TrustedFuture<V>

org.docx4j.com.google.common.util.concurrent.TimeoutFuture<V>

All Implemented Interfaces:

Future<V>, AbstractFuture.Trusted<V>, ListenableFuture<V>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	TimeoutFuture.Fire<V>	A runnable that is called when the delegate or the timer completes.
private static final class	TimeoutFuture.TimeoutFutureException

Nested classes/interfaces inherited from class org.docx4j.com.google.common.util.concurrent.FluentFuture

FluentFuture.TrustedFuture<V>

Nested classes/interfaces inherited from class org.docx4j.com.google.common.util.concurrent.AbstractFuture

AbstractFuture.Trusted<V>

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable ListenableFuture<V>	delegateRef
private @Nullable ScheduledFuture<?>	timer

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TimeoutFuture(ListenableFuture<V> delegate)

Method Summary

Modifier and Type	Method	Description
protected void	afterDone()	Callback method that is called exactly once after the future is completed.
(package private) static <V> ListenableFuture<V>	create(ListenableFuture<V> delegate, long time, TimeUnit unit, ScheduledExecutorService scheduledExecutor)
protected String	pendingToString()	Provide a human-readable explanation of why this future has not yet completed.

Methods inherited from class org.docx4j.com.google.common.util.concurrent.FluentFuture.TrustedFuture

addListener, cancel, get, get, isCancelled, isDone

Methods inherited from class org.docx4j.com.google.common.util.concurrent.FluentFuture

from, withTimeout

Methods inherited from class org.docx4j.com.google.common.util.concurrent.AbstractFuture

interruptTask, maybePropagateCancellationTo, set, setException, setFuture, toString, tryInternalFastPathGetFailure, wasInterrupted

Methods inherited from class java.lang.Object

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

Field Details

delegateRef

private @Nullable ListenableFuture<V> delegateRef

timer

private @Nullable ScheduledFuture<?> timer

Constructor Details

TimeoutFuture

private TimeoutFuture(ListenableFuture<V> delegate)

Method Details

create

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

pendingToString

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