org.ujorm.tools.thread

Class MultiJob<P>

java.lang.Object

org.ujorm.tools.thread.MultiJob<P>

public class MultiJob<P>
extends Object

A multithreading task runner

See Also:

https://dzone.com/articles/think-twice-using-java-8, https://www.baeldung.com/java-completablefuture

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiJob.MultiJobException Internal exception

Field Summary

Fields

Modifier and Type	Field and Description
protected Executor	executor Executor contains a thread pool
protected Stream<P>	params Job arguments
protected Duration	timeout A timeout where a default duration is the one hour

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiJob(Stream<P> params)

Method Summary

Modifier and Type	Method and Description
protected <R> Function<CompletableFuture<R>,R>	createGrabber(Duration timeout)
static <P> MultiJob<P>	forParams(Iterable<P> params)
static <P> MultiJob<P>	forParams(List<P> params)
static <P> MultiJob<P>	forParams(P... params)
static <P> MultiJob<P>	forParams(Stream<P> params)
protected <R> Function<P,CompletableFuture<R>>	getAsync(Function<P,R> job) Create an async function
<R> Stream<R>	run(Function<P,R> job) Get of single values where a nulls are excluded
<R> Stream<R>	runToStream(Function<P,Stream<R>> job) Get result of a Stream
MultiJob<P>	setExecutor(Executor executor) Assign an excecutor where the null value activates a default executor.
MultiJob<P>	setNewFixedThreadPool(int nThreads) Assign a new Fixed Thread Pool
MultiJob<P>	setNewFixedThreadPool(int nThreads, Duration keepAliveTime) Assign a new Fixed Thread Pool
MultiJob<P>	setTimeout(Duration timeout) Set a timeout where a default duration is the one hour

Methods inherited from class java.lang.Object

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

Field Detail

params

@Nonnull
protected final Stream<P> params

Job arguments

timeout

@Nonnull
protected Duration timeout

A timeout where a default duration is the one hour

executor

@Nullable
protected Executor executor

Executor contains a thread pool

Constructor Detail

MultiJob

protected MultiJob(@Nonnull
                   Stream<P> params)

Method Detail

setTimeout

public MultiJob<P> setTimeout(@Nonnull
                              Duration timeout)

Set a timeout where a default duration is the one hour

Parameters:

timeout - The maximum time to wait.

Returns:

The same object

setExecutor

public MultiJob<P> setExecutor(@Nullable
                               Executor executor)

Assign an excecutor where the null value activates a default executor.

Parameters:

executor - For examle: Executors.newFixedThreadPool(10)

setNewFixedThreadPool

public MultiJob<P> setNewFixedThreadPool(int nThreads)

Assign a new Fixed Thread Pool

Parameters:

nThreads - the number of threads in the pool

Returns:

The same object

setNewFixedThreadPool

public MultiJob<P> setNewFixedThreadPool(int nThreads,
                                         @Nonnull
                                         Duration keepAliveTime)

Assign a new Fixed Thread Pool

Parameters:

nThreads -

keepAliveTime - when the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating.

Returns:

The same object

run

public <R> Stream<R> run(@Nonnull
                         Function<P,R> job)
                  throws MultiJob.MultiJobException

Get of single values where a nulls are excluded

Parameters:

job - Job with a simple value result

Returns:

The result stream

Throws:

MultiJob.MultiJobException

runToStream

public <R> Stream<R> runToStream(@Nonnull
                                 Function<P,Stream<R>> job)
                          throws MultiJob.MultiJobException

Get result of a Stream

Parameters:

job - Job with a stream result

Returns:

The result stream

Throws:

MultiJob.MultiJobException

getAsync

protected <R> Function<P,CompletableFuture<R>> getAsync(@Nonnull
                                                        Function<P,R> job)

Create an async function

createGrabber

protected <R> Function<CompletableFuture<R>,R> createGrabber(@Nonnull
                                                             Duration timeout)

Parameters:

timeout - The maximum time to wait

forParams

public static <P> MultiJob<P> forParams(@Nonnull
                                        Stream<P> params)

forParams

public static <P> MultiJob<P> forParams(@Nonnull
                                        List<P> params)

forParams

public static <P> MultiJob<P> forParams(@Nonnull
                                        P... params)

forParams

public static <P> MultiJob<P> forParams(@Nonnull
                                        Iterable<P> params)