net.jodah.failsafe

Class FailsafeFuture<T>

java.lang.Object

net.jodah.failsafe.FailsafeFuture<T>

Type Parameters:

T - result type

All Implemented Interfaces:

Future<T>

public class FailsafeFuture<T>
extends Object
implements Future<T>

The future result of an asynchronous Failsafe execution.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Attempts to cancel this execution.
T	get() Waits if necessary for the execution to complete, and then returns its result.
T	get(long timeout, TimeUnit unit) Waits if necessary for at most the given time for the execution to complete, and then returns its result, if available.
boolean	isCancelled() Returns true if this execution was cancelled before it completed normally.
boolean	isDone() Returns true if this execution completed.

Methods inherited from class java.lang.Object

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

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Attempts to cancel this execution. This attempt will fail if the execution has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and this execution has not started when cancel is called, this execution should never run. If the execution has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the execution.

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

Specified by:

cancel in interface Future<T>

Parameters:

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

Returns:

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

get

public T get()
      throws InterruptedException,
             ExecutionException

Waits if necessary for the execution to complete, and then returns its result.

Specified by:

get in interface Future<T>

Returns:

the execution result

Throws:

CancellationException - if the execution was cancelled

ExecutionException - if the execution threw an exception

InterruptedException - if the current thread was interrupted while waiting

get

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

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

Specified by:

get in interface Future<T>

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the execution result

Throws:

CancellationException - if the execution was cancelled

ExecutionException - if the execution threw an exception

InterruptedException - if the current thread was interrupted while waiting

TimeoutException - if the wait timed out

NullPointerException - if unit is null

IllegalArgumentException - if timeout is < 0

isCancelled

public boolean isCancelled()

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

Specified by:

isCancelled in interface Future<T>

Returns:

true if this execution was cancelled before it completed

isDone

public boolean isDone()

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

Specified by:

isDone in interface Future<T>

Returns:

true if this execution completed