util/concurrent/Delayed.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain. Use, modify, and
 * redistribute this code in any way without acknowledgement.
 */

package java.util.concurrent;
import java.util.*;

/**
 * A mix-in style interface for representing actions, events, etc that
 * should be executed, accessed or acted upon only 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 {

    /**
     * Get the delay associated with this object, in the given time unit.
     * @param unit the time unit
     * @return the delay; zero or negative values indicate that the
     * delay has already elapsed
     */
    long getDelay(TimeUnit unit);
}
Revision:	1.4
Committed:	Sun Aug 31 13:33:13 2003 UTC (20 years, 9 months ago) by dl
Branch:	MAIN
Changes since 1.3:	+8 -3 lines
Log Message:	Removed non-standard tags and misc javadoc cleanup
#	User	Rev	Content
1	dl	1.1	/*
2			* Written by Doug Lea with assistance from members of JCP JSR-166
3			* Expert Group and released to the public domain. Use, modify, and
4			* redistribute this code in any way without acknowledgement.
5			*/
6
7			package java.util.concurrent;
8			import java.util.*;
9
10			/**
11	dl	1.4	* A mix-in style interface for representing actions, events, etc that
12			* should be executed, accessed or acted upon only after a given
13			* 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	dl	1.3	* @since 1.5
20			* @author Doug Lea
21	dl	1.1	*/
22			public interface Delayed extends Comparable {
23
24			/**
25	jozart	1.2	* Get the delay associated with this object, in the given time unit.
26	dl	1.1	* @param unit the time unit
27			* @return the delay; zero or negative values indicate that the
28	jozart	1.2	* delay has already elapsed
29	dl	1.1	*/
30	dl	1.3	long getDelay(TimeUnit unit);
31	dl	1.1	}