com.github.dm.jrt.runner

Class Runners

java.lang.Object

com.github.dm.jrt.runner.Runners

public class Runners
extends Object

Utility class for creating and sharing runner instances.

Created by davide-maestroni on 09/09/2014.

Method Summary

Methods

Modifier and Type	Method and Description
static Runner	dynamicPoolRunner(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit keepAliveUnit) Returns a runner employing a dynamic pool of threads. The number of threads may increase when needed from the core to the maximum pool size.
static Runner	poolRunner() Returns a runner employing an optimum number of threads.
static Runner	poolRunner(int poolSize) Returns a runner employing the specified number of threads.
static PriorityRunner	priorityRunner(Runner wrapped) Returns a runner providing ordering of executions based on priority.
static Runner	scheduledRunner(ScheduledExecutorService service) Returns a runner employing the specified executor service.
static Runner	sharedRunner() Returns the shared instance of a thread pool asynchronous runner.
static Runner	syncRunner() Returns the shared instance of a synchronous runner.
static Runner	throttlingRunner(Runner wrapped, int maxExecutions) Returns a runner throttling the number of running executions so to keep it under the specified limit.

Methods inherited from class java.lang.Object

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

Method Detail

dynamicPoolRunner

@NotNull
public static Runner dynamicPoolRunner(int corePoolSize,
                               int maximumPoolSize,
                               long keepAliveTime,
                               @NotNull
                               TimeUnit keepAliveUnit)

Returns a runner employing a dynamic pool of threads.
The number of threads may increase when needed from the core to the maximum pool size. The number of threads exceeding the core size are kept alive when idle for the specified time. If they stay idle for a longer time they will be destroyed.

Parameters:

corePoolSize - the number of threads to keep in the pool, even if they are idle.

maximumPoolSize - the maximum number of threads to allow in the pool.

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

keepAliveUnit - the time unit for the keep alive time.

Returns:

the runner instance.

poolRunner

@NotNull
public static Runner poolRunner()

Returns a runner employing an optimum number of threads.

Returns:

the runner instance.

poolRunner

@NotNull
public static Runner poolRunner(int poolSize)

Returns a runner employing the specified number of threads.

Parameters:

poolSize - the thread pool size.

Returns:

the runner instance.

Throws:

IllegalArgumentException - if the pool size is less than 1.

priorityRunner

@NotNull
public static PriorityRunner priorityRunner(@NotNull
                                    Runner wrapped)

Returns a runner providing ordering of executions based on priority.

Parameters:

wrapped - the wrapped runner instance.

Returns:

the runner instance.

scheduledRunner

@NotNull
public static Runner scheduledRunner(@NotNull
                             ScheduledExecutorService service)

Returns a runner employing the specified executor service.

Parameters:

service - the executor service.

Returns:

the runner instance.

sharedRunner

@NotNull
public static Runner sharedRunner()

Returns the shared instance of a thread pool asynchronous runner.

Returns:

the runner instance.

syncRunner

@NotNull
public static Runner syncRunner()

Returns the shared instance of a synchronous runner.

Returns:

the runner instance.

throttlingRunner

@NotNull
public static Runner throttlingRunner(@NotNull
                              Runner wrapped,
                              int maxExecutions)

Returns a runner throttling the number of running executions so to keep it under the specified limit.

Parameters:

wrapped - the wrapped instance.

maxExecutions - the maximum number of running executions.

Returns:

the runner instance.

Throws:

IllegalArgumentException - if the specified max number is less than 1.