An ExecutorService that can schedule commands to run after a given delay, or to execute periodically.

The schedule methods create tasks with various delays and return a task object that can be used to cancel or check execution. The scheduleAtFixedRate and scheduleWithFixedDelay methods create and execute tasks that run periodically until cancelled.

Commands submitted using the Executor#execute and ExecutorService submit methods are scheduled with a requested delay of zero. Zero and negative delays (but not periods) are also allowed in schedule methods, and are treated as requests for immediate execution.

All schedule methods accept relative delays and periods as arguments, not absolute times or dates. It is a simple matter to transform an absolute time represented as a java.util.Date to the required form. For example, to schedule at a certain future date, you can use: schedule(task, date.getTime() - System.currentTimeMillis(), TimeUnit.MILLISECONDS). Beware however that expiration of a relative delay need not coincide with the current Date at which the task is enabled due to network time synchronization protocols, clock drift, or other factors. The Executors class provides convenient factory methods for the ScheduledExecutorService implementations provided in this package.

Usage Example

Here is a class with a method that sets up a ScheduledExecutorService to beep every ten seconds for an hour:
 import static java.util.concurrent.TimeUnit.*;
 class BeeperControl {
    private final ScheduledExecutorService scheduler = 
       Executors.newScheduledThreadPool(1);

    public void beepForAnHour() {
        final Runnable beeper = new Runnable() {
                public void run() { System.out.println("beep"); }
            };
        final ScheduledFuture<?> beeperHandle = 
            scheduler.scheduleAtFixedRate(beeper, 10, 10, SECONDS);
        scheduler.schedule(new Runnable() {
                public void run() { beeperHandle.cancel(true); }
            }, 60 * 60, SECONDS);
    }
 }
 
@since
1.5
@author
Doug Lea
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
Parameters
timeoutthe maximum time to wait
unitthe time unit of the timeout argument
Return
true if this executor terminated and false if the timeout elapsed before termination
Throws
InterruptedExceptionif interrupted while waiting
Executes the given tasks, returning a list of Futures holding their status and results when all complete. Future#isDone is true for each element of the returned list. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.
Parameters
tasksthe collection of tasks
Return
A list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed.
Throws
InterruptedExceptionif interrupted while waiting, in which case unfinished tasks are cancelled.
NullPointerExceptionif tasks or any of its elements are null
RejectedExecutionExceptionif any task cannot be scheduled for execution
Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. Future#isDone is true for each element of the returned list. Upon return, tasks that have not completed are cancelled. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.
Parameters
tasksthe collection of tasks
timeoutthe maximum time to wait
unitthe time unit of the timeout argument
Return
A list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed.
Throws
InterruptedExceptionif interrupted while waiting, in which case unfinished tasks are cancelled.
NullPointerExceptionif tasks, any of its elements, or unit are null
RejectedExecutionExceptionif any task cannot be scheduled for execution
Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress.
Parameters
tasksthe collection of tasks
Return
The result returned by one of the tasks.
Throws
InterruptedExceptionif interrupted while waiting
NullPointerExceptionif tasks or any of its elements are null
IllegalArgumentExceptionif tasks empty
ExecutionExceptionif no task successfully completes
RejectedExecutionExceptionif tasks cannot be scheduled for execution
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. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress.
Parameters
tasksthe collection of tasks
timeoutthe maximum time to wait
unitthe time unit of the timeout argument
Return
The result returned by one of the tasks.
Throws
InterruptedExceptionif interrupted while waiting
NullPointerExceptionif tasks, any of its elements, or unit are null
TimeoutExceptionif the given timeout elapses before any task successfully completes
ExecutionExceptionif no task successfully completes
RejectedExecutionExceptionif tasks cannot be scheduled for execution
Returns true if this executor has been shut down.
Return
true if this executor has been shut down
Returns true if all tasks have completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.
Return
true if all tasks have completed following shut down
Creates and executes a ScheduledFuture that becomes enabled after the given delay.
Parameters
callablethe function to execute.
delaythe time from now to delay execution.
unitthe time unit of the delay parameter.
Return
a ScheduledFuture that can be used to extract result or cancel.
Throws
RejectedExecutionExceptionif task cannot be scheduled for execution.
NullPointerExceptionif callable is null
Creates and executes a one-shot action that becomes enabled after the given delay.
Parameters
commandthe task to execute.
delaythe time from now to delay execution.
unitthe time unit of the delay parameter.
Return
a Future representing pending completion of the task, and whose get() method will return null upon completion.
Throws
RejectedExecutionExceptionif task cannot be scheduled for execution.
NullPointerExceptionif command is null
Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence after initialDelay then initialDelay+period, then initialDelay + 2 * period, and so on. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor.
Parameters
commandthe task to execute.
initialDelaythe time to delay first execution.
periodthe period between successive executions.
unitthe time unit of the initialDelay and period parameters
Return
a Future representing pending completion of the task, and whose get() method will throw an exception upon cancellation.
Throws
RejectedExecutionExceptionif task cannot be scheduled for execution.
NullPointerExceptionif command is null
IllegalArgumentExceptionif period less than or equal to zero.
Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor.
Parameters
commandthe task to execute.
initialDelaythe time to delay first execution.
delaythe delay between the termination of one execution and the commencement of the next.
unitthe time unit of the initialDelay and delay parameters
Return
a Future representing pending completion of the task, and whose get() method will throw an exception upon cancellation.
Throws
RejectedExecutionExceptionif task cannot be scheduled for execution.
NullPointerExceptionif command is null
IllegalArgumentExceptionif delay less than or equal to zero.
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.
Throws
SecurityExceptionif 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 {@link java.lang.RuntimePermission}("modifyThread"), or the security manager's checkAccess method denies access.
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. For example, typical implementations will cancel via Thread#interrupt , so if any tasks mask or fail to respond to interrupts, they may never terminate.

Return
list of tasks that never commenced execution
Throws
SecurityExceptionif 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 {@link java.lang.RuntimePermission}("modifyThread"), or the security manager's checkAccess method denies access.
Submits a value-returning task for execution and returns a Future representing the pending results of the task.

If you would like to immediately block waiting for a task, you can use constructions of the form result = exec.submit(aCallable).get();

Note: The Executors class includes a set of methods that can convert some other common closure-like objects, for example, java.security.PrivilegedAction to Callable form so they can be submitted.

Parameters
taskthe task to submit
Return
a Future representing pending completion of the task
Throws
RejectedExecutionExceptionif task cannot be scheduled for execution
NullPointerExceptionif task null
Submits a Runnable task for execution and returns a Future representing that task.
Parameters
taskthe task to submit
Return
a Future representing pending completion of the task, and whose get() method will return null upon completion.
Throws
RejectedExecutionExceptionif task cannot be scheduled for execution
NullPointerExceptionif task null
Submits a Runnable task for execution and returns a Future representing that task that will upon completion return the given result
Parameters
taskthe task to submit
resultthe result to return
Return
a Future representing pending completion of the task, and whose get() method will return the given result upon completion.
Throws
RejectedExecutionExceptionif task cannot be scheduled for execution
NullPointerExceptionif task null