libjava/classpath/external/jsr166/java/util/concurrent/Delayed.java

   1 /*
   2  * Written by Doug Lea with assistance from members of JCP JSR-166
   3  * Expert Group and released to the public domain, as explained at
   4  * http://creativecommons.org/licenses/publicdomain
   5  */
   6
   7 package java.util.concurrent;
   8
   9 import java.util.*;
  10
  11 /**
  12  * A mix-in style interface for marking objects that should be
  13  * acted upon after a given delay.
  14  *
  15  * <p>An implementation of this interface must define a
  16  * <tt>compareTo</tt> method that provides an ordering consistent with
  17  * its <tt>getDelay</tt> method.
  18  *
  19  * @since 1.5
  20  * @author Doug Lea
  21  */
  22 public interface Delayed extends Comparable<Delayed> {
  23
  24     /**
  25      * Returns the remaining delay associated with this object, in the
  26      * given time unit.
  27      *
  28      * @param unit the time unit
  29      * @return the remaining delay; zero or negative values indicate
  30      * that the delay has already elapsed
  31      */
  32     long getDelay(TimeUnit unit);
  33 }