org.multibit.commons.concurrent

Class SafeExecutors

java.lang.Object

org.multibit.commons.concurrent.SafeExecutors

public class SafeExecutors
extends Object

Factory that partially wraps the standard Java Executors concurrency to allow any runtime exceptions to be passed to the ExceptionHandler.

Since:

0.0.1

Constructor Summary

Constructors

Constructor and Description
SafeExecutors()

Method Summary

Modifier and Type	Method and Description
static com.google.common.util.concurrent.ListeningExecutorService	newFixedThreadPool(int nThreads, String poolName) Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue.
static com.google.common.util.concurrent.ListeningScheduledExecutorService	newScheduledThreadPool(int corePoolSize, String poolName) Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.
static com.google.common.util.concurrent.ListeningExecutorService	newSingleThreadExecutor(String name) Creates an Executor that uses a single worker thread operating off an unbounded queue.
static com.google.common.util.concurrent.ListeningScheduledExecutorService	newSingleThreadScheduledExecutor(String name) 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

Constructor Detail

SafeExecutors

public SafeExecutors()

Method Detail

newSingleThreadExecutor

public static com.google.common.util.concurrent.ListeningExecutorService newSingleThreadExecutor(String name)

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.

Returns:

the newly created single-threaded Executor

newFixedThreadPool

public static com.google.common.util.concurrent.ListeningExecutorService newFixedThreadPool(int nThreads,
                                                                                            String poolName)

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

poolName - The name of the pool (use lowercase hyphenated)

Returns:

the newly created thread pool

Throws:

IllegalArgumentException - if nThreads <= 0

newSingleThreadScheduledExecutor

public static com.google.common.util.concurrent.ListeningScheduledExecutorService newSingleThreadScheduledExecutor(String name)

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:

name - The name of the thread

Returns:

the newly created scheduled executor

newScheduledThreadPool

public static com.google.common.util.concurrent.ListeningScheduledExecutorService newScheduledThreadPool(int corePoolSize,
                                                                                                         String poolName)

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.

poolName - The name of the pool (use lowercase hyphenated)

Returns:

a newly created scheduled thread pool

Throws:

IllegalArgumentException - if corePoolSize < 0