Modifier and Type	Class and Description
public abstract static class	ForwardingFuture.SimpleForwardingFuture<V extends @Nullable Object> A simplified version of `ForwardingFuture` where subclasses can pass in an already constructed `Future` as the delegate.

Access	Constructor and Description
protected	ForwardingFuture() Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
public boolean	cancel(boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
protected abstract Future<? extends V>	delegate() Implements abstract com.google.common.collect.ForwardingObject.delegate. Returns the backing delegate instance that methods are forwarded to.
public V	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public V	get(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.

Inherited from com.google.common.collect.ForwardingObject:: toString

Constructor Detail

ForwardingFuture	back to summary
protected ForwardingFuture() Constructor for use by subclasses.

Method Detail

cancel back to summary

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Doc from java.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. Parameters mayInterruptIfRunning:boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete Returns:boolean `false` if the task could not be cancelled, typically because it has already completed; `true` otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns `true`. Implementations may provide stronger guarantees. Annotations @Override @CanIgnoreReturnValue

public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Parameters

mayInterruptIfRunning:boolean: true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete

Returns:boolean

false if the task could not be cancelled, typically because it has already completed; true otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true. Implementations may provide stronger guarantees.

Annotations

@Override
@CanIgnoreReturnValue

delegate back to summary

delegate	back to summary
protected abstract Future<? extends V> delegate() Implements abstract com.google.common.collect.ForwardingObject.delegate. Doc from com.google.common.collect.ForwardingObject.delegate. Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as `ForwardingSet#delegate`. Concrete subclasses override this method to supply the instance being decorated. Annotations @Override

protected abstract Future<? extends V> delegate()

Implements abstract com.google.common.collect.ForwardingObject.delegate.

Doc from com.google.common.collect.ForwardingObject.delegate.

Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet#delegate. Concrete subclasses override this method to supply the instance being decorated.

Annotations

@Override

get	back to summary
public V get() throws InterruptedException, ExecutionException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Returns:V the computed result Annotations @Override @CanIgnoreReturnValue @ParametricNullness Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception

get

back to summary

public V get() throws InterruptedException, ExecutionException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:V

the computed result

Annotations

@Override
@CanIgnoreReturnValue
@ParametricNullness

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception

get	back to summary
public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:V the computed result Annotations @Override @CanIgnoreReturnValue @ParametricNullness Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception TimeoutException: if the wait timed out

get

back to summary

public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:V

the computed result

Annotations

@Override
@CanIgnoreReturnValue
@ParametricNullness

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception
TimeoutException:: if the wait timed out

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Returns:boolean `true` if this task was cancelled before it completed Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Returns:boolean

true if this task was cancelled before it completed

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Returns:boolean `true` if this task completed Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:boolean

true if this task completed

Annotations

@Override

com.google.common.util.concurrent back to summary

public abstract Class ForwardingFuture.SimpleForwardingFuture<V extends @Nullable Object>

Class Inheritance

extends ForwardingFuture<V extends @Nullable Object>

java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.util.concurrent.ForwardingFuture
com.google.common.util.concurrent.ForwardingFuture.SimpleForwardingFuture

A simplified version of ForwardingFuture where subclasses can pass in an already constructed Future as the delegate.

Since: 9.0

Field Summary

Modifier and Type	Field and Description
private final Future<V>	delegate

Constructor Summary

Access	Constructor and Description
protected	SimpleForwardingFuture(Future<V> delegate)

Method Summary

Modifier and Type	Method and Description
protected final Future<V>	delegate() Implements abstract com.google.common.util.concurrent.ForwardingFuture.delegate. Returns the backing delegate instance that methods are forwarded to.

Inherited from com.google.common.util.concurrent.ForwardingFuture:: cancel get get isCancelled isDone

Field Detail

delegate	back to summary
private final Future<V> delegate

Constructor Detail

SimpleForwardingFuture	back to summary
protected SimpleForwardingFuture(Future<V> delegate)

Method Detail

delegate back to summary

delegate	back to summary
protected final Future<V> delegate() Implements abstract com.google.common.util.concurrent.ForwardingFuture.delegate. Doc from com.google.common.collect.ForwardingObject.delegate. Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as `ForwardingSet#delegate`. Concrete subclasses override this method to supply the instance being decorated. Annotations @Override

protected final Future<V> delegate()

Implements abstract com.google.common.util.concurrent.ForwardingFuture.delegate.

Doc from com.google.common.collect.ForwardingObject.delegate.

Annotations