org.atlanmod.commons.concurrent

Class MoreExecutors

java.lang.Object

org.atlanmod.commons.concurrent.MoreExecutors

@ParametersAreNonnullByDefault
public final class MoreExecutors
extends Object

Static utility methods related to Executor instances.

Method Summary

Modifier and Type	Method and Description
static ExecutorService	newDirectPool() Creates a new ExecutorService that runs each task in the thread that invokes execute/submit.
static ExecutorService	newFixedThreadPool() Creates a new ExecutorService using the maximum available processors, that will be closed when the application will exit.
static ExecutorService	newFixedThreadPool(int nThreads) Creates a new ExecutorService using nThreads processors, that will be closed when the application will exit.
static ExecutorService	newFixedThreadPool(int nThreads, String name) Creates a new ExecutorService using nThreads processors, that will be closed when the application will exit.
static ExecutorService	newFixedThreadPool(String name) Creates a new ExecutorService using the maximum available processors, that will be closed when the application will exit.
static List<Runnable>	shutdown(ExecutorService service, long timeout, TimeUnit unit) Cleanly closes the service.
static void	shutdown(ExecutorService service, long timeout, TimeUnit unit, boolean executeUnstarted) Cleanly closes the service.
static ExecutorService	shutdownAtExit(ExecutorService service, long timeout, TimeUnit unit, boolean executeUnstarted) Adds a shutdown hook to cleanly closes the service when the application will exit.

Methods inherited from class java.lang.Object

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

Method Detail

newDirectPool

@Nonnull
public static ExecutorService newDirectPool()

Creates a new ExecutorService that runs each task in the thread that invokes execute/submit. This applies both to individually submitted tasks and to collections of tasks submitted via invokeAll or invokeAny. In the latter case, tasks will run serially on the calling thread. Tasks are run to completion before a Future is returned to the caller (unless the executor has been shutdown).

Although all tasks are immediately executed in the thread that submitted the task, this ExecutorService imposes a small locking overhead on each task submission in order to implement shutdown and termination behavior.

Returns:

a new service

newFixedThreadPool

@Nonnull
public static ExecutorService newFixedThreadPool()

Creates a new ExecutorService using the maximum available processors, that will be closed when the application will exit.

Returns:

a new service

Throws:

IllegalArgumentException - if nThreads <= 0

See Also:

newFixedThreadPool(int)

newFixedThreadPool

@Nonnull
public static ExecutorService newFixedThreadPool(String name)

Creates a new ExecutorService using the maximum available processors, that will be closed when the application will exit.

Returns:

a new service

Throws:

IllegalArgumentException - if nThreads <= 0

See Also:

newFixedThreadPool(int)

newFixedThreadPool

@Nonnull
public static ExecutorService newFixedThreadPool(int nThreads)

Creates a new ExecutorService using nThreads processors, that will be closed when the application will exit.

Parameters:

nThreads - the number of threads in the pool

Returns:

a new service

Throws:

IllegalArgumentException - if nThreads <= 0

See Also:

newFixedThreadPool(int, String)

newFixedThreadPool

@Nonnull
public static ExecutorService newFixedThreadPool(int nThreads,
                                                          @Nullable
                                                          String name)

Creates a new ExecutorService using nThreads processors, that will be closed when the application will exit.

Parameters:

nThreads - the number of threads in the pool

name - the name of the pool

Returns:

a new service

Throws:

IllegalArgumentException - if nThreads <= 0

See Also:

Executors.newFixedThreadPool(int), MoreThreads.newThreadFactory(), shutdownAtExit(ExecutorService, long, TimeUnit, boolean)

shutdown

public static void shutdown(ExecutorService service,
                            long timeout,
                            TimeUnit unit,
                            boolean executeUnstarted)

Cleanly closes the service.

Parameters:

service - the service to close

timeout - the maximum time to wait

unit - the time unit of the timeout argument

executeUnstarted - true if the remaining tasks must be executed synchronously if they have not completed their execution after the shutdown request

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if timeout < 0

See Also:

ExecutorService.shutdown(), ExecutorService.awaitTermination(long, TimeUnit), ExecutorService.shutdownNow()

shutdown

@Nonnull
public static List<Runnable> shutdown(ExecutorService service,
                                               long timeout,
                                               TimeUnit unit)

Cleanly closes the service.

Parameters:

service - the service to close

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

a list of remaining tasks that never commenced execution

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if timeout < 0

See Also:

ExecutorService.shutdown(), ExecutorService.awaitTermination(long, TimeUnit), ExecutorService.shutdownNow()

shutdownAtExit

@Nonnull
public static ExecutorService shutdownAtExit(ExecutorService service,
                                                      long timeout,
                                                      TimeUnit unit,
                                                      boolean executeUnstarted)

Adds a shutdown hook to cleanly closes the service when the application will exit.

Parameters:

service - the service to close

timeout - the maximum time to wait

unit - the time unit of the timeout argument

executeUnstarted - true if the remaining tasks must be executed synchronously if they have not completed their execution after the shutdown request

Returns:

the service

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if timeout < 0

See Also:

ExecutorService.shutdown(), ExecutorService.awaitTermination(long, TimeUnit), ExecutorService.shutdownNow()