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 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 {

    /**
     * Returns 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.6
Committed:	Wed Nov 26 06:32:50 2003 UTC (20 years, 6 months ago) by jozart
Branch:	MAIN
CVS Tags:	JSR166_DEC9_PRE_ES_SUBMIT, JSR166_DEC9_POST_ES_SUBMIT
Changes since 1.5:	+3 -1 lines
Log Message:	Tweaks: Get => Returns, etc.
#	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	jozart	1.6
9	dl	1.1	import java.util.*;
10
11			/**
12	dl	1.5	* A mix-in style interface for marking objects that should be
13			* acted upon after a given delay.
14	dl	1.4	*
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.6	* Returns the delay associated with this object, in the given time unit.
26			*
27	dl	1.1	* @param unit the time unit
28			* @return the delay; zero or negative values indicate that the
29	jozart	1.2	* delay has already elapsed
30	dl	1.1	*/
31	dl	1.3	long getDelay(TimeUnit unit);
32	dl	1.1	}