org.intellimate.izou.sdk.util

Interface ThreadPoolUser

All Superinterfaces:

ContextProvider

All Known Subinterfaces:

PresenceResourceUser

All Known Implementing Classes:

OutputPlugin, OutputPluginArgument, Player, SimplePermanentSoundOutputPlugin

public interface ThreadPoolUser
extends ContextProvider

provides various methods to simplify the interaction with the ThreadPool

Version:

1.0

Author:

Leander Kurscheidt

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<Void>	submit(Runnable runnable) submits the Runnable to the AddOns Thread-Pool
default <U> CompletableFuture<U>	submit(java.util.function.Supplier<U> supplier) submits the Supplier to the AddOns Thread-Pool
default <U,X extends AddOnModule & Callable<U>> Future<U>	submit(X x) submits the Callable to the AddOns Thread-Pool
default CompletableFuture<Void>	submitRun(Runnable runnable) submits the Runnable to the AddOns Thread-Pool
default <U,V extends Future<U>> List<V>	timeOut(Collection<? extends V> futures, int milliseconds) Times out the collection of futures.
default <U> CompletableFuture<U>	timeOut(CompletableFuture<U> future, int milliseconds) Creates a new CompletableFuture, which inherit the CompletionStage from the supplied future or an exceptional completion with the TimeoutException.

Methods inherited from interface org.intellimate.izou.sdk.util.ContextProvider

debug, debug, error, error, getContext

Method Detail

submit

default CompletableFuture<Void> submit(Runnable runnable)

submits the Runnable to the AddOns Thread-Pool

Parameters:

runnable - the runnable to submit

Returns:

the new CompletableFuture

See Also:

ExecutorService.submit(Callable)

submitRun

default CompletableFuture<Void> submitRun(Runnable runnable)

submits the Runnable to the AddOns Thread-Pool

Parameters:

runnable - the runnable to submit

Returns:

the new CompletableFuture

See Also:

ExecutorService.submit(Callable)

submit

default <U> CompletableFuture<U> submit(java.util.function.Supplier<U> supplier)

submits the Supplier to the AddOns Thread-Pool

Type Parameters:

U - the return type

Parameters:

supplier - the supplier executed

Returns:

the new CompletableFuture

See Also:

ExecutorService.submit(Callable)

submit

default <U,X extends AddOnModule & Callable<U>> Future<U> submit(X x)

submits the Callable to the AddOns Thread-Pool

Type Parameters:

U - the type to return

X - the Callable

Parameters:

x - the Callable to submit

Returns:

an Future-Object

See Also:

ExecutorService.submit(Callable)

timeOut

default <U,V extends Future<U>> List<V> timeOut(Collection<? extends V> futures,
                                                int milliseconds)
                                         throws InterruptedException

Times out the collection of futures.

Type Parameters:

U - the return type of the futures

V - the type of the futures

Parameters:

futures - the collection of futures

milliseconds - the limit in milliseconds (everything under 20 milliseconds makes no sense)

Returns:

a List of futures

Throws:

InterruptedException - if the process was interrupted

timeOut

default <U> CompletableFuture<U> timeOut(CompletableFuture<U> future,
                                         int milliseconds)

Creates a new CompletableFuture, which inherit the CompletionStage from the supplied future or an exceptional completion with the TimeoutException.

It will NOT cancel/interrupt the original future!

Type Parameters:

U - the return type of the futures

Parameters:

future - the future

milliseconds - the limit in milliseconds

Returns:

an new CompletableFuture