com.github.javactic.futures

Class FutureFactory<B>

java.lang.Object

com.github.javactic.futures.FutureFactory<B>

Type Parameters:

B - the bad type

public class FutureFactory<B>
extends Object

A factory for creating OrFutures that will transform unhandled exceptions into instances of Bad using the provided converter.

Field Summary

Fields

Modifier and Type	Field and Description
static FutureFactory<String>	OF_EXCEPTION_MESSAGE A default FutureFactory that will execute its tasks with the common Executors.newCachedThreadPool() and that will transform any potential exceptions into Strings using Throwable.getMessage()

Method Summary

Modifier and Type	Method and Description
FutureFactory<One<B>>	accumulating() Returns an accumulating version of this factory.
<G> OrFuture<G,B>	newFuture(Executor executor, Supplier<? extends Or<? extends G,? extends B>> task) Creates an OrFuture that will execute the given task using the provided executor.
<G> OrFuture<G,B>	newFuture(Supplier<? extends Or<? extends G,? extends B>> task) Creates an OrFuture that will execute the given task using the executor of this FutureFactory.
static <B> FutureFactory<B>	of(Executor executor, Function<? super Throwable,? extends B> exceptionConverter) Creates a new FutureFactory that will create futures that run their tasks using the given executor and transform unhandled exceptions into instances of Bad using the provided converter.
static <B> FutureFactory<B>	of(Function<? super Throwable,? extends B> exceptionConverter) Creates a new FutureFactory that will return futures that run their tasks using a common Executors.newCachedThreadPool() and transform unhandled exceptions into instances of Bad using the provided converter.

Methods inherited from class java.lang.Object

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

Field Detail

OF_EXCEPTION_MESSAGE

public static final FutureFactory<String> OF_EXCEPTION_MESSAGE

A default FutureFactory that will execute its tasks with the common Executors.newCachedThreadPool() and that will transform any potential exceptions into Strings using Throwable.getMessage()

Method Detail

of

public static <B> FutureFactory<B> of(Executor executor,
                                      Function<? super Throwable,? extends B> exceptionConverter)

Creates a new FutureFactory that will create futures that run their tasks using the given executor and transform unhandled exceptions into instances of Bad using the provided converter.

Type Parameters:

B - the bad type

Parameters:

executor - the executor to run the tasks with

exceptionConverter - a function to convert exceptions into instances of Bad

Returns:

a new future factory

of

public static <B> FutureFactory<B> of(Function<? super Throwable,? extends B> exceptionConverter)

Creates a new FutureFactory that will return futures that run their tasks using a common Executors.newCachedThreadPool() and transform unhandled exceptions into instances of Bad using the provided converter.

Type Parameters:

B - the bad type

Parameters:

exceptionConverter - a function to convert exceptions into instances of Bad

Returns:

a new future factory

newFuture

public <G> OrFuture<G,B> newFuture(Supplier<? extends Or<? extends G,? extends B>> task)

Creates an OrFuture that will execute the given task using the executor of this FutureFactory.

Type Parameters:

G - the good type

Parameters:

task - asynchronous computation to execute

Returns:

a new future that completes with the result of the supplied task, or if the execution of the task throws an exception, that exception will be handled with this factory's exception converter.

newFuture

public <G> OrFuture<G,B> newFuture(Executor executor,
                                   Supplier<? extends Or<? extends G,? extends B>> task)

Creates an OrFuture that will execute the given task using the provided executor.

Type Parameters:

G - the good type

Parameters:

executor - the executor to run the asynchronous computation on

task - asynchronous computation to execute

Returns:

a new future that completes with the result of the supplied task, or if the execution of the task throws an exception, that exception will be handled with this factory's exception converter.

accumulating

public FutureFactory<One<B>> accumulating()

Returns an accumulating version of this factory.

Returns:

an accumulating version of this factory