# ThreadPoolExecutor

public class **ThreadPoolExecutor** extends [AbstractExecutorService](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html)  

|---|---|---|
| Known Direct Subclasses [ScheduledThreadPoolExecutor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ScheduledThreadPoolExecutor.html) |---|---| | [ScheduledThreadPoolExecutor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ScheduledThreadPoolExecutor.html) | A `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html` that can additionally schedule commands to run after a given delay, or to execute periodically. | |||

An `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html` that executes each submitted task using
one of possibly several pooled threads, normally configured
using `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html` factory methods.

Thread pools address two different problems: they usually
provide improved performance when executing large numbers of
asynchronous tasks, due to reduced per-task invocation overhead,
and they provide a means of bounding and managing the resources,
including threads, consumed when executing a collection of tasks.
Each `ThreadPoolExecutor` also maintains some basic
statistics, such as the number of completed tasks.

To be useful across a wide range of contexts, this class
provides many adjustable parameters and extensibility
hooks. However, programmers are urged to use the more convenient
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html` factory methods `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html#newCachedThreadPool()` (unbounded thread pool, with
automatic thread reclamation), `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html#newFixedThreadPool(int)`
(fixed size thread pool) and `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html#newSingleThreadExecutor()` (single background thread), that
preconfigure settings for the most common usage
scenarios. Otherwise, use the following guide when manually
configuring and tuning this class:

Core and maximum pool sizes
:
    A `ThreadPoolExecutor` will automatically adjust the
    pool size (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getPoolSize()`)
    according to the bounds set by
    corePoolSize (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getCorePoolSize()`) and
    maximumPoolSize (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getMaximumPoolSize()`).

    When a new task is submitted in method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#execute(java.lang.Runnable)`,
    and fewer than corePoolSize threads are running, a new thread is
    created to handle the request, even if other worker threads are
    idle. If there are more than corePoolSize but less than
    maximumPoolSize threads running, a new thread will be created only
    if the queue is full. By setting corePoolSize and maximumPoolSize
    the same, you create a fixed-size thread pool. By setting
    maximumPoolSize to an essentially unbounded value such as `Integer.MAX_VALUE`, you allow the pool to accommodate an arbitrary
    number of concurrent tasks. Most typically, core and maximum pool
    sizes are set only upon construction, but they may also be changed
    dynamically using `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setCorePoolSize(int)` and `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setMaximumPoolSize(int)`.

On-demand construction
:
    By default, even core threads are initially created and
    started only when new tasks arrive, but this can be overridden
    dynamically using method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#prestartCoreThread()` or `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#prestartAllCoreThreads()`. You probably want to prestart threads if
    you construct the pool with a non-empty queue.

Creating new threads
:
    New threads are created using a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html`. If not
    otherwise specified, a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html#defaultThreadFactory()` is
    used, that creates threads to all be in the same `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ThreadGroup.html` and with the same `NORM_PRIORITY` priority and
    non-daemon status. By supplying a different ThreadFactory, you can
    alter the thread's name, thread group, priority, daemon status,
    etc. If a `ThreadFactory` fails to create a thread when asked
    by returning null from `newThread`, the executor will
    continue, but might not be able to execute any tasks. Threads
    should possess the "modifyThread" `RuntimePermission`. If
    worker threads or other threads using the pool do not possess this
    permission, service may be degraded: configuration changes may not
    take effect in a timely manner, and a shutdown pool may remain in a
    state in which termination is possible but not completed.

Keep-alive times
:
    If the pool currently has more than corePoolSize threads,
    excess threads will be terminated if they have been idle for more
    than the keepAliveTime (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getKeepAliveTime(java.util.concurrent.TimeUnit)`).
    This provides a means of reducing resource consumption when the
    pool is not being actively used. If the pool becomes more active
    later, new threads will be constructed. This parameter can also be
    changed dynamically using method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setKeepAliveTime(long,%20java.util.concurrent.TimeUnit)`. Using a value of `Long.MAX_VALUE` `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html#NANOSECONDS` effectively disables idle threads from ever
    terminating prior to shut down. By default, the keep-alive policy
    applies only when there are more than corePoolSize threads, but
    method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#allowCoreThreadTimeOut(boolean)` can be used to
    apply this time-out policy to core threads as well, so long as the
    keepAliveTime value is non-zero.

Queuing
:
    Any `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html` may be used to transfer and hold
    submitted tasks. The use of this queue interacts with pool sizing:

    - If fewer than corePoolSize threads are running, the Executor always prefers adding a new thread rather than queuing.
    - If corePoolSize or more threads are running, the Executor always prefers queuing a request rather than adding a new thread.
    - If a request cannot be queued, a new thread is created unless this would exceed maximumPoolSize, in which case, the task will be rejected.


    There are three general strategies for queuing:

    1. *Direct handoffs.* A good default choice for a work queue is a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/SynchronousQueue.html` that hands off tasks to threads without otherwise holding them. Here, an attempt to queue a task will fail if no threads are immediately available to run it, so a new thread will be constructed. This policy avoids lockups when handling sets of requests that might have internal dependencies. Direct handoffs generally require unbounded maximumPoolSizes to avoid rejection of new submitted tasks. This in turn admits the possibility of unbounded thread growth when commands continue to arrive on average faster than they can be processed.
    2. *Unbounded queues.* Using an unbounded queue (for example a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/LinkedBlockingQueue.html` without a predefined capacity) will cause new tasks to wait in the queue when all corePoolSize threads are busy. Thus, no more than corePoolSize threads will ever be created. (And the value of the maximumPoolSize therefore doesn't have any effect.) This may be appropriate when each task is completely independent of others, so tasks cannot affect each others execution; for example, in a web page server. While this style of queuing can be useful in smoothing out transient bursts of requests, it admits the possibility of unbounded work queue growth when commands continue to arrive on average faster than they can be processed.
    3. *Bounded queues.* A bounded queue (for example, an `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ArrayBlockingQueue.html`) helps prevent resource exhaustion when used with finite maximumPoolSizes, but can be more difficult to tune and control. Queue sizes and maximum pool sizes may be traded off for each other: Using large queues and small pools minimizes CPU usage, OS resources, and context-switching overhead, but can lead to artificially low throughput. If tasks frequently block (for example if they are I/O bound), a system may be able to schedule time for more threads than you otherwise allow. Use of small queues generally requires larger pool sizes, which keeps CPUs busier but may encounter unacceptable scheduling overhead, which also decreases throughput.


Rejected tasks
:
    New tasks submitted in method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#execute(java.lang.Runnable)` will be
    *rejected* when the Executor has been shut down, and also when
    the Executor uses finite bounds for both maximum threads and work queue
    capacity, and is saturated. In either case, the `execute` method
    invokes the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html#rejectedExecution(java.lang.Runnable,%20java.util.concurrent.ThreadPoolExecutor)`
    method of its `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html`. Four predefined handler
    policies are provided:

    1. In the default `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.AbortPolicy.html`, the handler throws a runtime `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionException.html` upon rejection.
    2. In `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.CallerRunsPolicy.html`, the thread that invokes `execute` itself runs the task. This provides a simple feedback control mechanism that will slow down the rate that new tasks are submitted.
    3. In `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.DiscardPolicy.html`, a task that cannot be executed is simply dropped.
    4. In `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.DiscardOldestPolicy.html`, if the executor is not shut down, the task at the head of the work queue is dropped, and then execution is retried (which can fail again, causing this to be repeated.)


    It is possible to define and use other kinds of `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html` classes. Doing so requires some care
    especially when policies are designed to work only under particular
    capacity or queuing policies.

Hook methods
:
    This class provides `protected` overridable
    `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#beforeExecute(java.lang.Thread,%20java.lang.Runnable)` and
    `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#afterExecute(java.lang.Runnable,%20java.lang.Throwable)` methods that are called
    before and after execution of each task. These can be used to
    manipulate the execution environment; for example, reinitializing
    ThreadLocals, gathering statistics, or adding log entries.
    Additionally, method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#terminated()` can be overridden to perform
    any special processing that needs to be done once the Executor has
    fully terminated.

    If hook, callback, or BlockingQueue methods throw exceptions,
    internal worker threads may in turn fail, abruptly terminate, and
    possibly be replaced.

Queue maintenance
:
    Method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getQueue()` allows access to the work queue
    for purposes of monitoring and debugging. Use of this method for
    any other purpose is strongly discouraged. Two supplied methods,
    `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#remove(java.lang.Runnable)` and `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#purge()` are available to
    assist in storage reclamation when large numbers of queued tasks
    become cancelled.

Finalization
:
    A pool that is no longer referenced in a program *AND*
    has no remaining threads will be `shutdown` automatically. If
    you would like to ensure that unreferenced pools are reclaimed even
    if users forget to call `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#shutdown()`, then you must arrange
    that unused threads eventually die, by setting appropriate
    keep-alive times, using a lower bound of zero core threads and/or
    setting `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#allowCoreThreadTimeOut(boolean)`.

**Extension example**. Most extensions of this class
override one or more of the protected hook methods. For example,
here is a subclass that adds a simple pause/resume feature:

     class PausableThreadPoolExecutor extends ThreadPoolExecutor {
       private boolean isPaused;
       private ReentrantLock pauseLock = new ReentrantLock();
       private Condition unpaused = pauseLock.newCondition();

       public PausableThreadPoolExecutor(...) { super(...); }

       protected void beforeExecute(Thread t, Runnable r) {
         super.beforeExecute(t, r);
         pauseLock.lock();
         try {
           while (isPaused) unpaused.await();
         } catch (InterruptedException ie) {
           t.interrupt();
         } finally {
           pauseLock.unlock();
         }
       }

       public void pause() {
         pauseLock.lock();
         try {
           isPaused = true;
         } finally {
           pauseLock.unlock();
         }
       }

       public void resume() {
         pauseLock.lock();
         try {
           isPaused = false;
           unpaused.signalAll();
         } finally {
           pauseLock.unlock();
         }
       }
     }

<br />

### Nested Class Summary

|---|---|---|---|
| class | [ThreadPoolExecutor.AbortPolicy](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.AbortPolicy.html) || A handler for rejected tasks that throws a `RejectedExecutionException`. |
| class | [ThreadPoolExecutor.CallerRunsPolicy](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.CallerRunsPolicy.html) || A handler for rejected tasks that runs the rejected task directly in the calling thread of the `execute` method, unless the executor has been shut down, in which case the task is discarded. |
| class | [ThreadPoolExecutor.DiscardOldestPolicy](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.DiscardOldestPolicy.html) || A handler for rejected tasks that discards the oldest unhandled request and then retries `execute`, unless the executor is shut down, in which case the task is discarded. |
| class | [ThreadPoolExecutor.DiscardPolicy](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.DiscardPolicy.html) || A handler for rejected tasks that silently discards the rejected task. |

### Public Constructor Summary

|---|---|
|   | [ThreadPoolExecutor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int,%20int,%20long,%20java.util.concurrent.TimeUnit,%20java.util.concurrent.BlockingQueue<java.lang.Runnable>))(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue) Creates a new `ThreadPoolExecutor` with the given initial parameters and default thread factory and rejected execution handler. |
|   | [ThreadPoolExecutor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int,%20int,%20long,%20java.util.concurrent.TimeUnit,%20java.util.concurrent.BlockingQueue<java.lang.Runnable>,%20java.util.concurrent.ThreadFactory))(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue, [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory) Creates a new `ThreadPoolExecutor` with the given initial parameters and default rejected execution handler. |
|   | [ThreadPoolExecutor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int,%20int,%20long,%20java.util.concurrent.TimeUnit,%20java.util.concurrent.BlockingQueue<java.lang.Runnable>,%20java.util.concurrent.RejectedExecutionHandler))(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue, [RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html) handler) Creates a new `ThreadPoolExecutor` with the given initial parameters and default thread factory. |
|   | [ThreadPoolExecutor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int,%20int,%20long,%20java.util.concurrent.TimeUnit,%20java.util.concurrent.BlockingQueue<java.lang.Runnable>,%20java.util.concurrent.ThreadFactory,%20java.util.concurrent.RejectedExecutionHandler))(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue, [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory, [RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html) handler) Creates a new `ThreadPoolExecutor` with the given initial parameters. |

### Public Method Summary

|---|---|
| void | [allowCoreThreadTimeOut](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#allowCoreThreadTimeOut(boolean))(boolean value) Sets the policy governing whether core threads may time out and terminate if no tasks arrive within the keep-alive time, being replaced if needed when new tasks arrive. |
| boolean | [allowsCoreThreadTimeOut](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#allowsCoreThreadTimeOut())() Returns true if this pool allows core threads to time out and terminate if no tasks arrive within the keepAlive time, being replaced if needed when new tasks arrive. |
| boolean | [awaitTermination](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#awaitTermination(long,%20java.util.concurrent.TimeUnit))(long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) |
| void | [execute](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#execute(java.lang.Runnable))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) command) Executes the given task sometime in the future. |
| int | [getActiveCount](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getActiveCount())() Returns the approximate number of threads that are actively executing tasks. |
| long | [getCompletedTaskCount](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getCompletedTaskCount())() Returns the approximate total number of tasks that have completed execution. |
| int | [getCorePoolSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getCorePoolSize())() Returns the core number of threads. |
| long | [getKeepAliveTime](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getKeepAliveTime(java.util.concurrent.TimeUnit))([TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Returns the thread keep-alive time, which is the amount of time that threads may remain idle before being terminated. |
| int | [getLargestPoolSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getLargestPoolSize())() Returns the largest number of threads that have ever simultaneously been in the pool. |
| int | [getMaximumPoolSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getMaximumPoolSize())() Returns the maximum allowed number of threads. |
| int | [getPoolSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getPoolSize())() Returns the current number of threads in the pool. |
| [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> | [getQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getQueue())() Returns the task queue used by this executor. |
| [RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html) | [getRejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getRejectedExecutionHandler())() Returns the current handler for unexecutable tasks. |
| long | [getTaskCount](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getTaskCount())() Returns the approximate total number of tasks that have ever been scheduled for execution. |
| [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) | [getThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getThreadFactory())() Returns the thread factory used to create new threads. |
| boolean | [isShutdown](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#isShutdown())() |
| boolean | [isTerminated](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#isTerminated())() |
| boolean | [isTerminating](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#isTerminating())() Returns true if this executor is in the process of terminating after `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#shutdown()` or `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#shutdownNow()` but has not completely terminated. |
| int | [prestartAllCoreThreads](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#prestartAllCoreThreads())() Starts all core threads, causing them to idly wait for work. |
| boolean | [prestartCoreThread](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#prestartCoreThread())() Starts a core thread, causing it to idly wait for work. |
| void | [purge](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#purge())() Tries to remove from the work queue all `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html` tasks that have been cancelled. |
| boolean | [remove](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#remove(java.lang.Runnable))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) task) Removes this task from the executor's internal queue if it is present, thus causing it not to be run if it has not already started. |
| void | [setCorePoolSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setCorePoolSize(int))(int corePoolSize) Sets the core number of threads. |
| void | [setKeepAliveTime](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setKeepAliveTime(long,%20java.util.concurrent.TimeUnit))(long time, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Sets the thread keep-alive time, which is the amount of time that threads may remain idle before being terminated. |
| void | [setMaximumPoolSize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setMaximumPoolSize(int))(int maximumPoolSize) Sets the maximum allowed number of threads. |
| void | [setRejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setRejectedExecutionHandler(java.util.concurrent.RejectedExecutionHandler))([RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html) handler) Sets a new handler for unexecutable tasks. |
| void | [setThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setThreadFactory(java.util.concurrent.ThreadFactory))([ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory) Sets the thread factory used to create new threads. |
| void | [shutdown](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#shutdown())() Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. |
| [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> | [shutdownNow](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#shutdownNow())() Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#toString())() Returns a string identifying this pool, as well as its state, including indications of run state and estimated worker and task counts. |

### Protected Method Summary

|---|---|
| void | [afterExecute](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#afterExecute(java.lang.Runnable,%20java.lang.Throwable))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) r, [Throwable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Throwable.html) t) Method invoked upon completion of execution of the given Runnable. |
| void | [beforeExecute](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#beforeExecute(java.lang.Thread,%20java.lang.Runnable))(Thread t, [Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) r) Method invoked prior to executing the given Runnable in the given thread. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#finalize())() Invokes `shutdown` when this executor is no longer referenced and it has no threads. |
| void | [terminated](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#terminated())() Method invoked when the Executor has terminated. |

### Inherited Method Summary

From class [java.util.concurrent.AbstractExecutorService](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html)

|---|---|
| \<T\> [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\>\> | [invokeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#invokeAll(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks) Executes the given tasks, returning a list of Futures holding their status and results when all complete. |
| \<T\> [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\>\> | [invokeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#invokeAll(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>,%20long,%20java.util.concurrent.TimeUnit))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks, long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. |
| \<T\> T | [invokeAny](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#invokeAny(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks) Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do. |
| \<T\> T | [invokeAny](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#invokeAny(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>,%20long,%20java.util.concurrent.TimeUnit))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks, long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses. |
| \<T\> [RunnableFuture](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RunnableFuture.html)\<T\> | [newTaskFor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#newTaskFor(java.lang.Runnable,%20T))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) runnable, T value) Returns a `RunnableFuture` for the given runnable and default value. |
| \<T\> [RunnableFuture](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RunnableFuture.html)\<T\> | [newTaskFor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#newTaskFor(java.util.concurrent.Callable<T>))([Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\> callable) Returns a `RunnableFuture` for the given callable task. |
| \<T\> [Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\> | [submit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#submit(java.util.concurrent.Callable<T>))([Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\> task) Submits a value-returning task for execution and returns a Future representing the pending results of the task. |
| \<T\> [Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\> | [submit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#submit(java.lang.Runnable,%20T))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) task, T result) Submits a Runnable task for execution and returns a Future representing that task. |
| [Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<?\> | [submit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/AbstractExecutorService.html#submit(java.lang.Runnable))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) task) Submits a Runnable task for execution and returns a Future representing that task. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.util.concurrent.ExecutorService](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html)

|---|---|
| abstract boolean | [awaitTermination](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#awaitTermination(long,%20java.util.concurrent.TimeUnit))(long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. |
| abstract \<T\> [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\>\> | [invokeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#invokeAll(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks) Executes the given tasks, returning a list of Futures holding their status and results when all complete. |
| abstract \<T\> [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\>\> | [invokeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#invokeAll(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>,%20long,%20java.util.concurrent.TimeUnit))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks, long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. |
| abstract \<T\> T | [invokeAny](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#invokeAny(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks) Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do. |
| abstract \<T\> T | [invokeAny](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#invokeAny(java.util.Collection<?%20extends%20java.util.concurrent.Callable<T>>,%20long,%20java.util.concurrent.TimeUnit))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\>\> tasks, long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses. |
| abstract boolean | [isShutdown](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#isShutdown())() Returns `true` if this executor has been shut down. |
| abstract boolean | [isTerminated](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#isTerminated())() Returns `true` if all tasks have completed following shut down. |
| abstract void | [shutdown](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#shutdown())() Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. |
| abstract [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> | [shutdownNow](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#shutdownNow())() Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution. |
| abstract \<T\> [Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\> | [submit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#submit(java.util.concurrent.Callable<T>))([Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<T\> task) Submits a value-returning task for execution and returns a Future representing the pending results of the task. |
| abstract \<T\> [Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<T\> | [submit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#submit(java.lang.Runnable,%20T))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) task, T result) Submits a Runnable task for execution and returns a Future representing that task. |
| abstract [Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)\<?\> | [submit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#submit(java.lang.Runnable))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) task) Submits a Runnable task for execution and returns a Future representing that task. |

From interface [java.util.concurrent.Executor](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executor.html)

|---|---|
| abstract void | [execute](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executor.html#execute(java.lang.Runnable))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) command) Executes the given command at some time in the future. |

## Public Constructors

#### public
**ThreadPoolExecutor**
(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue)

Creates a new `ThreadPoolExecutor` with the given initial
parameters and default thread factory and rejected execution handler.
It may be more convenient to use one of the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html` factory
methods instead of this general purpose constructor.

##### 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if one of the following holds: `corePoolSize < 0` `keepAliveTime < 0` `maximumPoolSize <= 0` `maximumPoolSize < corePoolSize` |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `workQueue` is null |
|---|---|

#### public
**ThreadPoolExecutor**
(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue, [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory)

Creates a new `ThreadPoolExecutor` with the given initial
parameters and default rejected execution handler.

##### 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. |
| threadFactory | the factory to use when the executor creates a new thread |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if one of the following holds: `corePoolSize < 0` `keepAliveTime < 0` `maximumPoolSize <= 0` `maximumPoolSize < corePoolSize` |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `workQueue` or `threadFactory` is null |
|---|---|

#### public
**ThreadPoolExecutor**
(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue, [RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html) handler)

Creates a new `ThreadPoolExecutor` 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if one of the following holds: `corePoolSize < 0` `keepAliveTime < 0` `maximumPoolSize <= 0` `maximumPoolSize < corePoolSize` |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `workQueue` or `handler` is null |
|---|---|

#### public
**ThreadPoolExecutor**
(int corePoolSize, int maximumPoolSize, long keepAliveTime, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit, [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\> workQueue, [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory, [RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html) handler)

Creates a new `ThreadPoolExecutor` with the given initial
parameters.

##### 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. |
| 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 |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if one of the following holds: `corePoolSize < 0` `keepAliveTime < 0` `maximumPoolSize <= 0` `maximumPoolSize < corePoolSize` |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `workQueue` or `threadFactory` or `handler` is null |
|---|---|

## Public Methods

#### public void
**allowCoreThreadTimeOut**
(boolean value)

Sets the policy governing whether core threads may time out and
terminate if no tasks arrive within the keep-alive time, being
replaced if needed when new tasks arrive. When false, core
threads are never terminated due to lack of incoming
tasks. When true, the same keep-alive policy applying to
non-core threads applies also to core threads. To avoid
continual thread replacement, the keep-alive time must be
greater than zero when setting `true`. This method
should in general be called before the pool is actively used.

##### Parameters

| value | `true` if should time out, else `false` |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if value is `true` and the current keep-alive time is not greater than zero |
|---|---|

#### public boolean
**allowsCoreThreadTimeOut**
()

Returns true if this pool allows core threads to time out and
terminate if no tasks arrive within the keepAlive time, being
replaced if needed when new tasks arrive. When true, the same
keep-alive policy applying to non-core threads applies also to
core threads. When false (the default), core threads are never
terminated due to lack of incoming tasks.

##### Returns

- `true` if core threads are allowed to time out, else `false`

#### public boolean
**awaitTermination**
(long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit)

<br />

##### Parameters

| timeout |   |
| unit |   |
|---|---|

##### Throws

| [InterruptedException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/InterruptedException.html) |   |
|---|---|

#### public void
**execute**
([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) command)

Executes the given task sometime in the future. The task
may execute in a new thread or in an existing pooled thread.

If the task cannot be submitted for execution, either because this
executor has been shutdown or because its capacity has been reached,
the task is handled by the current `RejectedExecutionHandler`.

##### Parameters

| command | the task to execute |
|---|---|

##### Throws

| [RejectedExecutionException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionException.html) | at discretion of `RejectedExecutionHandler`, if the task cannot be accepted for execution |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `command` is null |
|---|---|

#### public int
**getActiveCount**
()

Returns the approximate number of threads that are actively
executing tasks.

##### Returns

- the number of threads

#### public long
**getCompletedTaskCount**
()

Returns the approximate total number of tasks that have
completed execution. Because the states of tasks and threads
may change dynamically during computation, the returned value
is only an approximation, but one that does not ever decrease
across successive calls.

##### Returns

- the number of tasks

#### public int
**getCorePoolSize**
()

Returns the core number of threads.

##### Returns

- the core number of threads

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setCorePoolSize(int)`

#### public long
**getKeepAliveTime**
([TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit)

Returns the thread keep-alive time, which is the amount of time
that threads may remain idle before being terminated.
Threads that wait this amount of time without processing a
task will be terminated if there are more than the core
number of threads currently in the pool, or if this pool
{@linkplain #allowsCoreThreadTimeOut() allows core thread timeout}.

##### Parameters

| unit | the desired time unit of the result |
|---|---|

##### Returns

- the time limit

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setKeepAliveTime(long,%20java.util.concurrent.TimeUnit)`

#### public int
**getLargestPoolSize**
()

Returns the largest number of threads that have ever
simultaneously been in the pool.

##### Returns

- the number of threads

#### public int
**getMaximumPoolSize**
()

Returns the maximum allowed number of threads.

##### Returns

- the maximum allowed number of threads

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setMaximumPoolSize(int)`

#### public int
**getPoolSize**
()

Returns the current number of threads in the pool.

##### Returns

- the number of threads

#### public [BlockingQueue](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/BlockingQueue.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\>
**getQueue**
()

Returns the task queue used by this executor. Access to the
task queue is intended primarily for debugging and monitoring.
This queue may be in active use. Retrieving the task queue
does not prevent queued tasks from executing.

##### Returns

- the task queue

#### public [RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html)
**getRejectedExecutionHandler**
()

Returns the current handler for unexecutable tasks.

##### Returns

- the current handler

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setRejectedExecutionHandler(java.util.concurrent.RejectedExecutionHandler)`

#### public long
**getTaskCount**
()

Returns the approximate total number of tasks that have ever been
scheduled for execution. Because the states of tasks and
threads may change dynamically during computation, the returned
value is only an approximation.

##### Returns

- the number of tasks

#### public [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html)
**getThreadFactory**
()

Returns the thread factory used to create new threads.

##### Returns

- the current thread factory

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#setThreadFactory(java.util.concurrent.ThreadFactory)`

#### public boolean
**isShutdown**
()

<br />

#### public boolean
**isTerminated**
()

<br />

#### public boolean
**isTerminating**
()

Returns true if this executor is in the process of terminating
after `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#shutdown()` or `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#shutdownNow()` but has not
completely terminated. This method may be useful for
debugging. A return of `true` reported a sufficient
period after shutdown may indicate that submitted tasks have
ignored or suppressed interruption, causing this executor not
to properly terminate.

##### Returns

- `true` if terminating but not yet terminated

#### public int
**prestartAllCoreThreads**
()

Starts all core threads, causing them to idly wait for work. This
overrides the default policy of starting core threads only when
new tasks are executed.

##### Returns

- the number of threads started

#### public boolean
**prestartCoreThread**
()

Starts a core thread, causing it to idly wait for work. This
overrides the default policy of starting core threads only when
new tasks are executed. This method will return `false`
if all core threads have already been started.

##### Returns

- `true` if a thread was started

#### public void
**purge**
()

Tries to remove from the work queue all `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html`
tasks that have been cancelled. This method can be useful as a
storage reclamation operation, that has no other impact on
functionality. Cancelled tasks are never executed, but may
accumulate in work queues until worker threads can actively
remove them. Invoking this method instead tries to remove them now.
However, this method may fail to remove tasks in
the presence of interference by other threads.

#### public boolean
**remove**
([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) task)

Removes this task from the executor's internal queue if it is
present, thus causing it not to be run if it has not already
started.

This method may be useful as one part of a cancellation
scheme. It may fail to remove tasks that have been converted
into other forms before being placed on the internal queue.
For example, a task entered using `submit` might be
converted into a form that maintains `Future` status.
However, in such cases, method `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#purge()` may be used to
remove those Futures that have been cancelled.

##### Parameters

| task | the task to remove |
|---|---|

##### Returns

- `true` if the task was removed

#### public void
**setCorePoolSize**
(int corePoolSize)

Sets the core number of threads. This overrides any value set
in the constructor. If the new value is smaller than the
current value, excess existing threads will be terminated when
they next become idle. If larger, new threads will, if needed,
be started to execute any queued tasks.

##### Parameters

| corePoolSize | the new core size |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `corePoolSize < 0` |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getCorePoolSize()`

#### public void
**setKeepAliveTime**
(long time, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit)

Sets the thread keep-alive time, which is the amount of time
that threads may remain idle before being terminated.
Threads that wait this amount of time without processing a
task will be terminated if there are more than the core
number of threads currently in the pool, or if this pool
{@linkplain #allowsCoreThreadTimeOut() allows core thread timeout}.
This overrides any value set in the constructor.

##### Parameters

| time | the time to wait. A time value of zero will cause excess threads to terminate immediately after executing tasks. |
| unit | the time unit of the `time` argument |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `time` less than zero or if `time` is zero and `allowsCoreThreadTimeOut` |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getKeepAliveTime(java.util.concurrent.TimeUnit)`

#### public void
**setMaximumPoolSize**
(int maximumPoolSize)

Sets the maximum allowed number of threads. This overrides any
value set in the constructor. If the new value is smaller than
the current value, excess existing threads will be
terminated when they next become idle.

##### Parameters

| maximumPoolSize | the new maximum |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the new maximum is less than or equal to zero, or less than the {@linkplain #getCorePoolSize core pool size} |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getMaximumPoolSize()`

#### public void
**setRejectedExecutionHandler**
([RejectedExecutionHandler](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RejectedExecutionHandler.html) handler)

Sets a new handler for unexecutable tasks.

##### Parameters

| handler | the new handler |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if handler is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getRejectedExecutionHandler()`

#### public void
**setThreadFactory**
([ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory)

Sets the thread factory used to create new threads.

##### Parameters

| threadFactory | the new thread factory |
|---|---|

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if threadFactory is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#getThreadFactory()`

#### public void
**shutdown**
()

Initiates an orderly shutdown in which previously submitted
tasks are executed, but no new tasks will be accepted.
Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to
complete execution. Use `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#awaitTermination(long,%20java.util.concurrent.TimeUnit)`
to do that.

#### public [List](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/List.html)\<[Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html)\>
**shutdownNow**
()

Attempts to stop all actively executing tasks, halts the
processing of waiting tasks, and returns a list of the tasks
that were awaiting execution. These tasks are drained (removed)
from the task queue upon return from this method.

This method does not wait for actively executing tasks to
terminate. Use `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadPoolExecutor.html#awaitTermination(long,%20java.util.concurrent.TimeUnit)` to
do that.

There are no guarantees beyond best-effort attempts to stop
processing actively executing tasks. This implementation
interrupts tasks via `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Thread.html#interrupt()`; any task that
fails to respond to interrupts may never terminate.

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
()

Returns a string identifying this pool, as well as its state,
including indications of run state and estimated worker and
task counts.

##### Returns

- a string identifying this pool, as well as its state

## Protected Methods

#### protected void
**afterExecute**
([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) r, [Throwable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Throwable.html) t)

Method invoked upon completion of execution of the given Runnable.
This method is invoked by the thread that executed the task. If
non-null, the Throwable is the uncaught `RuntimeException`
or `Error` that caused execution to terminate abruptly.

This implementation does nothing, but may be customized in
subclasses. Note: To properly nest multiple overridings, subclasses
should generally invoke `super.afterExecute` at the
beginning of this method.

**Note:** When actions are enclosed in tasks (such as
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/FutureTask.html`) either explicitly or via methods such as
`submit`, these task objects catch and maintain
computational exceptions, and so they do not cause abrupt
termination, and the internal exceptions are *not*
passed to this method. If you would like to trap both kinds of
failures in this method, you can further probe for such cases,
as in this sample subclass that prints either the direct cause
or the underlying exception if a task has been aborted:

     class ExtendedExecutor extends ThreadPoolExecutor {
       // ...
       protected void afterExecute(Runnable r, Throwable t) {
         super.afterExecute(r, t);
         if (t == null
             && r instanceof Future<?>
             && ((Future<?>)r).isDone()) {
           try {
             Object result = ((Future<?>) r).get();
           } catch (CancellationException ce) {
             t = ce;
           } catch (ExecutionException ee) {
             t = ee.getCause();
           } catch (InterruptedException ie) {
             // ignore/reset
             Thread.currentThread().interrupt();
           }
         }
         if (t != null)
           System.out.println(t);
       }
     }

<br />

##### Parameters

| r | the runnable that has completed |
| t | the exception that caused termination, or null if execution completed normally |
|---|---|

#### protected void
**beforeExecute**
(Thread t, [Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) r)

Method invoked prior to executing the given Runnable in the
given thread. This method is invoked by thread `t` that
will execute task `r`, and may be used to re-initialize
ThreadLocals, or to perform logging.

This implementation does nothing, but may be customized in
subclasses. Note: To properly nest multiple overridings, subclasses
should generally invoke `super.beforeExecute` at the end of
this method.

##### Parameters

| t | the thread that will run task `r` |
| r | the task that will be executed |
|---|---|

#### protected void
**finalize**
()

Invokes `shutdown` when this executor is no longer
referenced and it has no threads.

#### protected void
**terminated**
()

Method invoked when the Executor has terminated. Default
implementation does nothing. Note: To properly nest multiple
overridings, subclasses should generally invoke
`super.terminated` within this method.