Package ch.powerunit.extensions.async.lang

Interface WaitResultBuilder5<T>

Type Parameters:

T - The type of result of the CompletableFuture

All Superinterfaces:

Supplier<Optional<T>>

public interface WaitResultBuilder5<T>
extends Supplier<Optional<T>>

Almost final Step of the builder of CompletableFuture to define the executor it self.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<Optional<T>>	asyncExec()	Create and start the async execution of the CompletableFuture using ForkJoinPool.commonPool().
default CompletableFuture<Optional<T>>	asyncExec(Executor executor)	Deprecated. Replaced by using(executor).asyncExec()
default WaitResultBuilder5<T>	filter(Predicate<T> filter)	Add a filter predicate, on the result, if applicable.
default Optional<T>	finish()	Directly wait for the result of this execution using ForkJoinPool.commonPool().
default Optional<T>	finish(Executor executor)	Deprecated. Replaced by using(executor).finish()
default T	finishWithAResult()	Directly wait for a positive result of this execution using ForkJoinPool.commonPool().
default T	finishWithAResult(Executor executor)	Deprecated. Replaced by using(executor).finishWithAResult()
default <U> WaitResultBuilder5<U>	flatMap(Function<T,Optional<U>> mapper)	Add a flat mapper fonction, on the result, if applicable.
Optional<T>	get()	Directly wait for the result of this execution (the execution is run in this thread).
default <U> WaitResultBuilder5<U>	map(Function<T,U> mapper)	Add a mapper fonction, on the result, if applicable.
default WaitResultBuilder5<T>	onFinish(Runnable action)	Register an action to be done when the retrieval is finish (in success or not).
default WaitResultBuilder5<T>	or(Supplier<? extends Optional<? extends T>> supplier)	Add a or operation, on the result, if applicable.
default WaitResultBuilder6<T>	using(Executor executor)	Define the executor to be used for the async part.
default WaitResultBuilder6<T>	usingDefaultExecutor()	Define the executor to be used for the async part as using ForkJoinPool.commonPool().

Method Detail

get

Optional<T> get()

Directly wait for the result of this execution (the execution is run in this thread). In case of not ignored exception, an AssertionError is thrown.

For example :

 WaitResult.of(myCallable).dontIgnoreException().expecting(myPredicate).repeat(2)
                .every(1000, TimeUnit.MILLISECONDS).get()
 

• If an exception occurs in myCallable, an AssertionError is thrown
• If no result is available, after the 2 try, an empty Optional is returned.
• Or the result is available in the returned Optional.

Specified by:

get in interface Supplier<T>

Returns:

the Optional with the result of the execution

Throws:

AssertionError - In case of not ignored exception.

onFinish

default WaitResultBuilder5<T> onFinish(Runnable action)

Register an action to be done when the retrieval is finish (in success or not).

This may be used, for example, to release resources. This method may be used several times. In this case, all the registered action will be executed on Finish, starting by the first one.

Parameters:

action - the action to be done. May be null (ignored).

Returns:

a new instance of WaitResultBuilder5 with this new action to be done at the end.

Since:

1.1.0

using

default WaitResultBuilder6<T> using(Executor executor)

Define the executor to be used for the async part.

Both the action to retry and the control on the result will be executed on the thread provided by the executor.

Parameters:

executor - the executor to be used. This can't be null.

Returns:

the final step

usingDefaultExecutor

default WaitResultBuilder6<T> usingDefaultExecutor()

Define the executor to be used for the async part as using ForkJoinPool.commonPool().

Both the action to retry and the control on the result will be executed on the thread provided by the executor.

Returns:

the final step

See Also:

ForkJoinPool.commonPool()

asyncExec

@Deprecated
default CompletableFuture<Optional<T>> asyncExec(Executor executor)

Deprecated. Replaced by using(executor).asyncExec()

Create and start the async execution of the CompletableFuture.

Parameters:

executor - the executor to be used.

Returns:

the CompletableFuture

asyncExec

default CompletableFuture<Optional<T>> asyncExec()

Create and start the async execution of the CompletableFuture using ForkJoinPool.commonPool().

Returns:

the CompletableFuture

See Also:

usingDefaultExecutor(), WaitResultBuilder6.asyncExec()

finish

@Deprecated
default Optional<T> finish(Executor executor)

Deprecated. Replaced by using(executor).finish()

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

Parameters:

executor - the executor to be used.

Returns:

the Optional with the result of the execution

Throws:

AssertionError - In case of not ignored exception.

finish

default Optional<T> finish()

Directly wait for the result of this execution using ForkJoinPool.commonPool(). In case of not ignored exception, an AssertionError is thrown.

Returns:

the Optional with the result of the execution

Throws:

AssertionError - In case of not ignored exception.

See Also:

usingDefaultExecutor(), WaitResultBuilder6.finish()

finishWithAResult

@Deprecated
default T finishWithAResult(Executor executor)

Deprecated. Replaced by using(executor).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.

Parameters:

executor - the executor to be used.

Returns:

the value if available

Throws:

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

finishWithAResult

default T finishWithAResult()

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

Returns:

the value if available

Throws:

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

See Also:

usingDefaultExecutor(), WaitResultBuilder6.finishWithAResult()

map

default <U> WaitResultBuilder5<U> map(Function<T,U> mapper)

Add a mapper fonction, on the result, if applicable. This mapper is executed in the target thread.

Type Parameters:

U - the target of the mapper.

Parameters:

mapper - the function to convert the result.

Returns:

the WaitResultBuilder5 continuation of the builder

Since:

1.0.0

See Also:

Optional.map(Function)

flatMap

default <U> WaitResultBuilder5<U> flatMap(Function<T,Optional<U>> mapper)

Add a flat mapper fonction, on the result, if applicable. This mapper is executed in the target thread.

Type Parameters:

U - the target of the mapper.

Parameters:

mapper - the function to convert the result.

Returns:

the WaitResultBuilder5 continuation of the builder

Since:

1.1.0

See Also:

Optional.flatMap(Function)

or

default WaitResultBuilder5<T> or(Supplier<? extends Optional<? extends T>> supplier)

Add a or operation, on the result, if applicable. This or is executed in the target thread.

Only available on java 9

Parameters:

supplier - the function to convert the result

Returns:

the WaitResultBuilder5 continuation of the builder

Since:

1.1.0

See Also:

Optional.or(Supplier)

filter

default WaitResultBuilder5<T> filter(Predicate<T> filter)

Add a filter predicate, on the result, if applicable. This filter is executed in the target thread.

Parameters:

filter - the filter

Returns:

the WaitResultBuilder5 continuation of the builder

Since:

1.0.0

See Also:

Optional.filter(Predicate)