org.smallibs.concurrent.promise

Interface Promise<T>

All Superinterfaces:

Filter<Promise,T,Promise<T>>, HK<Promise,T,Promise<T>>

All Known Implementing Classes:

PromisesSet, RunnablePromise, SolvablePromise, SolvedPromise

public interface Promise<T>
extends Filter<Promise,T,Promise<T>>, HK<Promise,T,Promise<T>>

A promise is a component denoting an asynchronous computation. Such component can be mapped in order to chain transformations.

Method Summary

Modifier and Type	Method and Description
default <R> Promise<R>	and(FunctionWithError<? super T,R> function) Method use when a new computation must be done when the current one succeed.
<R> Promise<R>	flatmap(java.util.function.Function<? super T,Promise<R>> function) Method use to flatmap a function.
Future<T>	getFuture() Provides the underlying future able to capture and returns the result or the error for a given execution
<R> Promise<R>	map(FunctionWithError<? super T,? extends R> function) Method use to map a function.
Promise<T>	onComplete(java.util.function.Consumer<Try<T>> consumer) Callback called when the computation terminates
Promise<T>	onFailure(java.util.function.Consumer<Throwable> consumer) Callback called when the computation fails
Promise<T>	onSuccess(java.util.function.Consumer<T> consumer) Callback called when the computation succeed
default <R> Promise<R>	then(java.util.function.Function<? super T,Promise<R>> function) Method use when a new asynchronous computation must be done when the current one succeed.

Methods inherited from interface org.smallibs.control.Filter

filter

Methods inherited from interface org.smallibs.type.HK

accept, self

Method Detail

getFuture

Future<T> getFuture()

Provides the underlying future able to capture and returns the result or the error for a given execution

Returns:

a future

onSuccess

Promise<T> onSuccess(java.util.function.Consumer<T> consumer)

Callback called when the computation succeed

Parameters:

consumer - The callback to be activated on success

Returns:

the current promise

onFailure

Promise<T> onFailure(java.util.function.Consumer<Throwable> consumer)

Callback called when the computation fails

Parameters:

consumer - The callback to be activated on error

Returns:

the current promise

onComplete

Promise<T> onComplete(java.util.function.Consumer<Try<T>> consumer)

Callback called when the computation terminates

Parameters:

consumer - The callback to be activated on completion

Returns:

the current promise

map

<R> Promise<R> map(FunctionWithError<? super T,? extends R> function)

Method use to map a function. This mapping is done when the operation is a success. The result of this mapping is a new promise component.

Type Parameters:

R - the promised value type

Parameters:

function - The function to applied on success which can raise an error

Returns:

a new promise

and

default <R> Promise<R> and(FunctionWithError<? super T,R> function)

Method use when a new computation must be done when the current one succeed. The current one and the chained one are done sequentially in the same context.

Type Parameters:

R - the promised value type

Parameters:

function - The function to applied on success

Returns:

a new promise

flatmap

<R> Promise<R> flatmap(java.util.function.Function<? super T,Promise<R>> function)

Method use to flatmap a function. This mapping is done when the operation is a success. The result of this mapping is a new promise component.

Type Parameters:

R - the promised value type

Parameters:

function - The function to applied on success

Returns:

a new promise

then

default <R> Promise<R> then(java.util.function.Function<? super T,Promise<R>> function)

Method use when a new asynchronous computation must be done when the current one succeed. The current one and the chained one are not done sequentially in the same context.

Type Parameters:

R - the promised value type

Parameters:

function - The function to applied on success

Returns:

a new promise