Package com.koralix.stepfn

Class AsyncStepFunction<T,R>

java.lang.Object

com.koralix.stepfn.StepFunction<T,R,CompletableFuture<R>>

com.koralix.stepfn.AsyncStepFunction<T,R>

Type Parameters:

T - the type of the input to the function

R - the type of the result of the function

All Implemented Interfaces:

Function<T,CompletableFuture<R>>

public class AsyncStepFunction<T,R>
extends StepFunction<T,R,CompletableFuture<R>>

A StepFunction that returns a CompletableFuture.

The function is applied asynchronously using the Executor provided to the constructor.

Check the StepFunction documentation for more information and examples.

Since:

1.0.0

See Also:

• StepFunction
• Step
• Transition
• CompletableFuture

Constructor Summary

Constructors

Constructor	Description
AsyncStepFunction(Step<T,?> initialStep, Supplier<ExecutorService> executorSupplier)	Creates a new AsyncStepFunction with the given initial step.
AsyncStepFunction(Step<T,?> initialStep, Map<Step<?,?>,Set<Transition<?,?>>> transitions, Supplier<ExecutorService> executorSupplier)	Deprecated. use AsyncStepFunction(Step, Supplier) instead - this constructor will be removed in 1.2.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<R>	apply(T t)	Applies this function to the given argument.
protected <A, B> Optional<CompletableFuture<B>>	step(Step<A,B> step, Step<?,?> from, A input)	Applies the given Step to the given input.

Methods inherited from class com.koralix.stepfn.StepFunction

addTransition, addTransition, apply, firstStep, transitions

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Details

AsyncStepFunction

@Deprecated
public AsyncStepFunction(Step<T,?> initialStep,
 Map<Step<?,?>,Set<Transition<?,?>>> transitions,
 Supplier<ExecutorService> executorSupplier)

Deprecated.

use AsyncStepFunction(Step, Supplier) instead - this constructor will be removed in 1.2.0

Creates a new AsyncStepFunction with the given initial step and transitions.

Parameters:

initialStep - the initial step

transitions - the transitions

executorSupplier - the supplier of the executor to use for asynchronous computation

Since:

1.0.0

AsyncStepFunction

public AsyncStepFunction(Step<T,?> initialStep,
 Supplier<ExecutorService> executorSupplier)

Creates a new AsyncStepFunction with the given initial step.

Parameters:

initialStep - the initial step

executorSupplier - the supplier of the executor to use for asynchronous computation

Since:

1.0.0

Method Details

apply

public CompletableFuture<R> apply(T t)

Applies this function to the given argument.

Parameters:

t - the function argument

Returns:

the function result in a CompletableFuture

Since:

1.0.0

step

protected <A,
B> Optional<CompletableFuture<B>> step(Step<A,B> step,
 Step<?,?> from,
 A input)

Applies the given Step to the given input.

If the Step is complete, the result is returned in a CompletableFuture.

If the step is not complete, an empty Optional is returned and the input is aggregated.

Specified by:

step in class StepFunction<T,R,CompletableFuture<R>>

Type Parameters:

A - the input type of the step

B - the output type of the step

Parameters:

step - the step to apply

from - the step from which the input was received

input - the input to the step

Returns:

the result of the step in a CompletableFuture if the step is complete, an empty Optional otherwise

Since:

1.0.0