package java.util.concurrent;
/**
* 一个混合样式的接口,用于标记在给定延迟后应起作用的对象。
*
* <p>该接口的实现必须定义一个compareTo方法,该方法提供与其getDelay方法一致的排序。
*
* @since 1.5
* @author Doug Lea
*/
public interface Delayed extends Comparable<Delayed> {
/**
* 在给定的时间单位内返回与此对象关联的剩余延迟。
*
* @param unit the time unit
* @return the remaining delay; zero or negative values indicate
* that the delay has already elapsed
*/
long getDelay(TimeUnit unit);
}
package java.util.concurrent;
/**
* 可取消的延迟的结果产生操作。
* 通常,一个预定的future是使用ScheduledExecutorService调度任务的结果。
*
* @since 1.5
* @author Doug Lea
* @param <V> The result type returned by this Future
*/
public interface ScheduledFuture<V> extends Delayed, Future<V> {
}
package java.util.concurrent;
/**
* 一种ExecutorService,它可以调度命令在给定延迟后运行,或定期执行。
*
* <p>schedule方法创建具有各种延迟的任务,并返回一个可以用来取消或检查执行的任务对象。
* scheduleAtFixedRate和scheduleWithFixedDelay方法创建并执行定期运行的任务,直到被取消。
*
* <p>使用Executor.execute(Runnable)和ExecutorService.submit方法提交的命令被调度为请求的零延迟。
* 在调度方法中也允许零延迟和负延迟(但不是周期),并被视为立即执行的请求。
*
* <p>所有调度方法都接受相对延迟和周期作为参数,而不是绝对时间或日期。
* 将表示为java.util.Date的绝对时间转换为所需的形式是一件简单的事情。
* 例如,要调度某个未来的日期,可以使用:schedule(task,date. gettime () - System.currentTimeMillis(),TimeUnit.MILLISECONDS)。
* 但是要注意,由于网络时间同步协议、时钟漂移或其他因素,相对延迟的过期时间不需要与任务启用的当前日期一致。
*
* <p>Executors类为这个包中提供的ScheduledExecutorService实现提供了方便的工厂方法。
*
* 使用的例子
* 下面是一个类,它有一个方法,设置一个ScheduledExecutorServiceto每隔10秒响一个小时:
*
* <pre> {@code
* 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);
* }
* }}</pre>
*
* @since 1.5
* @author Doug Lea
*/
public interface ScheduledExecutorService extends ExecutorService {
/**
* 创建并执行一个在给定延迟后启用的一次性操作。
*
* @param command the task to execute
* @param delay the time from now to delay execution
* @param unit the time unit of the delay parameter
* @return a ScheduledFuture representing pending completion of
* the task and whose {@code get()} method will return
* {@code null} upon completion
* @throws RejectedExecutionException if the task cannot be
* scheduled for execution
* @throws NullPointerException if command is null
*/
public ScheduledFuture<?> schedule(Runnable command,
long delay, TimeUnit unit);
/**
* 创建并执行在给定延迟后启用的ScheduledFuture。
*
* @param callable the function to execute
* @param delay the time from now to delay execution
* @param unit the time unit of the delay parameter
* @param <V> the type of the callable's result
* @return a ScheduledFuture that can be used to extract result or cancel
* @throws RejectedExecutionException if the task cannot be
* scheduled for execution
* @throws NullPointerException if callable is null
*/
public <V> ScheduledFuture<V> schedule(Callable<V> callable,
long delay, TimeUnit unit);
/**
* 创建并执行一个周期操作,该操作首先在给定的初始延迟后启用,然后在给定的周期后启用;
* 即执行将在initialDelay之后开始,然后initialDelay+period,然后initialDelay+ 2 * period,依此类推。
* 如果task计数器的任何一次执行出现异常,则后续的执行将被抑制。
* 否则,任务将仅通过取消或终止执行程序来终止。
* 如果这个任务的执行时间超过了它的周期,那么后续的执行可能会较晚开始,但不会并发执行。
*
* @param command the task to execute
* @param initialDelay the time to delay first execution
* @param period the period between successive executions
* @param unit the time unit of the initialDelay and period parameters
* @return a ScheduledFuture representing pending completion of
* the task, and whose {@code get()} method will throw an
* exception upon cancellation
* @throws RejectedExecutionException if the task cannot be
* scheduled for execution
* @throws NullPointerException if command is null
* @throws IllegalArgumentException if period less than or equal to zero
*/
public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
long initialDelay,
long period,
TimeUnit unit);
/**
* 创建并执行一个周期操作,该操作首先在给定的初始延迟之后启用,
* 然后在一个执行的终止和下一个执行的开始之间启用给定的延迟。
* 如果task计数器的任何一次执行出现异常,则后续的执行将被抑制。
* 否则,任务将仅通过取消或终止执行程序来终止。
*
* @param command the task to execute
* @param initialDelay the time to delay first execution
* @param delay the delay between the termination of one
* execution and the commencement of the next
* @param unit the time unit of the initialDelay and delay parameters
* @return a ScheduledFuture representing pending completion of
* the task, and whose {@code get()} method will throw an
* exception upon cancellation
* @throws RejectedExecutionException if the task cannot be
* scheduled for execution
* @throws NullPointerException if command is null
* @throws IllegalArgumentException if delay less than or equal to zero
*/
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
long initialDelay,
long delay,
TimeUnit unit);
}
package java.util.concurrent;
/**
* 一个Runnable的ScheduledFuture。
* run方法的成功执行将导致Future的完成,并允许访问其结果。
*
* @see FutureTask
* @see Executor
* @since 1.6
* @author Doug Lea
* @param <V> The result type returned by this Future's {@code get} method
*/
public interface RunnableScheduledFuture<V> extends RunnableFuture<V>, ScheduledFuture<V> {
/**
* 如果此任务是周期性的,则返回true。
* 周期性任务可以根据某个计划重新运行。
* 非周期任务只能运行一次。
*
* @return {@code true} if this task is periodic
*/
boolean isPeriodic();
}