Package org.pipecraft.infra.concurrent

Class CheckedFutureTransformer<S,T,E extends Exception>

java.lang.Object

org.pipecraft.infra.concurrent.CheckedFutureTransformer<S,T,E>

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<T>, Future<T>, CheckedFuture<T,E>

public class CheckedFutureTransformer<S,T,E extends Exception>
extends Object
implements CheckedFuture<T,E>

A CheckedFuture decorator converting a checked future with value type S to a checked future with value type T. Preserves the exception type.

Author:

Eyal Schneider

Constructor Summary

Constructors

Constructor	Description
CheckedFutureTransformer(AbstractCheckedFuture<S,E> future, Function<S,T> mappingFunction)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addListener(Runnable listener, Executor executor)
boolean	cancel(boolean mayInterruptIfRunning)
T	checkedGet()	A simplified version of Future.get() which maps ExecutionException to a more indicative exception type
T	checkedGet(long timeout, TimeUnit unit)	A simplified version of Future.get(long, TimeUnit) which maps ExecutionException to a more indicative exception type
T	get()
T	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckedFutureTransformer

public CheckedFutureTransformer(AbstractCheckedFuture<S,E> future,
                                Function<S,T> mappingFunction)

Constructor

Parameters:

future - the checked future to wrap and convert

mappingFunction - Maps results of the original future's type S to the target type T

Method Detail

checkedGet

public T checkedGet()
             throws InterruptedException,
                    E extends Exception

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

Specified by:

checkedGet in interface CheckedFuture<S,T>

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

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

Specified by:

checkedGet in interface CheckedFuture<S,T>

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

addListener

public void addListener(Runnable listener,
                        Executor executor)

Specified by:

addListener in interface com.google.common.util.concurrent.ListenableFuture<S>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<S>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<S>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<S>

get

public T get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<S>

Throws:

InterruptedException

ExecutionException

get

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

Specified by:

get in interface Future<S>

Throws:

InterruptedException

ExecutionException

TimeoutException