org.openingo.java.util.concurrent

Class ExecutorsX

java.lang.Object

org.openingo.java.util.concurrent.ExecutorsX

public final class ExecutorsX
extends Object

ExecutorsX

Author:

Qicz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutorsX.DelegatedExecutorService A wrapper class that exposes only the ExecutorService methods of an ExecutorService implementation.
static class	ExecutorsX.DelegatedScheduledExecutorService A wrapper class that exposes only the ScheduledExecutorService methods of a ScheduledExecutorService implementation.
static class	ExecutorsX.FinalizableDelegatedExecutorService

Method Summary

Modifier and Type	Method and Description
static ExecutorService	newCachedThreadPool(int maximumPoolSize) Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available.
static ExecutorService	newCachedThreadPool(int maximumPoolSize, ThreadFactory threadFactory) Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available, and uses the provided ThreadFactory to create new threads when needed.
static ExecutorService	newCachedThreadPool(int maximumPoolSize, ThreadFactory threadFactory, RejectedExecutionHandler handler) Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available, and uses the provided ThreadFactory to create new threads when needed.
static ExecutorService	newFixedThreadPool(int nThreads, int queueCapacity) Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue.
static ExecutorService	newFixedThreadPool(int nThreads, int queueCapacity, ThreadFactory threadFactory) Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue, using the provided ThreadFactory to create new threads when needed.
static ExecutorService	newFixedThreadPool(int nThreads, int queueCapacity, ThreadFactory threadFactory, RejectedExecutionHandler handler) Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue, using the provided ThreadFactory to create new threads when needed.
static ScheduledExecutorService	newScheduledThreadPool(int corePoolSize, int maximumPoolSize) Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.
static ScheduledExecutorService	newScheduledThreadPool(int corePoolSize, int maximumPoolSize, ThreadFactory threadFactory) Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.
static ScheduledExecutorService	newScheduledThreadPool(int corePoolSize, int maximumPoolSize, ThreadFactory threadFactory, RejectedExecutionHandler handler) Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.
static ExecutorService	newSingleThreadExecutor(int queueCapacity) Creates an Executor that uses a single worker thread operating off an unbounded queue.
static ExecutorService	newSingleThreadExecutor(int queueCapacity, ThreadFactory threadFactory) Creates an Executor that uses a single worker thread operating off an unbounded queue, and uses the provided ThreadFactory to create a new thread when needed.
static ExecutorService	newSingleThreadExecutor(int queueCapacity, ThreadFactory threadFactory, RejectedExecutionHandler handler) Creates an Executor that uses a single worker thread operating off an unbounded queue, and uses the provided ThreadFactory to create a new thread when needed.
static ScheduledExecutorService	newSingleThreadScheduledExecutor(int maximumPoolSize) Creates a single-threaded executor that can schedule commands to run after a given delay, or to execute periodically.
static ScheduledExecutorService	newSingleThreadScheduledExecutor(int maximumPoolSize, ThreadFactory threadFactory) Creates a single-threaded executor that can schedule commands to run after a given delay, or to execute periodically.

Methods inherited from class java.lang.Object

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

Method Detail

newFixedThreadPool

public static ExecutorService newFixedThreadPool(int nThreads,
                                                 int queueCapacity)

Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue. At any point, at most nThreads threads will be active processing tasks. If additional tasks are submitted when all threads are active, they will wait in the queue until a thread is available. If any thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks. The threads in the pool will exist until it is explicitly shutdown.

Parameters:

nThreads - the number of threads in the pool

queueCapacity - linked blocking queue capacity

Returns:

the newly created thread pool

Throws:

IllegalArgumentException - if nThreads <= 0

newFixedThreadPool

public static ExecutorService newFixedThreadPool(int nThreads,
                                                 int queueCapacity,
                                                 ThreadFactory threadFactory)

Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue, using the provided ThreadFactory to create new threads when needed. At any point, at most nThreads threads will be active processing tasks. If additional tasks are submitted when all threads are active, they will wait in the queue until a thread is available. If any thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks. The threads in the pool will exist until it is explicitly shutdown.

Parameters:

nThreads - the number of threads in the pool

queueCapacity - linked blocking queue capacity

threadFactory - the factory to use when creating new threads

Returns:

the newly created thread pool

Throws:

NullPointerException - if threadFactory is null

IllegalArgumentException - if nThreads <= 0

newFixedThreadPool

public static ExecutorService newFixedThreadPool(int nThreads,
                                                 int queueCapacity,
                                                 ThreadFactory threadFactory,
                                                 RejectedExecutionHandler handler)

Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue, using the provided ThreadFactory to create new threads when needed. At any point, at most nThreads threads will be active processing tasks. If additional tasks are submitted when all threads are active, they will wait in the queue until a thread is available. If any thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks. The threads in the pool will exist until it is explicitly shutdown.

Parameters:

nThreads - the number of threads in the pool

queueCapacity - linked blocking queue capacity

threadFactory - the factory to use when creating new threads

handler - the handler to use when execution is blocked because the thread bounds and queue capacities are reached

Returns:

the newly created thread pool

Throws:

NullPointerException - if threadFactory is null

IllegalArgumentException - if nThreads <= 0

newSingleThreadExecutor

public static ExecutorService newSingleThreadExecutor(int queueCapacity)

Creates an Executor that uses a single worker thread operating off an unbounded queue. (Note however that if this single thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks.) Tasks are guaranteed to execute sequentially, and no more than one task will be active at any given time. Unlike the otherwise equivalent newFixedThreadPool(1) the returned executor is guaranteed not to be reconfigurable to use additional threads.

Parameters:

queueCapacity - linked blocking queue capacity

Returns:

the newly created single-threaded Executor

newSingleThreadExecutor

public static ExecutorService newSingleThreadExecutor(int queueCapacity,
                                                      ThreadFactory threadFactory)

Creates an Executor that uses a single worker thread operating off an unbounded queue, and uses the provided ThreadFactory to create a new thread when needed. Unlike the otherwise equivalent newFixedThreadPool(1, threadFactory) the returned executor is guaranteed not to be reconfigurable to use additional threads.

Parameters:

queueCapacity - linked blocking queue capacity

threadFactory - the factory to use when creating new threads

Returns:

the newly created single-threaded Executor

Throws:

NullPointerException - if threadFactory is null

newSingleThreadExecutor

public static ExecutorService newSingleThreadExecutor(int queueCapacity,
                                                      ThreadFactory threadFactory,
                                                      RejectedExecutionHandler handler)

Creates an Executor that uses a single worker thread operating off an unbounded queue, and uses the provided ThreadFactory to create a new thread when needed. Unlike the otherwise equivalent newFixedThreadPool(1, threadFactory) the returned executor is guaranteed not to be reconfigurable to use additional threads.

Parameters:

queueCapacity - linked blocking queue capacity

threadFactory - the factory to use when creating new threads

handler - the handler to use when execution is blocked because the thread bounds and queue capacities are reached

Returns:

the newly created single-threaded Executor

Throws:

NullPointerException - if threadFactory is null

newCachedThreadPool

public static ExecutorService newCachedThreadPool(int maximumPoolSize)

Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available. These pools will typically improve the performance of programs that execute many short-lived asynchronous tasks. Calls to execute will reuse previously constructed threads if available. If no existing thread is available, a new thread will be created and added to the pool. Threads that have not been used for sixty seconds are terminated and removed from the cache. Thus, a pool that remains idle for long enough will not consume any resources. Note that pools with similar properties but different details (for example, timeout parameters) may be created using ThreadPoolExecutor constructors.

Parameters:

maximumPoolSize - max pool size

Returns:

the newly created thread pool

newCachedThreadPool

public static ExecutorService newCachedThreadPool(int maximumPoolSize,
                                                  ThreadFactory threadFactory)

Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available, and uses the provided ThreadFactory to create new threads when needed.

Parameters:

maximumPoolSize - max pool size

threadFactory - the factory to use when creating new threads

Returns:

the newly created thread pool

Throws:

NullPointerException - if threadFactory is null

newCachedThreadPool

public static ExecutorService newCachedThreadPool(int maximumPoolSize,
                                                  ThreadFactory threadFactory,
                                                  RejectedExecutionHandler handler)

Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available, and uses the provided ThreadFactory to create new threads when needed.

Parameters:

maximumPoolSize - max pool size

threadFactory - the factory to use when creating new threads

handler - the handler to use when execution is blocked because the thread bounds and queue capacities are reached

Returns:

the newly created thread pool

Throws:

NullPointerException - if threadFactory is null

newSingleThreadScheduledExecutor

public static ScheduledExecutorService newSingleThreadScheduledExecutor(int maximumPoolSize)

Creates a single-threaded executor that can schedule commands to run after a given delay, or to execute periodically. (Note however that if this single thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks.) Tasks are guaranteed to execute sequentially, and no more than one task will be active at any given time. Unlike the otherwise equivalent newScheduledThreadPool(1) the returned executor is guaranteed not to be reconfigurable to use additional threads.

Parameters:

maximumPoolSize - max pool size

Returns:

the newly created scheduled executor

newSingleThreadScheduledExecutor

public static ScheduledExecutorService newSingleThreadScheduledExecutor(int maximumPoolSize,
                                                                        ThreadFactory threadFactory)

Creates a single-threaded executor that can schedule commands to run after a given delay, or to execute periodically. (Note however that if this single thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks.) Tasks are guaranteed to execute sequentially, and no more than one task will be active at any given time. Unlike the otherwise equivalent newScheduledThreadPool(1, threadFactory) the returned executor is guaranteed not to be reconfigurable to use additional threads.

Parameters:

maximumPoolSize - max pool size

threadFactory - the factory to use when creating new threads

Returns:

a newly created scheduled executor

Throws:

NullPointerException - if threadFactory is null

newScheduledThreadPool

public static ScheduledExecutorService newScheduledThreadPool(int corePoolSize,
                                                              int maximumPoolSize)

Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.

Parameters:

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

maximumPoolSize - max pool size

Returns:

a newly created scheduled thread pool

Throws:

IllegalArgumentException - if corePoolSize < 0

newScheduledThreadPool

public static ScheduledExecutorService newScheduledThreadPool(int corePoolSize,
                                                              int maximumPoolSize,
                                                              ThreadFactory threadFactory)

Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.

Parameters:

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

maximumPoolSize - max pool size

threadFactory - the factory to use when the executor creates a new thread

Returns:

a newly created scheduled thread pool

Throws:

IllegalArgumentException - if corePoolSize < 0

NullPointerException - if threadFactory is null

newScheduledThreadPool

public static ScheduledExecutorService newScheduledThreadPool(int corePoolSize,
                                                              int maximumPoolSize,
                                                              ThreadFactory threadFactory,
                                                              RejectedExecutionHandler handler)

Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.

Parameters:

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

maximumPoolSize - max pool size

threadFactory - the factory to use when the executor creates a new thread

handler - the handler to use when execution is blocked because the thread bounds and queue capacities are reached

Returns:

a newly created scheduled thread pool

Throws:

IllegalArgumentException - if corePoolSize < 0

NullPointerException - if threadFactory is null