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/publicdomain/zero/1.0/
 */

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.9
Committed:	Tue Mar 15 19:47:03 2011 UTC (13 years, 2 months ago) by jsr166
Branch:	MAIN
CVS Tags:	release-1_7_0
Changes since 1.8:	+1 -1 lines
Log Message:	Update Creative Commons license URL in legal notices
#	User	Rev	Content
1	dl	1.1	/*
2			* Written by Doug Lea with assistance from members of JCP JSR-166
3	dl	1.7	* Expert Group and released to the public domain, as explained at
4	jsr166	1.9	* http://creativecommons.org/publicdomain/zero/1.0/
5	dl	1.1	*/
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	dl	1.8	public interface Delayed extends Comparable<Delayed> {
23	dl	1.1
24			/**
25	dl	1.8	* Returns the remaining delay associated with this object, in the
26			* given time unit.
27	jozart	1.6	*
28	dl	1.1	* @param unit the time unit
29	dl	1.8	* @return the remaining delay; zero or negative values indicate
30			* that the delay has already elapsed
31	dl	1.1	*/
32	dl	1.3	long getDelay(TimeUnit unit);
33	dl	1.1	}