com.hfg.util

Class PrioritizedThreadPoolExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

com.hfg.util.PrioritizedThreadPoolExecutor

All Implemented Interfaces:

Executor, ExecutorService

public class PrioritizedThreadPoolExecutor
extends ThreadPoolExecutor

A version of ThreadPoolExecutor that works with a PriorityBlockingQueue.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

Constructor Summary

Constructors

Constructor and Description
PrioritizedThreadPoolExecutor(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, PriorityBlockingQueue<Runnable> workQueue) Creates a new PrioritizedThreadPoolExecutor with the given initial parameters and default thread factory.
PrioritizedThreadPoolExecutor(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, PriorityBlockingQueue<Runnable> workQueue, RejectedExecutionHandler handler) Creates a new PrioritizedThreadPoolExecutor with the given initial parameters and default thread factory.

Method Summary

Modifier and Type	Method and Description
protected <T> RunnableFuture<T>	newTaskFor(Callable<T> inCallable) Returns a RunnableFuture for the given callable task.
protected <T> RunnableFuture<T>	newTaskFor(Callable<T> inCallable, Priority inPriority) Returns a RunnableFuture for the given callable task.
protected <T> RunnableFuture<T>	newTaskFor(Runnable inRunnable, T inValue) Returns a RunnableFuture for the given runnable and default value.
protected <T> RunnableFuture<T>	newTaskFor(Runnable inRunnable, T inValue, Priority inPriority) Returns a RunnableFuture for the given runnable and default value.
<T> Future<T>	submit(Callable<T> inTask)
<T> Future<T>	submit(Callable<T> inTask, Priority inPriority)
Future<?>	submit(Runnable inTask)
Future<?>	submit(Runnable inTask, Priority inPriority)
<T> Future<T>	submit(Runnable inTask, T inResult)
<T> Future<T>	submit(Runnable task, T result, Priority inPriority)

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

afterExecute, allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, beforeExecute, execute, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdown, shutdownNow, terminated, toString

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from class java.lang.Object

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

Constructor Detail

PrioritizedThreadPoolExecutor

public PrioritizedThreadPoolExecutor(int corePoolSize,
                                     int maximumPoolSize,
                                     long keepAliveTime,
                                     TimeUnit unit,
                                     PriorityBlockingQueue<Runnable> workQueue)

Creates a new PrioritizedThreadPoolExecutor with the given initial parameters and default thread factory.

Parameters:

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

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

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.

unit - the time unit for the keepAliveTime argument

workQueue - the queue to use for holding tasks before they are executed. This queue will hold only the Runnable tasks submitted by the execute method.

Throws:

IllegalArgumentException - if one of the following holds:
corePoolSize < 0
keepAliveTime < 0
maximumPoolSize <= 0
maximumPoolSize < corePoolSize

NullPointerException - if workQueue or handler is null

PrioritizedThreadPoolExecutor

public PrioritizedThreadPoolExecutor(int corePoolSize,
                                     int maximumPoolSize,
                                     long keepAliveTime,
                                     TimeUnit unit,
                                     PriorityBlockingQueue<Runnable> workQueue,
                                     RejectedExecutionHandler handler)

Creates a new PrioritizedThreadPoolExecutor with the given initial parameters and default thread factory.

Parameters:

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

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

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.

unit - the time unit for the keepAliveTime argument

workQueue - the queue to use for holding tasks before they are executed. This queue will hold only the Runnable tasks submitted by the execute method.

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

Throws:

IllegalArgumentException - if one of the following holds:
corePoolSize < 0
keepAliveTime < 0
maximumPoolSize <= 0
maximumPoolSize < corePoolSize

NullPointerException - if workQueue or handler is null

Method Detail

submit

public Future<?> submit(Runnable inTask)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class AbstractExecutorService

submit

public Future<?> submit(Runnable inTask,
                        Priority inPriority)

submit

public <T> Future<T> submit(Runnable inTask,
                            T inResult)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class AbstractExecutorService

submit

public <T> Future<T> submit(Runnable task,
                            T result,
                            Priority inPriority)

submit

public <T> Future<T> submit(Callable<T> inTask)

Specified by:

submit in interface ExecutorService

Overrides:

submit in class AbstractExecutorService

submit

public <T> Future<T> submit(Callable<T> inTask,
                            Priority inPriority)

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Runnable inRunnable,
                                           T inValue)

Returns a RunnableFuture for the given runnable and default value.

Overrides:

newTaskFor in class AbstractExecutorService

Type Parameters:

T - the type of the given value

Parameters:

inRunnable - the runnable task being wrapped

inValue - the default value for the returned future

Returns:

a RunnableFuture which, when run, will run the underlying runnable and which, as a Future, will yield the given value as its result and provide for cancellation of the underlying task

Since:

1.6

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Runnable inRunnable,
                                           T inValue,
                                           Priority inPriority)

Returns a RunnableFuture for the given runnable and default value.

Type Parameters:

T - the type of the given value

Parameters:

inRunnable - the runnable task being wrapped

inValue - the default value for the returned future

inPriority - the job's priority

Returns:

a RunnableFuture which, when run, will run the underlying runnable and which, as a Future, will yield the given value as its result and provide for cancellation of the underlying task

Since:

1.6

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Callable<T> inCallable)

Returns a RunnableFuture for the given callable task.

Overrides:

newTaskFor in class AbstractExecutorService

Type Parameters:

T - the type of the callable's result

Parameters:

inCallable - the callable task being wrapped

Returns:

a RunnableFuture which, when run, will call the underlying callable and which, as a Future, will yield the callable's result as its result and provide for cancellation of the underlying task

Since:

1.6

newTaskFor

protected <T> RunnableFuture<T> newTaskFor(Callable<T> inCallable,
                                           Priority inPriority)

Returns a RunnableFuture for the given callable task.

Type Parameters:

T - the type of the callable's result

Parameters:

inCallable - the callable task being wrapped

inPriority - the job's priority

Returns:

a RunnableFuture which, when run, will call the underlying callable and which, as a Future, will yield the callable's result as its result and provide for cancellation of the underlying task

Since:

1.6