io.werval.api

Interface ApplicationExecutors

public interface ApplicationExecutors

Application Executors.

Method Summary

Modifier and Type	Method and Description
ExecutorService	defaultExecutor() Default Application Executor.
default void	execute(Runnable task) Executes the given command at some time in the future in the default Application Executor.
default void	execute(String executorName, Runnable task) Executes the given command at some time in the future in a configured Application Executor.
ExecutorService	executor(String executorName) Application Executor by name.
boolean	inDefaultExecutor() Check if current thread is in the default Application Executor.
boolean	inExecutor(String executorName) Check if current thread is in a configured Application Executor.
default <T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks) Executes the given tasks in the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.
default <T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) Executes the given tasks in the default Application Executor, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.
default <T> List<Future<T>>	invokeAll(String executorName, Collection<? extends Callable<T>> tasks) Executes the given tasks in a configured Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.
default <T> List<Future<T>>	invokeAll(String executorName, Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) Executes the given tasks in a configured Application Executor, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.
default <T> T	invokeAny(Collection<? extends Callable<T>> tasks) Executes the given tasks on the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.
default <T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) Executes the given tasks on the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses.
default <T> T	invokeAny(String executorName, Collection<? extends Callable<T>> tasks) Executes the given tasks on the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.
default <T> T	invokeAny(String executorName, Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) Executes the given tasks on a configured Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses.
default CompletableFuture<Void>	runAsync(Runnable runnable) Returns a new CompletableFuture that is asynchronously completed by a task running in the default Application Executor after it runs the given action.
default CompletableFuture<Void>	runAsync(String executorName, Runnable runnable) Returns a new CompletableFuture that is asynchronously completed by a task running in a configured Application Executor after it runs the given action.
default <T> Future<T>	submit(Callable<T> task) Submits a value-returning task to the default Application Executor and returns a Future representing the pending results of the task.
default Future<?>	submit(Runnable task) Submits a Runnable task to the default Application Executor and returns a Future representing that task.
default <T> Future<T>	submit(Runnable task, T result) Submits a Runnable task to the default Application Executor and returns a Future representing that task.
default <T> Future<T>	submit(String executorName, Callable<T> task) Submits a value-returning task to a configured Application Executor and returns a Future representing the pending results of the task.
default Future<?>	submit(String executorName, Runnable task) Submits a Runnable task to a configured Application Executor and returns a Future representing that task.
default <T> Future<T>	submit(String executorName, Runnable task, T result) Submits a Runnable task to a configured Application Executor and returns a Future representing that task.
default <U> CompletableFuture<U>	supplyAsync(String executorName, Supplier<U> supplier) Returns a new CompletableFuture that is asynchronously completed by a task running in a configured Application Executor with the value obtained by calling the given Supplier.
default <U> CompletableFuture<U>	supplyAsync(Supplier<U> supplier) Returns a new CompletableFuture that is asynchronously completed by a task running in the default Application Executor with the value obtained by calling the given Supplier.

Method Detail

defaultExecutor

ExecutorService defaultExecutor()

Default Application Executor.

Returns:

Default Application Executor

inDefaultExecutor

boolean inDefaultExecutor()

Check if current thread is in the default Application Executor.

Returns:

TRUE if in default Application Executor, FALSE otherwise

executor

ExecutorService executor(String executorName)

Application Executor by name.

Parameters:

executorName - The name of a configured Application Executor

Returns:

The Application Executor or null if no Executor for the given name

inExecutor

boolean inExecutor(String executorName)

Check if current thread is in a configured Application Executor.

Parameters:

executorName - The name of a configured Application Executor

Returns:

TRUE if in the Application Executor named name, FALSE otherwise.

execute

default void execute(Runnable task)

Executes the given command at some time in the future in the default Application Executor.

See Executor.execute(java.lang.Runnable).

Parameters:

task - The runnable task

execute

default void execute(String executorName,
                     Runnable task)

Executes the given command at some time in the future in a configured Application Executor.

See Executor.execute(java.lang.Runnable).

Parameters:

executorName - The name of a configured Application Executor

task - The runnable task

submit

default <T> Future<T> submit(Callable<T> task)

Submits a value-returning task to the default Application Executor and returns a Future representing the pending results of the task.

See ExecutorService.submit(java.util.concurrent.Callable).

Type Parameters:

T - the type of the task's result

Parameters:

task - the task to submit

Returns:

a Future representing pending completion of the task

submit

default <T> Future<T> submit(String executorName,
                             Callable<T> task)

Submits a value-returning task to a configured Application Executor and returns a Future representing the pending results of the task.

See ExecutorService.submit(java.util.concurrent.Callable).

Type Parameters:

T - The type of the task's result

Parameters:

executorName - The name of a configured Application Executor

task - The task to submit

Returns:

a Future representing pending completion of the task

submit

default Future<?> submit(Runnable task)

Submits a Runnable task to the default Application Executor and returns a Future representing that task.

The Future's get method will return null upon successful completion See ExecutorService.submit(java.lang.Runnable).

Parameters:

task - The task to submit

Returns:

a Future representing pending completion of the task

submit

default Future<?> submit(String executorName,
                         Runnable task)

Submits a Runnable task to a configured Application Executor and returns a Future representing that task.

The Future's get method will return null upon successful completion See ExecutorService.submit(java.lang.Runnable).

Parameters:

executorName - The name of a configured Application Executor

task - The task to submit

Returns:

a Future representing pending completion of the task

submit

default <T> Future<T> submit(Runnable task,
                             T result)

Submits a Runnable task to the default Application Executor and returns a Future representing that task.

The Future's get method will return the given result upon successful completion. See ExecutorService.submit(java.lang.Runnable).

Type Parameters:

T - The type of the result

Parameters:

task - The task to submit

result - The result to return

Returns:

a Future representing pending completion of the task

submit

default <T> Future<T> submit(String executorName,
                             Runnable task,
                             T result)

Submits a Runnable task to a configured Application Executor and returns a Future representing that task.

The Future's get method will return the given result upon successful completion. See ExecutorService.submit(java.lang.Runnable).

Type Parameters:

T - The type of the result

Parameters:

executorName - The name of a configured Application Executor

task - The task to submit

result - The result to return

Returns:

a Future representing pending completion of the task

invokeAny

default <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                 throws InterruptedException,
                        ExecutionException

Executes the given tasks on the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.

See ExecutorService.invokeAny(java.util.Collection).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

tasks - The collection of tasks

Returns:

The result returned by one of the tasks

Throws:

InterruptedException - if interrupted while waiting

ExecutionException - if no task successfully completes

invokeAny

default <T> T invokeAny(String executorName,
                        Collection<? extends Callable<T>> tasks)
                 throws InterruptedException,
                        ExecutionException

Executes the given tasks on the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.

See ExecutorService.invokeAny(java.util.Collection).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

executorName - The name of a configured Application Executor

tasks - The collection of tasks

Returns:

The result returned by one of the tasks

Throws:

InterruptedException - if interrupted while waiting

ExecutionException - if no task successfully completes

invokeAny

default <T> T invokeAny(Collection<? extends Callable<T>> tasks,
                        long timeout,
                        TimeUnit unit)
                 throws InterruptedException,
                        ExecutionException,
                        TimeoutException

Executes the given tasks on the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses.

See ExecutorService.invokeAny(java.util.Collection, long, java.util.concurrent.TimeUnit).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

tasks - The collection of tasks

timeout - The maximum time to wait

unit - The time unit of the timeout argument

Returns:

The result returned by one of the tasks

Throws:

InterruptedException - if interrupted while waiting

ExecutionException - if no task successfully completes

TimeoutException - if the given timeout elapses before any task successfully completes

invokeAny

default <T> T invokeAny(String executorName,
                        Collection<? extends Callable<T>> tasks,
                        long timeout,
                        TimeUnit unit)
                 throws InterruptedException,
                        ExecutionException,
                        TimeoutException

Executes the given tasks on a configured Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses.

See ExecutorService.invokeAny(java.util.Collection, long, java.util.concurrent.TimeUnit).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

executorName - The name of a configured Application Executor

tasks - The collection of tasks

timeout - The maximum time to wait

unit - The time unit of the timeout argument

Returns:

The result returned by one of the tasks

Throws:

InterruptedException - if interrupted while waiting

ExecutionException - if no task successfully completes

TimeoutException - if the given timeout elapses before any task successfully completes

invokeAll

default <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
                               throws InterruptedException

Executes the given tasks in the default Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.

See ExecutorService.invokeAll(java.util.Collection).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

tasks - The collection of tasks

Returns:

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed

Throws:

InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled

invokeAll

default <T> List<Future<T>> invokeAll(String executorName,
                                      Collection<? extends Callable<T>> tasks)
                               throws InterruptedException

Executes the given tasks in a configured Application Executor, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.

See ExecutorService.invokeAll(java.util.Collection).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

executorName - The name of a configured Application Executor

tasks - The collection of tasks

Returns:

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed

Throws:

InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled

invokeAll

default <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
                                      long timeout,
                                      TimeUnit unit)
                               throws InterruptedException

Executes the given tasks in the default Application Executor, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.

See ExecutorService.invokeAll(java.util.Collection, long, java.util.concurrent.TimeUnit).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

tasks - The collection of tasks

timeout - The maximum time to wait

unit - The time unit of the timeout argument

Returns:

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed.

Throws:

InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled

invokeAll

default <T> List<Future<T>> invokeAll(String executorName,
                                      Collection<? extends Callable<T>> tasks,
                                      long timeout,
                                      TimeUnit unit)
                               throws InterruptedException

Executes the given tasks in a configured Application Executor, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.

See ExecutorService.invokeAll(java.util.Collection, long, java.util.concurrent.TimeUnit).

Type Parameters:

T - The type of the values returned from the tasks

Parameters:

executorName - The name of a configured Application Executor

tasks - The collection of tasks

timeout - The maximum time to wait

unit - The time unit of the timeout argument

Returns:

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed.

Throws:

InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled

runAsync

default CompletableFuture<Void> runAsync(Runnable runnable)

Returns a new CompletableFuture that is asynchronously completed by a task running in the default Application Executor after it runs the given action.

Parameters:

runnable - The action to run before completing the returned CompletableFuture

Returns:

the new CompletableFuture

runAsync

default CompletableFuture<Void> runAsync(String executorName,
                                         Runnable runnable)

Returns a new CompletableFuture that is asynchronously completed by a task running in a configured Application Executor after it runs the given action.

Parameters:

executorName - The name of a configured Application Executor

runnable - The action to run before completing the returned CompletableFuture

Returns:

the new CompletableFuture

supplyAsync

default <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier)

Returns a new CompletableFuture that is asynchronously completed by a task running in the default Application Executor with the value obtained by calling the given Supplier.

Type Parameters:

U - The function's return type

Parameters:

supplier - a function returning the value to be used to complete the returned CompletableFuture

Returns:

the new CompletableFuture

supplyAsync

default <U> CompletableFuture<U> supplyAsync(String executorName,
                                             Supplier<U> supplier)

Returns a new CompletableFuture that is asynchronously completed by a task running in a configured Application Executor with the value obtained by calling the given Supplier.

Type Parameters:

U - The function's return type

Parameters:

executorName - The name of a configured Application Executor

supplier - a function returning the value to be used to complete the returned CompletableFuture

Returns:

the new CompletableFuture