public interface java.util.concurrent
ScheduledExecutorService


Show All Login
Java SE 6
  
Implements: ExecutorService
Implemented by: ScheduledThreadPoolExecutor
Details
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);
    }
 }
 
since1.5

Methods
public ScheduledFuture schedule(Runnable command, long delay, TimeUnit unit) Details
Creates and executes a one-shot action that becomes enabled after the given delay.
commandthe task to execute
delaythe time from now to delay execution
unitthe time unit of the delay parameter
returna ScheduledFuture representing pending completion of the task and whose get() method will return null upon completion
ThrowsRejectedExecutionException: if the task cannot be scheduled for execution
ThrowsNullPointerException: if command is null
public ScheduledFuture<V> schedule(Callable callable, long delay, TimeUnit unit) Details
Creates and executes a ScheduledFuture that becomes enabled after the given delay.
callablethe function to execute
delaythe time from now to delay execution
unitthe time unit of the delay parameter
returna ScheduledFuture that can be used to extract result or cancel
ThrowsRejectedExecutionException: if the task cannot be scheduled for execution
ThrowsNullPointerException: if callable is null
public ScheduledFuture scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) Details
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. If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute.
commandthe task to execute
initialDelaythe time to delay first execution
periodthe period between successive executions
unitthe time unit of the initialDelay and period parameters
returna ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation
ThrowsRejectedExecutionException: if the task cannot be scheduled for execution
ThrowsNullPointerException: if command is null
ThrowsIllegalArgumentException: if period less than or equal to zero
public ScheduledFuture scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) Details
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.
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
returna ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation
ThrowsRejectedExecutionException: if the task cannot be scheduled for execution
ThrowsNullPointerException: if command is null
ThrowsIllegalArgumentException: if delay less than or equal to zero