Package io.foldright.cffu.lf

Class ListenableFutureUtils

java.lang.Object

io.foldright.cffu.lf.ListenableFutureUtils

public final class ListenableFutureUtils
extends Object

Integration with guava ListenableFuture.

Author:

Jerry Lee (oldratlee at gmail dot com), HuHao (995483610 at qq dot com), Eric Lin (linqinghua4 at gmail dot com)

Method Summary

Modifier and Type	Method	Description
static <T> Cffu<T>	toCffu(ListenableFuture<T> lf, CffuFactory cffuFactory, boolean interruptLfWhenCancellationException)	Converts input ListenableFuture to Cffu.
static <T> CompletableFuture<T>	toCompletableFuture(ListenableFuture<T> lf, Executor executor, boolean interruptLfWhenCancellationException)	Converts input ListenableFuture to CompletableFuture.
static <T> ListenableFuture<T>	toListenableFuture(Cffu<T> cf)	Converts input Cffu to ListenableFuture.
static <T> ListenableFuture<T>	toListenableFuture(CompletableFuture<T> cf)	Converts input CompletableFuture to ListenableFuture.

Methods inherited from class java.lang.Object

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

Method Details

toCompletableFuture

@Contract(pure=true)
public static <T> CompletableFuture<T> toCompletableFuture(ListenableFuture<T> lf,
 Executor executor,
 boolean interruptLfWhenCancellationException)

Converts input ListenableFuture to CompletableFuture.

Callback from ListenableFuture is executed using the given executor, use MoreExecutors.directExecutor() if you need skip the execution switch.

Cancelling(Future.cancel(boolean)) the returned CompletableFuture will also cancel underlying ListenableFuture.

Use param interruptLfWhenCancellationException to control whether to cancel ListenableFuture with interruption when CancellationException occurred (including CompletionException/ExecutionException with CancellationException cause, more info see CompletableFutureUtils.unwrapCfException(Throwable)).

It's recommended to avoid using direct write methods(e.g. CompletableFuture.complete(Object), CompletableFuture.completeExceptionally(Throwable)) of the returned CompletableFuture:

• the underlying ListenableFuture can benefit from cancellation propagation.
• the writing of the returned CompletableFuture won't affect the underlying ListenableFuture.

Parameters:

lf - the underlying ListenableFuture

executor - the executor to use for ListenableFuture callback execution

interruptLfWhenCancellationException - whether to cancel ListenableFuture with interruption when CancellationException occurred

Returns:

the CompletableFuture adapter

See Also:

• CompletableFuture.cancel(boolean)

toCffu

@Contract(pure=true)
public static <T> Cffu<T> toCffu(ListenableFuture<T> lf,
 CffuFactory cffuFactory,
 boolean interruptLfWhenCancellationException)

Converts input ListenableFuture to Cffu.

Callback from ListenableFuture is executed using cffuFactory's default executor.

More info see toCompletableFuture(ListenableFuture, Executor, boolean).

toListenableFuture

@Contract(pure=true)
public static <T> ListenableFuture<T> toListenableFuture(CompletableFuture<T> cf)

Converts input CompletableFuture to ListenableFuture.

toListenableFuture

@Contract(pure=true)
public static <T> ListenableFuture<T> toListenableFuture(Cffu<T> cf)

Converts input Cffu to ListenableFuture.