public class java.util.concurrent
ScheduledThreadPoolExecutor


Show All Login
Java SE 6
  
Extends: AbstractExecutorService > ThreadPoolExecutor
Implements: ScheduledExecutorService
Details
A ThreadPoolExecutor that can additionally schedule commands to run after a given delay, or to execute periodically. This class is preferable to java.util.Timer when multiple worker threads are needed, or when the additional flexibility or capabilities of ThreadPoolExecutor (which this class extends) are required.

Delayed tasks execute no sooner than they are enabled, but without any real-time guarantees about when, after they are enabled, they will commence. Tasks scheduled for exactly the same execution time are enabled in first-in-first-out (FIFO) order of submission.

While this class inherits from ThreadPoolExecutor, a few of the inherited tuning methods are not useful for it. In particular, because it acts as a fixed-sized pool using corePoolSize threads and an unbounded queue, adjustments to maximumPoolSize have no useful effect.

Extension notes: This class overrides AbstractExecutorService submit methods to generate internal objects to control per-task delays and scheduling. To preserve functionality, any further overrides of these methods in subclasses must invoke superclass versions, which effectively disables additional task customization. However, this class provides alternative protected extension method decorateTask (one version each for Runnable and Callable) that can be used to customize the concrete task types used to execute commands entered via execute, submit, schedule, scheduleAtFixedRate, and scheduleWithFixedDelay. By default, a ScheduledThreadPoolExecutor uses a task type extending FutureTask. However, this may be modified or replaced using subclasses of the form:

 public class CustomScheduledExecutor extends ScheduledThreadPoolExecutor {

   static class CustomTask<V> implements RunnableScheduledFuture<V> { ... }

   protected <V> RunnableScheduledFuture<V> decorateTask(
                Runnable r, RunnableScheduledFuture<V> task) {
       return new CustomTask<V>(r, task);
   }

   protected <V> RunnableScheduledFuture<V> decorateTask(
                Callable<V> c, RunnableScheduledFuture<V> task) {
       return new CustomTask<V>(c, task);
   }
   // ... add constructors, etc.
 }
 
since1.5

Constructors
public ScheduledThreadPoolExecutor(int corePoolSize) Details
Creates a new ScheduledThreadPoolExecutor with the given core pool size.
corePoolSizethe number of threads to keep in the pool, even if they are idle
ThrowsIllegalArgumentException: if corePoolSize < 0
public ScheduledThreadPoolExecutor(int corePoolSize, ThreadFactory threadFactory) Details
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
corePoolSizethe number of threads to keep in the pool, even if they are idle
threadFactorythe factory to use when the executor creates a new thread
ThrowsIllegalArgumentException: if corePoolSize < 0
ThrowsNullPointerException: if threadFactory is null
public ScheduledThreadPoolExecutor(int corePoolSize, RejectedExecutionHandler handler) Details
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
corePoolSizethe number of threads to keep in the pool, even if they are idle
handlerthe handler to use when execution is blocked because the thread bounds and queue capacities are reached
ThrowsIllegalArgumentException: if corePoolSize < 0
ThrowsNullPointerException: if handler is null
public ScheduledThreadPoolExecutor(int corePoolSize, ThreadFactory threadFactory, RejectedExecutionHandler handler) Details
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
corePoolSizethe number of threads to keep in the pool, even if they are idle
threadFactorythe factory to use when the executor creates a new thread
handlerthe handler to use when execution is blocked because the thread bounds and queue capacities are reached.
ThrowsIllegalArgumentException: if corePoolSize < 0
ThrowsNullPointerException: if threadFactory or handler is null

Methods
protected RunnableScheduledFuture<V> decorateTask(Runnable runnable, RunnableScheduledFuture task) Details
Modifies or replaces the task used to execute a runnable. This method can be used to override the concrete class used for managing internal tasks. The default implementation simply returns the given task.
runnablethe submitted Runnable
taskthe task created to execute the runnable
returna task that can execute the runnable
since1.6
protected RunnableScheduledFuture<V> decorateTask(Callable callable, RunnableScheduledFuture task) Details
Modifies or replaces the task used to execute a callable. This method can be used to override the concrete class used for managing internal tasks. The default implementation simply returns the given task.
callablethe submitted Callable
taskthe task created to execute the callable
returna task that can execute the callable
since1.6
public void execute(Runnable command) Details
Executes command with zero required delay. This has effect equivalent to schedule(command, 0, anyUnit). Note that inspections of the queue and of the list returned by shutdownNow will access the zero-delayed ScheduledFuture, not the command itself.
commandthe task to execute
ThrowsRejectedExecutionException: at discretion of RejectedExecutionHandler, if task cannot be accepted for execution because the executor has been shut down.
ThrowsNullPointerException: if command is null
public boolean remove(Runnable task)
public ScheduledFuture schedule(Runnable command, long delay, TimeUnit unit)
public ScheduledFuture<V> schedule(Callable callable, long delay, TimeUnit unit)
public ScheduledFuture scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
public ScheduledFuture scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
public void shutdown()
Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. If the ExecuteExistingDelayedTasksAfterShutdownPolicy has been set false, existing delayed tasks whose delays have not yet elapsed are cancelled. And unless the ContinueExistingPeriodicTasksAfterShutdownPolicy has been set true, future executions of existing periodic tasks will be cancelled.
public List shutdownNow() Details
Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.

There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. This implementation cancels tasks via Thread#interrupt, so any task that fails to respond to interrupts may never terminate.
returnlist of tasks that never commenced execution. Each element of this list is a ScheduledFuture, including those tasks submitted using execute, which are for scheduling purposes used as the basis of a zero-delay ScheduledFuture.
ThrowsSecurityException: if a security manager exists and shutting down this ExecutorService may manipulate threads that the caller is not permitted to modify because it does not hold java.lang.RuntimePermission("modifyThread"), or the security manager's checkAccess method denies access.

public Future submit(Runnable task)
public Future<T> submit(Runnable task, Object result)
public Future<T> submit(Callable task)

Properties
public void setContinueExistingPeriodicTasksAfterShutdownPolicy(boolean value) Details
Sets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow, or after setting the policy to false when already shutdown. This value is by default false.
valueif true, continue after shutdown, else don't.
See also getContinueExistingPeriodicTasksAfterShutdownPolicy
public boolean getContinueExistingPeriodicTasksAfterShutdownPolicy() Details
Gets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow or after setting the policy to false when already shutdown. This value is by default false.
returntrue if will continue after shutdown
See also setContinueExistingPeriodicTasksAfterShutdownPolicy
public void setExecuteExistingDelayedTasksAfterShutdownPolicy(boolean value) Details
Sets the policy on whether to execute existing delayed tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow, or after setting the policy to false when already shutdown. This value is by default true.
valueif true, execute after shutdown, else don't.
See also getExecuteExistingDelayedTasksAfterShutdownPolicy
public boolean getExecuteExistingDelayedTasksAfterShutdownPolicy() Details
Gets the policy on whether to execute existing delayed tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow, or after setting the policy to false when already shutdown. This value is by default true.
returntrue if will execute after shutdown
See also setExecuteExistingDelayedTasksAfterShutdownPolicy
public BlockingQueue getQueue() Details
Returns the task queue used by this executor. Each element of this queue is a ScheduledFuture, including those tasks submitted using execute which are for scheduling purposes used as the basis of a zero-delay ScheduledFuture. Iteration over this queue is not guaranteed to traverse tasks in the order in which they will execute.
returnthe task queue