Package ch.powerunit.extensions.async.lang

Interface WaitResultBuilder6<T>

Type Parameters:

T - The type of result of the CompletableFuture

public interface WaitResultBuilder6<T>

Last Step of the builder of CompletableFuture to create the completable operation it self.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Optional<T>>	asyncExec()	Create and start the async execution of the CompletableFuture the executor that was defined before.
default Optional<T>	finish()	Directly wait for the result of this execution.
default T	finishWithAResult()	Directly wait for a positive result of this execution.
default Optional<T>	get()	Waits if necessary for the produced future to complete, and then returns its result.
default Optional<T>	join()	Shortcut method to the join of the CompletableFuture.
default T	joinWithAResult()	Shortcut method to the join of the CompletableFuture, that expect a positive result.
default CompletionStage<Optional<T>>	minimalCompletionStage()	Returns a new CompletionStage that is completed normally based on this CompletableFuture.
default CompletableFuture<Optional<T>>	orTimeout(long timeout, TimeUnit unit)	Create and start the async execution of the CompletableFuture and exceptionally completes this CompletableFuture with a TimeoutException if not otherwise completed before the given timeout.
default CompletableFuture<Void>	thenAccept(Consumer<? super Optional<T>> action)	Create and start the async execution of the CompletableFuture and directly register a Consumer on the result.
default <U> CompletableFuture<U>	thenApply(Function<? super Optional<T>,? extends U> fn)	Create and start the async execution of the CompletableFuture and directly register a Function on the result.

Method Detail

asyncExec

CompletableFuture<Optional<T>> asyncExec()

Create and start the async execution of the CompletableFuture the executor that was defined before.

This method is the main method of this interface. This start the execution of the CompletableFuture based on the parameter defined before.

For example:

 CompletableFuture<Optional<String>> future = WaitResult.of(myCallable).dontIgnoreException()
                .expecting(myPredicate).repeat(2).every(1000, TimeUnit.MILLISECONDS).usingDefaultExecutor().asyncExec();
 

This defines a CompletableFuture that will repeat maximum two time, with a wait time of 1000ms, the execution of myCallable, doesn't ignore the exception, verify the myPredicate condition. This CompletableFuture will use the default executor.

Returns:

the CompletableFuture

finish

default Optional<T> finish()

Directly wait for the result of this execution. In case of not ignored exception, an AssertionError is thrown.

This method is a shortcut method to asyncExec().get(), which throw AssertionError in case of error.

Returns:

the Optional with the result of the execution

Throws:

AssertionError - In case of not ignored exception.

See Also:

asyncExec(), CompletableFuture.get()

finishWithAResult

default T finishWithAResult()

Directly wait for a positive result of this execution. In case of not ignored exception, or when no result are available, an AssertionError is thrown.

This method is a shortcut method to the finish method that read the optional value and throw an AssertionError in case of mission value.

Returns:

the value if available

Throws:

AssertionError - In case of not ignored exception or missing result.

See Also:

finish()

join

default Optional<T> join()

Shortcut method to the join of the CompletableFuture.

Only runtime exception in case of error.

Returns:

the result of the wait

Since:

1.0.0

See Also:

CompletableFuture.join(), asyncExec()

joinWithAResult

default T joinWithAResult()

Shortcut method to the join of the CompletableFuture, that expect a positive result.

Only runtime exception in case of error.

Returns:

the result of the wait

Since:

1.0.0

See Also:

CompletableFuture.join(), join()

thenAccept

default CompletableFuture<Void> thenAccept(Consumer<? super Optional<T>> action)

Create and start the async execution of the CompletableFuture and directly register a Consumer on the result.

Parameters:

action - the action to be done on the result

Returns:

the CompletableFuture

Since:

1.0.0

See Also:

CompletableFuture.thenAccept(Consumer), asyncExec()

thenApply

default <U> CompletableFuture<U> thenApply(Function<? super Optional<T>,? extends U> fn)

Create and start the async execution of the CompletableFuture and directly register a Function on the result.

Type Parameters:

U - The new return type

Parameters:

fn - then function to be applied

Returns:

the CompletableFuture

Since:

1.0.0

See Also:

CompletableFuture.thenApply(Function), asyncExec()

orTimeout

default CompletableFuture<Optional<T>> orTimeout(long timeout,
                                                 TimeUnit unit)

Create and start the async execution of the CompletableFuture and exceptionally completes this CompletableFuture with a TimeoutException if not otherwise completed before the given timeout.

Only available on java 9

Parameters:

timeout - how long to wait before completing exceptionally with a TimeoutException, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the CompletableFuture

Since:

1.0.0

See Also:

CompletableFuture.orTimeout(long, TimeUnit), asyncExec()

minimalCompletionStage

default CompletionStage<Optional<T>> minimalCompletionStage()

Returns a new CompletionStage that is completed normally based on this CompletableFuture.

Only available on java 9

Returns:

the new CompletionStage

Since:

1.0.0

See Also:

CompletableFuture.minimalCompletionStage(), asyncExec()

get

default Optional<T> get()
                 throws InterruptedException,
                        ExecutionException

Waits if necessary for the produced future to complete, and then returns its result.

Returns:

the result value

Throws:

CancellationException - if the produced future was cancelled

ExecutionException - if the produced future completed exceptionally

InterruptedException - if the current thread was interrupted while waiting

Since:

1.0.0

See Also:

CompletableFuture.get(), asyncExec()