Class AsyncStepExecutor<T>

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.tooluser.stepexecutor.StepExecutor

nl.pim16aap2.animatedarchitecture.core.tooluser.stepexecutor.AsyncStepExecutor<T>

Type Parameters:

T - The type of the input for the function.

public class AsyncStepExecutor<T>
extends StepExecutor

A StepExecutor that executes a function asynchronously.

Constructor Summary

Constructors

Constructor	Description
AsyncStepExecutor(Class<T> inputClass, Function<T, CompletableFuture<Boolean>> fun)	Creates a new AsyncStepExecutor.

Method Summary

Modifier and Type	Method	Description
protected Class<?>	getInputClass()	Checks the type that is expected as input for this step.
boolean	isAsync()	Checks if this step is asynchronous.
protected CompletableFuture<Boolean>	protectedAcceptAsync(@Nullable Object input)	Protected version of StepExecutor.protectedAccept(Object).

Methods inherited from class StepExecutor

apply, protectedAccept, toString, validInput

Methods inherited from class Object

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

Constructor Details

AsyncStepExecutor

public AsyncStepExecutor(Class<T> inputClass,
 Function<T, CompletableFuture<Boolean>> fun)

Creates a new AsyncStepExecutor.

Parameters:

inputClass - The class of the input for the function.

fun - The function to execute asynchronously that takes an input of type T and returns a CompletableFuture of Boolean.

The CompletableFuture should be completed with the result of the function. If the function is successful, the CompletableFuture should be completed with true. If the function is unsuccessful, the CompletableFuture should be completed with false.

Method Details

protectedAcceptAsync

protected CompletableFuture<Boolean> protectedAcceptAsync(@Nullable Object input)

Description copied from class: StepExecutor

Protected version of StepExecutor.protectedAccept(Object). That method takes care of input type verification.

This method should be overridden by subclasses that are asynchronous.

Overrides:

protectedAcceptAsync in class StepExecutor

Parameters:

input - The object to give to the BiFunction.

getInputClass

protected Class<?> getInputClass()

Description copied from class: StepExecutor

Checks the type that is expected as input for this step.

Specified by:

getInputClass in class StepExecutor

Returns:

The Class of the input object.

isAsync

public boolean isAsync()

Description copied from class: StepExecutor

Checks if this step is asynchronous.

Overrides:

isAsync in class StepExecutor

Returns:

True if this step is asynchronous.