Package org.pipecraft.infra.concurrent

Interface CheckedFuture<V,E extends Exception>

All Superinterfaces:

Future<V>, com.google.common.util.concurrent.ListenableFuture<V>

All Known Implementing Classes:

AbstractCheckedFuture, CheckedFutureTransformer, ImmediateFuture

public interface CheckedFuture<V,E extends Exception>
extends com.google.common.util.concurrent.ListenableFuture<V>

Extends ListenableFuture and adds checkedGet() methods which simplify Future's error handling. This interface is a replacement for Google's deprecated CheckedFuture.

Author:

Eyal Schneider

Method Summary

Modifier and Type	Method	Description
V	checkedGet()	A simplified version of Future.get() which maps ExecutionException to a more indicative exception type
V	checkedGet(long timeout, TimeUnit unit)	A simplified version of Future.get(long, TimeUnit) which maps ExecutionException to a more indicative exception type

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture

addListener

Method Detail

checkedGet

V checkedGet()
      throws InterruptedException,
             E extends Exception

A simplified version of Future.get() which maps ExecutionException to a more indicative exception type

Returns:

the result of executing the future.

Throws:

InterruptedException - When the waiting for completion is interrupted

E - when an execution exception is detected and mapped

CancellationException - if the computation was cancelled

E extends Exception

checkedGet

V checkedGet(long timeout,
             TimeUnit unit)
      throws TimeoutException,
             InterruptedException,
             E extends Exception

A simplified version of Future.get(long, TimeUnit) which maps ExecutionException to a more indicative exception type

Parameters:

timeout - The timeout to apply

unit - The time unit of the timeout parameter

Returns:

the result of executing the future.

Throws:

TimeoutException - In case that the timeout period elapses

InterruptedException - When the waiting for completion is interrupted

E - when an execution exception is detected and mapped

CancellationException - if the computation was cancelled

E extends Exception