org.apache.hc.core5.concurrent

Class ComplexFuture<T>

java.lang.Object

org.apache.hc.core5.concurrent.BasicFuture<T>

org.apache.hc.core5.concurrent.ComplexFuture<T>

Type Parameters:

T - the future result type of an asynchronous operation.

All Implemented Interfaces:

Future<T>, Cancellable, CancellableDependency

public final class ComplexFuture<T>
extends BasicFuture<T>
implements CancellableDependency

Future whose result depends on another Cancellable process or operation or another Future. Dependent process will get cancelled if the future itself is cancelled.

Since:

5.0

Constructor Summary

Constructors

Constructor and Description
ComplexFuture(FutureCallback<T> callback)

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Attempts to cancel execution of this task.
boolean	completed(T result)
boolean	failed(Exception exception)
void	setDependency(Cancellable dependency) Sets Cancellable dependency on another ongoing process or operation represented by Cancellable.
void	setDependency(Future<?> dependency)

Methods inherited from class org.apache.hc.core5.concurrent.BasicFuture

cancel, get, get, isCancelled, isDone

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hc.core5.concurrent.CancellableDependency

isCancelled

Methods inherited from interface org.apache.hc.core5.concurrent.Cancellable

cancel

Constructor Detail

ComplexFuture

public ComplexFuture(FutureCallback<T> callback)

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Description copied from interface: Future

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and 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 should be interrupted in an attempt to stop the task.

After this method returns, subsequent calls to Future.isDone() will always return true. Subsequent calls to Future.isCancelled() will always return true if this method returned true.

Specified by:

cancel in interface Future<T>

Overrides:

cancel in class BasicFuture<T>

Parameters:

mayInterruptIfRunning - true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

completed

public boolean completed(T result)

Overrides:

completed in class BasicFuture<T>

failed

public boolean failed(Exception exception)

Overrides:

failed in class BasicFuture<T>

setDependency

public void setDependency(Cancellable dependency)

Description copied from interface: CancellableDependency

Sets Cancellable dependency on another ongoing process or operation represented by Cancellable.

Specified by:

setDependency in interface CancellableDependency

setDependency

public void setDependency(Future<?> dependency)