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);
}
}
Blocks until all tasks have completed execution after a shutdown
request, or the timeout occurs, or the current thread is
interrupted, whichever happens first.
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.
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.
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.
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.
Returns 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.
Creates and executes a ScheduledFuture that becomes enabled after the
given delay.
Creates and executes a one-shot action that becomes enabled
after the given delay.
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.
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.
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.
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.
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.
Submits a Runnable task for execution and returns a Future
representing that task.
Submits a Runnable task for execution and returns a Future
representing that task that will upon completion return
the given result