util/concurrent/TimeUnit.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.time.temporal.ChronoUnit;
import java.util.Objects;

/**
 * A {@code TimeUnit} represents time durations at a given unit of
 * granularity and provides utility methods to convert across units,
 * and to perform timing and delay operations in these units.  A
 * {@code TimeUnit} does not maintain time information, but only
 * helps organize and use time representations that may be maintained
 * separately across various contexts.  A nanosecond is defined as one
 * thousandth of a microsecond, a microsecond as one thousandth of a
 * millisecond, a millisecond as one thousandth of a second, a minute
 * as sixty seconds, an hour as sixty minutes, and a day as twenty four
 * hours.
 *
 * <p>A {@code TimeUnit} is mainly used to inform time-based methods
 * how a given timing parameter should be interpreted. For example,
 * the following code will timeout in 50 milliseconds if the {@link
 * java.util.concurrent.locks.Lock lock} is not available:
 *
 * <pre> {@code
 * Lock lock = ...;
 * if (lock.tryLock(50L, TimeUnit.MILLISECONDS)) ...}</pre>
 *
 * while this code will timeout in 50 seconds:
 * <pre> {@code
 * Lock lock = ...;
 * if (lock.tryLock(50L, TimeUnit.SECONDS)) ...}</pre>
 *
 * Note however, that there is no guarantee that a particular timeout
 * implementation will be able to notice the passage of time at the
 * same granularity as the given {@code TimeUnit}.
 *
 * @since 1.5
 * @author Doug Lea
 */
public enum TimeUnit {
    /**
     * Time unit representing one thousandth of a microsecond.
     */
    NANOSECONDS {
        public long toNanos(long d)   { return d; }
        public long toMicros(long d)  { return d/(C1/C0); }
        public long toMillis(long d)  { return d/(C2/C0); }
        public long toSeconds(long d) { return d/(C3/C0); }
        public long toMinutes(long d) { return d/(C4/C0); }
        public long toHours(long d)   { return d/(C5/C0); }
        public long toDays(long d)    { return d/(C6/C0); }
        public long convert(long d, TimeUnit u) { return u.toNanos(d); }
        int excessNanos(long d, long m) { return (int)(d - (m*C2)); }
    },

    /**
     * Time unit representing one thousandth of a millisecond.
     */
    MICROSECONDS {
        public long toNanos(long d)   { return x(d, C1/C0, MAX/(C1/C0)); }
        public long toMicros(long d)  { return d; }
        public long toMillis(long d)  { return d/(C2/C1); }
        public long toSeconds(long d) { return d/(C3/C1); }
        public long toMinutes(long d) { return d/(C4/C1); }
        public long toHours(long d)   { return d/(C5/C1); }
        public long toDays(long d)    { return d/(C6/C1); }
        public long convert(long d, TimeUnit u) { return u.toMicros(d); }
        int excessNanos(long d, long m) { return (int)((d*C1) - (m*C2)); }
    },

    /**
     * Time unit representing one thousandth of a second.
     */
    MILLISECONDS {
        public long toNanos(long d)   { return x(d, C2/C0, MAX/(C2/C0)); }
        public long toMicros(long d)  { return x(d, C2/C1, MAX/(C2/C1)); }
        public long toMillis(long d)  { return d; }
        public long toSeconds(long d) { return d/(C3/C2); }
        public long toMinutes(long d) { return d/(C4/C2); }
        public long toHours(long d)   { return d/(C5/C2); }
        public long toDays(long d)    { return d/(C6/C2); }
        public long convert(long d, TimeUnit u) { return u.toMillis(d); }
        int excessNanos(long d, long m) { return 0; }
    },

    /**
     * Time unit representing one second.
     */
    SECONDS {
        public long toNanos(long d)   { return x(d, C3/C0, MAX/(C3/C0)); }
        public long toMicros(long d)  { return x(d, C3/C1, MAX/(C3/C1)); }
        public long toMillis(long d)  { return x(d, C3/C2, MAX/(C3/C2)); }
        public long toSeconds(long d) { return d; }
        public long toMinutes(long d) { return d/(C4/C3); }
        public long toHours(long d)   { return d/(C5/C3); }
        public long toDays(long d)    { return d/(C6/C3); }
        public long convert(long d, TimeUnit u) { return u.toSeconds(d); }
        int excessNanos(long d, long m) { return 0; }
    },

    /**
     * Time unit representing sixty seconds.
     * @since 1.6
     */
    MINUTES {
        public long toNanos(long d)   { return x(d, C4/C0, MAX/(C4/C0)); }
        public long toMicros(long d)  { return x(d, C4/C1, MAX/(C4/C1)); }
        public long toMillis(long d)  { return x(d, C4/C2, MAX/(C4/C2)); }
        public long toSeconds(long d) { return x(d, C4/C3, MAX/(C4/C3)); }
        public long toMinutes(long d) { return d; }
        public long toHours(long d)   { return d/(C5/C4); }
        public long toDays(long d)    { return d/(C6/C4); }
        public long convert(long d, TimeUnit u) { return u.toMinutes(d); }
        int excessNanos(long d, long m) { return 0; }
    },

    /**
     * Time unit representing sixty minutes.
     * @since 1.6
     */
    HOURS {
        public long toNanos(long d)   { return x(d, C5/C0, MAX/(C5/C0)); }
        public long toMicros(long d)  { return x(d, C5/C1, MAX/(C5/C1)); }
        public long toMillis(long d)  { return x(d, C5/C2, MAX/(C5/C2)); }
        public long toSeconds(long d) { return x(d, C5/C3, MAX/(C5/C3)); }
        public long toMinutes(long d) { return x(d, C5/C4, MAX/(C5/C4)); }
        public long toHours(long d)   { return d; }
        public long toDays(long d)    { return d/(C6/C5); }
        public long convert(long d, TimeUnit u) { return u.toHours(d); }
        int excessNanos(long d, long m) { return 0; }
    },

    /**
     * Time unit representing twenty four hours.
     * @since 1.6
     */
    DAYS {
        public long toNanos(long d)   { return x(d, C6/C0, MAX/(C6/C0)); }
        public long toMicros(long d)  { return x(d, C6/C1, MAX/(C6/C1)); }
        public long toMillis(long d)  { return x(d, C6/C2, MAX/(C6/C2)); }
        public long toSeconds(long d) { return x(d, C6/C3, MAX/(C6/C3)); }
        public long toMinutes(long d) { return x(d, C6/C4, MAX/(C6/C4)); }
        public long toHours(long d)   { return x(d, C6/C5, MAX/(C6/C5)); }
        public long toDays(long d)    { return d; }
        public long convert(long d, TimeUnit u) { return u.toDays(d); }
        int excessNanos(long d, long m) { return 0; }
    };

    // Handy constants for conversion methods
    static final long C0 = 1L;
    static final long C1 = C0 * 1000L;
    static final long C2 = C1 * 1000L;
    static final long C3 = C2 * 1000L;
    static final long C4 = C3 * 60L;
    static final long C5 = C4 * 60L;
    static final long C6 = C5 * 24L;

    static final long MAX = Long.MAX_VALUE;

    /**
     * Scale d by m, checking for overflow.
     * This has a short name to make above code more readable.
     */
    static long x(long d, long m, long over) {
        if (d > +over) return Long.MAX_VALUE;
        if (d < -over) return Long.MIN_VALUE;
        return d * m;
    }

    // To maintain full signature compatibility with 1.5, and to improve the
    // clarity of the generated javadoc (see 6287639: Abstract methods in
    // enum classes should not be listed as abstract), method convert
    // etc. are not declared abstract but otherwise act as abstract methods.

    /**
     * Converts the given time duration in the given unit to this unit.
     * Conversions from finer to coarser granularities truncate, so
     * lose precision. For example, converting {@code 999} milliseconds
     * to seconds results in {@code 0}. Conversions from coarser to
     * finer granularities with arguments that would numerically
     * overflow saturate to {@code Long.MIN_VALUE} if negative or
     * {@code Long.MAX_VALUE} if positive.
     *
     * <p>For example, to convert 10 minutes to milliseconds, use:
     * {@code TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)}
     *
     * @param sourceDuration the time duration in the given {@code sourceUnit}
     * @param sourceUnit the unit of the {@code sourceDuration} argument
     * @return the converted duration in this unit,
     * or {@code Long.MIN_VALUE} if conversion would negatively
     * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
     */
    public long convert(long sourceDuration, TimeUnit sourceUnit) {
        throw new AbstractMethodError();
    }

    /**
     * Equivalent to
     * {@link #convert(long, TimeUnit) NANOSECONDS.convert(duration, this)}.
     * @param duration the duration
     * @return the converted duration,
     * or {@code Long.MIN_VALUE} if conversion would negatively
     * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
     */
    public long toNanos(long duration) {
        throw new AbstractMethodError();
    }

    /**
     * Equivalent to
     * {@link #convert(long, TimeUnit) MICROSECONDS.convert(duration, this)}.
     * @param duration the duration
     * @return the converted duration,
     * or {@code Long.MIN_VALUE} if conversion would negatively
     * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
     */
    public long toMicros(long duration) {
        throw new AbstractMethodError();
    }

    /**
     * Equivalent to
     * {@link #convert(long, TimeUnit) MILLISECONDS.convert(duration, this)}.
     * @param duration the duration
     * @return the converted duration,
     * or {@code Long.MIN_VALUE} if conversion would negatively
     * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
     */
    public long toMillis(long duration) {
        throw new AbstractMethodError();
    }

    /**
     * Equivalent to
     * {@link #convert(long, TimeUnit) SECONDS.convert(duration, this)}.
     * @param duration the duration
     * @return the converted duration,
     * or {@code Long.MIN_VALUE} if conversion would negatively
     * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
     */
    public long toSeconds(long duration) {
        throw new AbstractMethodError();
    }

    /**
     * Equivalent to
     * {@link #convert(long, TimeUnit) MINUTES.convert(duration, this)}.
     * @param duration the duration
     * @return the converted duration,
     * or {@code Long.MIN_VALUE} if conversion would negatively
     * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
     * @since 1.6
     */
    public long toMinutes(long duration) {
        throw new AbstractMethodError();
    }

    /**
     * Equivalent to
     * {@link #convert(long, TimeUnit) HOURS.convert(duration, this)}.
     * @param duration the duration
     * @return the converted duration,
     * or {@code Long.MIN_VALUE} if conversion would negatively
     * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
     * @since 1.6
     */
    public long toHours(long duration) {
        throw new AbstractMethodError();
    }

    /**
     * Equivalent to
     * {@link #convert(long, TimeUnit) DAYS.convert(duration, this)}.
     * @param duration the duration
     * @return the converted duration
     * @since 1.6
     */
    public long toDays(long duration) {
        throw new AbstractMethodError();
    }

    /**
     * Utility to compute the excess-nanosecond argument to wait,
     * sleep, join.
     * @param d the duration
     * @param m the number of milliseconds
     * @return the number of nanoseconds
     */
    abstract int excessNanos(long d, long m);

    /**
     * Performs a timed {@link Object#wait(long, int) Object.wait}
     * using this time unit.
     * This is a convenience method that converts timeout arguments
     * into the form required by the {@code Object.wait} method.
     *
     * <p>For example, you could implement a blocking {@code poll}
     * method (see {@link BlockingQueue#poll BlockingQueue.poll})
     * using:
     *
     * <pre> {@code
     * public synchronized Object poll(long timeout, TimeUnit unit)
     *     throws InterruptedException {
     *   while (empty) {
     *     unit.timedWait(this, timeout);
     *     ...
     *   }
     * }}</pre>
     *
     * @param obj the object to wait on
     * @param timeout the maximum time to wait. If less than
     * or equal to zero, do not wait at all.
     * @throws InterruptedException if interrupted while waiting
     */
    public void timedWait(Object obj, long timeout)
            throws InterruptedException {
        if (timeout > 0) {
            long ms = toMillis(timeout);
            int ns = excessNanos(timeout, ms);
            obj.wait(ms, ns);
        }
    }

    /**
     * Performs a timed {@link Thread#join(long, int) Thread.join}
     * using this time unit.
     * This is a convenience method that converts time arguments into the
     * form required by the {@code Thread.join} method.
     *
     * @param thread the thread to wait for
     * @param timeout the maximum time to wait. If less than
     * or equal to zero, do not wait at all.
     * @throws InterruptedException if interrupted while waiting
     */
    public void timedJoin(Thread thread, long timeout)
            throws InterruptedException {
        if (timeout > 0) {
            long ms = toMillis(timeout);
            int ns = excessNanos(timeout, ms);
            thread.join(ms, ns);
        }
    }

    /**
     * Performs a {@link Thread#sleep(long, int) Thread.sleep} using
     * this time unit.
     * This is a convenience method that converts time arguments into the
     * form required by the {@code Thread.sleep} method.
     *
     * @param timeout the minimum time to sleep. If less than
     * or equal to zero, do not sleep at all.
     * @throws InterruptedException if interrupted while sleeping
     */
    public void sleep(long timeout) throws InterruptedException {
        if (timeout > 0) {
            long ms = toMillis(timeout);
            int ns = excessNanos(timeout, ms);
            Thread.sleep(ms, ns);
        }
    }

    /**
     * Converts this {@code TimeUnit} to the equivalent {@code ChronoUnit}.
     *
     * @return the converted equivalent ChronoUnit
     * @since 9
     */
    public ChronoUnit toChronoUnit() {
        switch (this) {
        case NANOSECONDS:  return ChronoUnit.NANOS;
        case MICROSECONDS: return ChronoUnit.MICROS;
        case MILLISECONDS: return ChronoUnit.MILLIS;
        case SECONDS:      return ChronoUnit.SECONDS;
        case MINUTES:      return ChronoUnit.MINUTES;
        case HOURS:        return ChronoUnit.HOURS;
        case DAYS:         return ChronoUnit.DAYS;
        default: throw new AssertionError();
        }
    }

    /**
     * Converts a {@code ChronoUnit} to the equivalent {@code TimeUnit}.
     *
     * @param chronoUnit the ChronoUnit to convert
     * @return the converted equivalent TimeUnit
     * @throws IllegalArgumentException if {@code chronoUnit} has no
     *         equivalent TimeUnit
     * @throws NullPointerException if {@code chronoUnit} is null
     * @since 9
     */
    public static TimeUnit of(ChronoUnit chronoUnit) {
        switch (Objects.requireNonNull(chronoUnit, "chronoUnit")) {
        case NANOS:   return TimeUnit.NANOSECONDS;
        case MICROS:  return TimeUnit.MICROSECONDS;
        case MILLIS:  return TimeUnit.MILLISECONDS;
        case SECONDS: return TimeUnit.SECONDS;
        case MINUTES: return TimeUnit.MINUTES;
        case HOURS:   return TimeUnit.HOURS;
        case DAYS:    return TimeUnit.DAYS;
        default:
            throw new IllegalArgumentException(
                "No TimeUnit equivalent for " + chronoUnit);
        }
    }

}
Revision:	1.48
Committed:	Fri Jan 29 20:02:39 2016 UTC (8 years, 4 months ago) by jsr166
Branch:	MAIN
Changes since 1.47:	+47 -0 lines
Log Message:	Implement 8141452: Convert between TimeUnit and ChronoUnit
#	User	Rev	Content
1	dl	1.2	/*
2	jsr166	1.35	* 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	jsr166	1.38	* http://creativecommons.org/publicdomain/zero/1.0/
5	jsr166	1.35	*/
6	dl	1.2
7	tim	1.1	package java.util.concurrent;
8
9	jsr166	1.48	import java.time.temporal.ChronoUnit;
10			import java.util.Objects;
11
12	tim	1.1	/**
13	jsr166	1.40	* A {@code TimeUnit} represents time durations at a given unit of
14	dl	1.27	* granularity and provides utility methods to convert across units,
15			* and to perform timing and delay operations in these units. A
16	jsr166	1.40	* {@code TimeUnit} does not maintain time information, but only
17	dl	1.27	* helps organize and use time representations that may be maintained
18			* separately across various contexts. A nanosecond is defined as one
19			* thousandth of a microsecond, a microsecond as one thousandth of a
20			* millisecond, a millisecond as one thousandth of a second, a minute
21			* as sixty seconds, an hour as sixty minutes, and a day as twenty four
22			* hours.
23			*
24	jsr166	1.40	* <p>A {@code TimeUnit} is mainly used to inform time-based methods
25	dl	1.27	* how a given timing parameter should be interpreted. For example,
26			* the following code will timeout in 50 milliseconds if the {@link
27			* java.util.concurrent.locks.Lock lock} is not available:
28			*
29	jsr166	1.45	* <pre> {@code
30	jsr166	1.39	* Lock lock = ...;
31			* if (lock.tryLock(50L, TimeUnit.MILLISECONDS)) ...}</pre>
32			*
33	dl	1.27	* while this code will timeout in 50 seconds:
34	jsr166	1.45	* <pre> {@code
35	jsr166	1.39	* Lock lock = ...;
36			* if (lock.tryLock(50L, TimeUnit.SECONDS)) ...}</pre>
37	dl	1.27	*
38			* Note however, that there is no guarantee that a particular timeout
39			* implementation will be able to notice the passage of time at the
40	jsr166	1.40	* same granularity as the given {@code TimeUnit}.
41	dl	1.27	*
42			* @since 1.5
43			* @author Doug Lea
44			*/
45	dl	1.20	public enum TimeUnit {
46	jsr166	1.43	/**
47	jsr166	1.47	* Time unit representing one thousandth of a microsecond.
48	jsr166	1.43	*/
49	dl	1.34	NANOSECONDS {
50	dl	1.27	public long toNanos(long d) { return d; }
51			public long toMicros(long d) { return d/(C1/C0); }
52			public long toMillis(long d) { return d/(C2/C0); }
53			public long toSeconds(long d) { return d/(C3/C0); }
54			public long toMinutes(long d) { return d/(C4/C0); }
55			public long toHours(long d) { return d/(C5/C0); }
56			public long toDays(long d) { return d/(C6/C0); }
57			public long convert(long d, TimeUnit u) { return u.toNanos(d); }
58			int excessNanos(long d, long m) { return (int)(d - (m*C2)); }
59			},
60	jsr166	1.43
61			/**
62	jsr166	1.47	* Time unit representing one thousandth of a millisecond.
63	jsr166	1.43	*/
64	dl	1.34	MICROSECONDS {
65	dl	1.27	public long toNanos(long d) { return x(d, C1/C0, MAX/(C1/C0)); }
66			public long toMicros(long d) { return d; }
67			public long toMillis(long d) { return d/(C2/C1); }
68			public long toSeconds(long d) { return d/(C3/C1); }
69			public long toMinutes(long d) { return d/(C4/C1); }
70			public long toHours(long d) { return d/(C5/C1); }
71			public long toDays(long d) { return d/(C6/C1); }
72			public long convert(long d, TimeUnit u) { return u.toMicros(d); }
73			int excessNanos(long d, long m) { return (int)((dC1) - (mC2)); }
74			},
75	jsr166	1.43
76			/**
77	jsr166	1.47	* Time unit representing one thousandth of a second.
78	jsr166	1.43	*/
79	dl	1.34	MILLISECONDS {
80	dl	1.27	public long toNanos(long d) { return x(d, C2/C0, MAX/(C2/C0)); }
81			public long toMicros(long d) { return x(d, C2/C1, MAX/(C2/C1)); }
82			public long toMillis(long d) { return d; }
83			public long toSeconds(long d) { return d/(C3/C2); }
84			public long toMinutes(long d) { return d/(C4/C2); }
85			public long toHours(long d) { return d/(C5/C2); }
86			public long toDays(long d) { return d/(C6/C2); }
87			public long convert(long d, TimeUnit u) { return u.toMillis(d); }
88			int excessNanos(long d, long m) { return 0; }
89			},
90	jsr166	1.43
91			/**
92	jsr166	1.47	* Time unit representing one second.
93	jsr166	1.43	*/
94	dl	1.34	SECONDS {
95	dl	1.27	public long toNanos(long d) { return x(d, C3/C0, MAX/(C3/C0)); }
96			public long toMicros(long d) { return x(d, C3/C1, MAX/(C3/C1)); }
97			public long toMillis(long d) { return x(d, C3/C2, MAX/(C3/C2)); }
98			public long toSeconds(long d) { return d; }
99			public long toMinutes(long d) { return d/(C4/C3); }
100			public long toHours(long d) { return d/(C5/C3); }
101			public long toDays(long d) { return d/(C6/C3); }
102			public long convert(long d, TimeUnit u) { return u.toSeconds(d); }
103			int excessNanos(long d, long m) { return 0; }
104			},
105	jsr166	1.43
106			/**
107	jsr166	1.47	* Time unit representing sixty seconds.
108	jsr166	1.44	* @since 1.6
109	jsr166	1.43	*/
110	dl	1.34	MINUTES {
111	dl	1.27	public long toNanos(long d) { return x(d, C4/C0, MAX/(C4/C0)); }
112			public long toMicros(long d) { return x(d, C4/C1, MAX/(C4/C1)); }
113			public long toMillis(long d) { return x(d, C4/C2, MAX/(C4/C2)); }
114			public long toSeconds(long d) { return x(d, C4/C3, MAX/(C4/C3)); }
115			public long toMinutes(long d) { return d; }
116			public long toHours(long d) { return d/(C5/C4); }
117			public long toDays(long d) { return d/(C6/C4); }
118			public long convert(long d, TimeUnit u) { return u.toMinutes(d); }
119			int excessNanos(long d, long m) { return 0; }
120			},
121	jsr166	1.43
122			/**
123	jsr166	1.47	* Time unit representing sixty minutes.
124	jsr166	1.44	* @since 1.6
125	jsr166	1.43	*/
126	dl	1.34	HOURS {
127	dl	1.27	public long toNanos(long d) { return x(d, C5/C0, MAX/(C5/C0)); }
128			public long toMicros(long d) { return x(d, C5/C1, MAX/(C5/C1)); }
129			public long toMillis(long d) { return x(d, C5/C2, MAX/(C5/C2)); }
130			public long toSeconds(long d) { return x(d, C5/C3, MAX/(C5/C3)); }
131			public long toMinutes(long d) { return x(d, C5/C4, MAX/(C5/C4)); }
132			public long toHours(long d) { return d; }
133			public long toDays(long d) { return d/(C6/C5); }
134			public long convert(long d, TimeUnit u) { return u.toHours(d); }
135			int excessNanos(long d, long m) { return 0; }
136			},
137	jsr166	1.43
138			/**
139	jsr166	1.47	* Time unit representing twenty four hours.
140	jsr166	1.44	* @since 1.6
141	jsr166	1.43	*/
142	dl	1.34	DAYS {
143	dl	1.27	public long toNanos(long d) { return x(d, C6/C0, MAX/(C6/C0)); }
144			public long toMicros(long d) { return x(d, C6/C1, MAX/(C6/C1)); }
145			public long toMillis(long d) { return x(d, C6/C2, MAX/(C6/C2)); }
146			public long toSeconds(long d) { return x(d, C6/C3, MAX/(C6/C3)); }
147			public long toMinutes(long d) { return x(d, C6/C4, MAX/(C6/C4)); }
148			public long toHours(long d) { return x(d, C6/C5, MAX/(C6/C5)); }
149			public long toDays(long d) { return d; }
150			public long convert(long d, TimeUnit u) { return u.toDays(d); }
151			int excessNanos(long d, long m) { return 0; }
152			};
153	jsr166	1.29
154	dl	1.27	// Handy constants for conversion methods
155			static final long C0 = 1L;
156			static final long C1 = C0 * 1000L;
157			static final long C2 = C1 * 1000L;
158			static final long C3 = C2 * 1000L;
159			static final long C4 = C3 * 60L;
160			static final long C5 = C4 * 60L;
161			static final long C6 = C5 * 24L;
162	jsr166	1.29
163	dl	1.27	static final long MAX = Long.MAX_VALUE;
164	jsr166	1.29
165	dl	1.27	/**
166			* Scale d by m, checking for overflow.
167			* This has a short name to make above code more readable.
168			*/
169			static long x(long d, long m, long over) {
170	jsr166	1.46	if (d > +over) return Long.MAX_VALUE;
171	dl	1.27	if (d < -over) return Long.MIN_VALUE;
172			return d * m;
173			}
174	jsr166	1.29
175	jsr166	1.33	// To maintain full signature compatibility with 1.5, and to improve the
176			// clarity of the generated javadoc (see 6287639: Abstract methods in
177			// enum classes should not be listed as abstract), method convert
178			// etc. are not declared abstract but otherwise act as abstract methods.
179	dl	1.32
180	dl	1.27	/**
181	jsr166	1.42	* Converts the given time duration in the given unit to this unit.
182			* Conversions from finer to coarser granularities truncate, so
183			* lose precision. For example, converting {@code 999} milliseconds
184			* to seconds results in {@code 0}. Conversions from coarser to
185			* finer granularities with arguments that would numerically
186			* overflow saturate to {@code Long.MIN_VALUE} if negative or
187			* {@code Long.MAX_VALUE} if positive.
188	jsr166	1.33	*
189			* <p>For example, to convert 10 minutes to milliseconds, use:
190	jsr166	1.40	* {@code TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)}
191	dl	1.27	*
192	jsr166	1.40	* @param sourceDuration the time duration in the given {@code sourceUnit}
193			* @param sourceUnit the unit of the {@code sourceDuration} argument
194	dl	1.27	* @return the converted duration in this unit,
195	jsr166	1.40	* or {@code Long.MIN_VALUE} if conversion would negatively
196			* overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
197	dl	1.27	*/
198	dl	1.32	public long convert(long sourceDuration, TimeUnit sourceUnit) {
199			throw new AbstractMethodError();
200			}
201	jsr166	1.29
202	dl	1.27	/**
203	jsr166	1.41	* Equivalent to
204			* {@link #convert(long, TimeUnit) NANOSECONDS.convert(duration, this)}.
205	dl	1.27	* @param duration the duration
206			* @return the converted duration,
207	jsr166	1.40	* or {@code Long.MIN_VALUE} if conversion would negatively
208			* overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
209	dl	1.27	*/
210	dl	1.32	public long toNanos(long duration) {
211			throw new AbstractMethodError();
212			}
213	jsr166	1.29
214	dl	1.27	/**
215	jsr166	1.41	* Equivalent to
216			* {@link #convert(long, TimeUnit) MICROSECONDS.convert(duration, this)}.
217	dl	1.27	* @param duration the duration
218			* @return the converted duration,
219	jsr166	1.40	* or {@code Long.MIN_VALUE} if conversion would negatively
220			* overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
221	dl	1.27	*/
222	dl	1.32	public long toMicros(long duration) {
223			throw new AbstractMethodError();
224			}
225	jsr166	1.29
226	dl	1.27	/**
227	jsr166	1.41	* Equivalent to
228			* {@link #convert(long, TimeUnit) MILLISECONDS.convert(duration, this)}.
229	dl	1.27	* @param duration the duration
230			* @return the converted duration,
231	jsr166	1.40	* or {@code Long.MIN_VALUE} if conversion would negatively
232			* overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
233	dl	1.27	*/
234	dl	1.32	public long toMillis(long duration) {
235			throw new AbstractMethodError();
236			}
237	jsr166	1.29
238	dl	1.27	/**
239	jsr166	1.41	* Equivalent to
240			* {@link #convert(long, TimeUnit) SECONDS.convert(duration, this)}.
241	dl	1.27	* @param duration the duration
242			* @return the converted duration,
243	jsr166	1.40	* or {@code Long.MIN_VALUE} if conversion would negatively
244			* overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
245	dl	1.27	*/
246	dl	1.32	public long toSeconds(long duration) {
247			throw new AbstractMethodError();
248			}
249	jsr166	1.29
250	dl	1.27	/**
251	jsr166	1.41	* Equivalent to
252			* {@link #convert(long, TimeUnit) MINUTES.convert(duration, this)}.
253	dl	1.27	* @param duration the duration
254			* @return the converted duration,
255	jsr166	1.40	* or {@code Long.MIN_VALUE} if conversion would negatively
256			* overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
257	dl	1.31	* @since 1.6
258	dl	1.27	*/
259	dl	1.32	public long toMinutes(long duration) {
260			throw new AbstractMethodError();
261			}
262	jsr166	1.29
263	dl	1.27	/**
264	jsr166	1.41	* Equivalent to
265			* {@link #convert(long, TimeUnit) HOURS.convert(duration, this)}.
266	dl	1.27	* @param duration the duration
267			* @return the converted duration,
268	jsr166	1.40	* or {@code Long.MIN_VALUE} if conversion would negatively
269			* overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
270	dl	1.31	* @since 1.6
271	dl	1.27	*/
272	dl	1.32	public long toHours(long duration) {
273			throw new AbstractMethodError();
274			}
275	jsr166	1.29
276	dl	1.27	/**
277	jsr166	1.41	* Equivalent to
278			* {@link #convert(long, TimeUnit) DAYS.convert(duration, this)}.
279	dl	1.27	* @param duration the duration
280			* @return the converted duration
281	dl	1.31	* @since 1.6
282	dl	1.27	*/
283	dl	1.32	public long toDays(long duration) {
284			throw new AbstractMethodError();
285			}
286	jsr166	1.29
287	dl	1.27	/**
288			* Utility to compute the excess-nanosecond argument to wait,
289			* sleep, join.
290			* @param d the duration
291			* @param m the number of milliseconds
292			* @return the number of nanoseconds
293			*/
294			abstract int excessNanos(long d, long m);
295	jsr166	1.29
296	dl	1.27	/**
297	jsr166	1.37	* Performs a timed {@link Object#wait(long, int) Object.wait}
298			* using this time unit.
299	dl	1.27	* This is a convenience method that converts timeout arguments
300	jsr166	1.40	* into the form required by the {@code Object.wait} method.
301	dl	1.27	*
302	jsr166	1.40	* <p>For example, you could implement a blocking {@code poll}
303	dl	1.27	* method (see {@link BlockingQueue#poll BlockingQueue.poll})
304			* using:
305			*
306	jsr166	1.45	* <pre> {@code
307	jsr166	1.36	* public synchronized Object poll(long timeout, TimeUnit unit)
308			* throws InterruptedException {
309			* while (empty) {
310			* unit.timedWait(this, timeout);
311			* ...
312			* }
313			* }}</pre>
314	dl	1.27	*
315			* @param obj the object to wait on
316	dl	1.28	* @param timeout the maximum time to wait. If less than
317			* or equal to zero, do not wait at all.
318	jsr166	1.37	* @throws InterruptedException if interrupted while waiting
319	dl	1.27	*/
320			public void timedWait(Object obj, long timeout)
321	jsr166	1.37	throws InterruptedException {
322	dl	1.27	if (timeout > 0) {
323			long ms = toMillis(timeout);
324			int ns = excessNanos(timeout, ms);
325			obj.wait(ms, ns);
326			}
327			}
328	jsr166	1.29
329	dl	1.27	/**
330	jsr166	1.37	* Performs a timed {@link Thread#join(long, int) Thread.join}
331			* using this time unit.
332	dl	1.27	* This is a convenience method that converts time arguments into the
333	jsr166	1.40	* form required by the {@code Thread.join} method.
334	jsr166	1.37	*
335	dl	1.27	* @param thread the thread to wait for
336	dl	1.28	* @param timeout the maximum time to wait. If less than
337			* or equal to zero, do not wait at all.
338	jsr166	1.37	* @throws InterruptedException if interrupted while waiting
339	dl	1.27	*/
340			public void timedJoin(Thread thread, long timeout)
341	jsr166	1.37	throws InterruptedException {
342	dl	1.27	if (timeout > 0) {
343			long ms = toMillis(timeout);
344			int ns = excessNanos(timeout, ms);
345			thread.join(ms, ns);
346			}
347			}
348	jsr166	1.29
349	dl	1.27	/**
350	jsr166	1.37	* Performs a {@link Thread#sleep(long, int) Thread.sleep} using
351			* this time unit.
352	dl	1.27	* This is a convenience method that converts time arguments into the
353	jsr166	1.40	* form required by the {@code Thread.sleep} method.
354	jsr166	1.37	*
355	dl	1.28	* @param timeout the minimum time to sleep. If less than
356			* or equal to zero, do not sleep at all.
357	jsr166	1.37	* @throws InterruptedException if interrupted while sleeping
358	dl	1.27	*/
359			public void sleep(long timeout) throws InterruptedException {
360			if (timeout > 0) {
361			long ms = toMillis(timeout);
362			int ns = excessNanos(timeout, ms);
363			Thread.sleep(ms, ns);
364			}
365			}
366	jsr166	1.29
367	jsr166	1.48	/**
368			* Converts this {@code TimeUnit} to the equivalent {@code ChronoUnit}.
369			*
370			* @return the converted equivalent ChronoUnit
371			* @since 9
372			*/
373			public ChronoUnit toChronoUnit() {
374			switch (this) {
375			case NANOSECONDS: return ChronoUnit.NANOS;
376			case MICROSECONDS: return ChronoUnit.MICROS;
377			case MILLISECONDS: return ChronoUnit.MILLIS;
378			case SECONDS: return ChronoUnit.SECONDS;
379			case MINUTES: return ChronoUnit.MINUTES;
380			case HOURS: return ChronoUnit.HOURS;
381			case DAYS: return ChronoUnit.DAYS;
382			default: throw new AssertionError();
383			}
384			}
385
386			/**
387			* Converts a {@code ChronoUnit} to the equivalent {@code TimeUnit}.
388			*
389			* @param chronoUnit the ChronoUnit to convert
390			* @return the converted equivalent TimeUnit
391			* @throws IllegalArgumentException if {@code chronoUnit} has no
392			* equivalent TimeUnit
393			* @throws NullPointerException if {@code chronoUnit} is null
394			* @since 9
395			*/
396			public static TimeUnit of(ChronoUnit chronoUnit) {
397			switch (Objects.requireNonNull(chronoUnit, "chronoUnit")) {
398			case NANOS: return TimeUnit.NANOSECONDS;
399			case MICROS: return TimeUnit.MICROSECONDS;
400			case MILLIS: return TimeUnit.MILLISECONDS;
401			case SECONDS: return TimeUnit.SECONDS;
402			case MINUTES: return TimeUnit.MINUTES;
403			case HOURS: return TimeUnit.HOURS;
404			case DAYS: return TimeUnit.DAYS;
405			default:
406			throw new IllegalArgumentException(
407			"No TimeUnit equivalent for " + chronoUnit);
408			}
409			}
410
411	tim	1.1	}