util/concurrent/Delayed.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/licenses/publicdomain
 */

package java.util.concurrent;

import java.util.*;

/**
 * A mix-in style interface for marking objects that should be
 * acted upon after a given delay.
 *
 * <p>An implementation of this interface must define a
 * <tt>compareTo</tt> method that provides an ordering consistent with
 * its <tt>getDelay</tt> method.
 *
 * @since 1.5
 * @author Doug Lea
 */
public interface Delayed extends Comparable<Delayed> {

    /**
     * Returns the remaining delay associated with this object, in the
     * given time unit.
     *
     * @param unit the time unit
     * @return the remaining delay; zero or negative values indicate
     * that the delay has already elapsed
     */
    long getDelay(TimeUnit unit);
}
Revision:	1.8
Committed:	Sat Apr 10 14:24:36 2004 UTC (20 years, 2 months ago) by dl
Branch:	MAIN
Changes since 1.7:	+5 -4 lines
Log Message:	Don't use raw type for Comparable
#	Content
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	}