com.mingweisamuel.zyra.util

Class LazyResetableFuture<T>

java.lang.Object

com.mingweisamuel.zyra.util.Lazy<T>

com.mingweisamuel.zyra.util.LazyResetable<CompletableFuture<T>>

com.mingweisamuel.zyra.util.LazyResetableFuture<T>

All Implemented Interfaces:

CompletionStage<T>, Supplier<CompletableFuture<T>>

public final class LazyResetableFuture<T>
extends LazyResetable<CompletableFuture<T>>
implements CompletionStage<T>

A Lazy specifically for CompletableFutures with reset functionality. Adds the join() method for convenience.

Note: Methods implementing CompletionStage keep a reference to the original LazyResetableFuture so they should be used with caution to avoid memory leaks.

Field Summary

Fields inherited from class com.mingweisamuel.zyra.util.Lazy

supplier, value

Constructor Summary

Constructors

Constructor and Description
LazyResetableFuture(Supplier<CompletableFuture<T>> supplier) Creates a LazyResetableFuture using SUPPLIER.

Method Summary

Modifier and Type	Method and Description
LazyResetableFuture<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
LazyResetableFuture<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
LazyResetableFuture<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> LazyResetableFuture<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> LazyResetableFuture<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> LazyResetableFuture<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
static <T> LazyResetableFuture<T>	completedFuture(T value) Creates a completed LazyResetableFuture.
LazyResetableFuture<T>	exceptionally(Function<Throwable,? extends T> fn)
<U> LazyResetableFuture<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
<U> LazyResetableFuture<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
<U> LazyResetableFuture<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
boolean	isDone() Returns whether the value has been received.
T	join() Synchronously returns the result of the inner CompletableFuture.
LazyResetableFuture<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
LazyResetableFuture<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
LazyResetableFuture<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
LazyResetableFuture<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
LazyResetableFuture<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
LazyResetableFuture<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
static <T> LazyResetableFuture<T>	startedFuture(CompletableFuture<T> future) Creates a LazyResetableFuture with a future that has already been started.
LazyResetableFuture<Void>	thenAccept(Consumer<? super T> action)
LazyResetableFuture<Void>	thenAcceptAsync(Consumer<? super T> action)
LazyResetableFuture<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> LazyResetableFuture<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> LazyResetableFuture<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> LazyResetableFuture<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
<U> LazyResetableFuture<U>	thenApply(Function<? super T,? extends U> fn)
<U> LazyResetableFuture<U>	thenApplyAsync(Function<? super T,? extends U> fn)
<U> LazyResetableFuture<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
<U,V> LazyResetableFuture<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> LazyResetableFuture<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> LazyResetableFuture<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
<U> LazyResetableFuture<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> LazyResetableFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
<U> LazyResetableFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
LazyResetableFuture<Void>	thenRun(Runnable action)
LazyResetableFuture<Void>	thenRunAsync(Runnable action)
LazyResetableFuture<Void>	thenRunAsync(Runnable action, Executor executor)
CompletableFuture<T>	toCompletableFuture()
LazyResetableFuture<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
LazyResetableFuture<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
LazyResetableFuture<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)

Methods inherited from class com.mingweisamuel.zyra.util.LazyResetable

created, getInternal, reset

Methods inherited from class com.mingweisamuel.zyra.util.Lazy

get

Methods inherited from class java.lang.Object

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

Constructor Detail

LazyResetableFuture

public LazyResetableFuture(Supplier<CompletableFuture<T>> supplier)

Creates a LazyResetableFuture using SUPPLIER.

Parameters:

supplier - Supplier of the value. May be called multiple times on failure.

Method Detail

completedFuture

public static <T> LazyResetableFuture<T> completedFuture(T value)

Creates a completed LazyResetableFuture.

Type Parameters:

T - Value's type.

Parameters:

value - The resulting value.

Returns:

A completed LazyResetableFuture.

startedFuture

public static <T> LazyResetableFuture<T> startedFuture(CompletableFuture<T> future)

Creates a LazyResetableFuture with a future that has already been started.

Type Parameters:

T - Value's type.

Parameters:

future - The future.

Returns:

A started LazyResetableFuture.

join

public T join()

Synchronously returns the result of the inner CompletableFuture. May throw exceptions.

Returns:

The inner value.

isDone

public boolean isDone()

Returns whether the value has been received. This means the CompletableFuture has been both created and completed.

Returns:

true if completed and data is available. false otherwise.

thenApply

public <U> LazyResetableFuture<U> thenApply(Function<? super T,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<T>

thenApplyAsync

public <U> LazyResetableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenApplyAsync

public <U> LazyResetableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn,
                                                 Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenAccept

public LazyResetableFuture<Void> thenAccept(Consumer<? super T> action)

Specified by:

thenAccept in interface CompletionStage<T>

thenAcceptAsync

public LazyResetableFuture<Void> thenAcceptAsync(Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenAcceptAsync

public LazyResetableFuture<Void> thenAcceptAsync(Consumer<? super T> action,
                                                 Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenRun

public LazyResetableFuture<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

thenRunAsync

public LazyResetableFuture<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenRunAsync

public LazyResetableFuture<Void> thenRunAsync(Runnable action,
                                              Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenCombine

public <U,V> LazyResetableFuture<V> thenCombine(CompletionStage<? extends U> other,
                                                BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombine in interface CompletionStage<T>

thenCombineAsync

public <U,V> LazyResetableFuture<V> thenCombineAsync(CompletionStage<? extends U> other,
                                                     BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenCombineAsync

public <U,V> LazyResetableFuture<V> thenCombineAsync(CompletionStage<? extends U> other,
                                                     BiFunction<? super T,? super U,? extends V> fn,
                                                     Executor executor)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenAcceptBoth

public <U> LazyResetableFuture<Void> thenAcceptBoth(CompletionStage<? extends U> other,
                                                    BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBoth in interface CompletionStage<T>

thenAcceptBothAsync

public <U> LazyResetableFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                         BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

thenAcceptBothAsync

public <U> LazyResetableFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                         BiConsumer<? super T,? super U> action,
                                                         Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

runAfterBoth

public LazyResetableFuture<Void> runAfterBoth(CompletionStage<?> other,
                                              Runnable action)

Specified by:

runAfterBoth in interface CompletionStage<T>

runAfterBothAsync

public LazyResetableFuture<Void> runAfterBothAsync(CompletionStage<?> other,
                                                   Runnable action)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

runAfterBothAsync

public LazyResetableFuture<Void> runAfterBothAsync(CompletionStage<?> other,
                                                   Runnable action,
                                                   Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

applyToEither

public <U> LazyResetableFuture<U> applyToEither(CompletionStage<? extends T> other,
                                                Function<? super T,U> fn)

Specified by:

applyToEither in interface CompletionStage<T>

applyToEitherAsync

public <U> LazyResetableFuture<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                                     Function<? super T,U> fn)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

applyToEitherAsync

public <U> LazyResetableFuture<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                                     Function<? super T,U> fn,
                                                     Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

acceptEither

public LazyResetableFuture<Void> acceptEither(CompletionStage<? extends T> other,
                                              Consumer<? super T> action)

Specified by:

acceptEither in interface CompletionStage<T>

acceptEitherAsync

public LazyResetableFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                                   Consumer<? super T> action)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

acceptEitherAsync

public LazyResetableFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                                   Consumer<? super T> action,
                                                   Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

runAfterEither

public LazyResetableFuture<Void> runAfterEither(CompletionStage<?> other,
                                                Runnable action)

Specified by:

runAfterEither in interface CompletionStage<T>

runAfterEitherAsync

public LazyResetableFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                     Runnable action)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

runAfterEitherAsync

public LazyResetableFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                     Runnable action,
                                                     Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

thenCompose

public <U> LazyResetableFuture<U> thenCompose(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenCompose in interface CompletionStage<T>

thenComposeAsync

public <U> LazyResetableFuture<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface CompletionStage<T>

thenComposeAsync

public <U> LazyResetableFuture<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn,
                                                   Executor executor)

Specified by:

thenComposeAsync in interface CompletionStage<T>

exceptionally

public LazyResetableFuture<T> exceptionally(Function<Throwable,? extends T> fn)

Specified by:

exceptionally in interface CompletionStage<T>

whenComplete

public LazyResetableFuture<T> whenComplete(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<T>

whenCompleteAsync

public LazyResetableFuture<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

whenCompleteAsync

public LazyResetableFuture<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action,
                                                Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

handle

public <U> LazyResetableFuture<U> handle(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<T>

handleAsync

public <U> LazyResetableFuture<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<T>

handleAsync

public <U> LazyResetableFuture<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn,
                                              Executor executor)

Specified by:

handleAsync in interface CompletionStage<T>

toCompletableFuture

public CompletableFuture<T> toCompletableFuture()

Specified by:

toCompletableFuture in interface CompletionStage<T>