| java.util.concurrent.TimeUnit
| TimeUnit | | public enum TimeUnit (Code) | | A 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
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.
A 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
java.util.concurrent.locks.Lock lock is not available:
Lock lock = ...;
if ( lock.tryLock(50L, TimeUnit.MILLISECONDS) ) ...
while this code will timeout in 50 seconds:
Lock lock = ...;
if ( lock.tryLock(50L, TimeUnit.SECONDS) ) ...
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 TimeUnit.
since:
1.5
author:
Doug Lea |
| Method Summary | |
| public long | convert(long sourceDuration, TimeUnit sourceUnit)
Convert the given time duration in the given unit to this
unit. | | abstract int | excessNanos(long d, long m)
Utility to compute the excess-nanosecond argument to wait,
sleep, join. | | public void | sleep(long timeout)
Performs a Thread.sleep using this unit.
This is a convenience method that converts time arguments into the
form required by the Thread.sleep method.
Parameters:
timeout - the minimum time to sleep. | | public void | timedJoin(Thread thread, long timeout)
Performs a timed Thread.join using this time unit.
This is a convenience method that converts time arguments into the
form required by the Thread.join method.
Parameters:
thread - the thread to wait for
Parameters:
timeout - the maximum time to wait. | | public void | timedWait(Object obj, long timeout)
Performs a timed Object.wait using this time unit.
This is a convenience method that converts timeout arguments
into the form required by the Object.wait method.
For example, you could implement a blocking poll
method (see
BlockingQueue.poll BlockingQueue.poll )
using:
public synchronized Object poll(long timeout, TimeUnit unit) throws InterruptedException {
while (empty) {
unit.timedWait(this, timeout);
...
}
}
Parameters:
obj - the object to wait on
Parameters:
timeout - the maximum time to wait. | | public long | toDays(long duration)
Equivalent to DAYS.convert(duration, this). | | public long | toHours(long duration)
Equivalent to HOURS.convert(duration, this). | | public long | toMicros(long duration)
Equivalent to MICROSECONDS.convert(duration, this). | | public long | toMillis(long duration)
Equivalent to MILLISECONDS.convert(duration, this). | | public long | toMinutes(long duration)
Equivalent to MINUTES.convert(duration, this). | | public long | toNanos(long duration)
Equivalent to NANOSECONDS.convert(duration, this). | | public long | toSeconds(long duration)
Equivalent to SECONDS.convert(duration, this). | | static long | x(long d, long m, long over)
Scale d by m, checking for overflow. |
| HOURS | | Enum Constant HOURS(Code) | | |
| MAX | | final static long MAX(Code) | | |
| MICROSECONDS | | Enum Constant MICROSECONDS(Code) | | |
| MILLISECONDS | | Enum Constant MILLISECONDS(Code) | | |
| MINUTES | | Enum Constant MINUTES(Code) | | |
| NANOSECONDS | | Enum Constant NANOSECONDS(Code) | | |
| SECONDS | | Enum Constant SECONDS(Code) | | |
| convert | | public long convert(long sourceDuration, TimeUnit sourceUnit)(Code) | | Convert the given time duration in the given unit to this
unit. Conversions from finer to coarser granularities
truncate, so lose precision. For example converting
999 milliseconds to seconds results in
0. Conversions from coarser to finer granularities
with arguments that would numerically overflow saturate to
Long.MIN_VALUE if negative or Long.MAX_VALUE
if positive.
For example, to convert 10 minutes to milliseconds, use:
TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
Parameters:
sourceDuration - the time duration in the given sourceUnit
Parameters:
sourceUnit - the unit of the sourceDuration argument the converted duration in this unit,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow. |
| excessNanos | | abstract int excessNanos(long d, long m)(Code) | | Utility to compute the excess-nanosecond argument to wait,
sleep, join.
Parameters:
d - the duration
Parameters:
m - the number of milliseconds the number of nanoseconds |
| sleep | | public void sleep(long timeout) throws InterruptedException(Code) | | Performs a Thread.sleep using this unit.
This is a convenience method that converts time arguments into the
form required by the Thread.sleep method.
Parameters:
timeout - the minimum time to sleep. If less thanor equal to zero, do not sleep at all.
throws:
InterruptedException - if interrupted while sleeping.
See Also: Thread.sleep |
| timedJoin | | public void timedJoin(Thread thread, long timeout) throws InterruptedException(Code) | | Performs a timed Thread.join using this time unit.
This is a convenience method that converts time arguments into the
form required by the Thread.join method.
Parameters:
thread - the thread to wait for
Parameters:
timeout - the maximum time to wait. If less thanor equal to zero, do not wait at all.
throws:
InterruptedException - if interrupted while waiting.
See Also: Thread.join(longint) |
| timedWait | | public void timedWait(Object obj, long timeout) throws InterruptedException(Code) | | Performs a timed Object.wait using this time unit.
This is a convenience method that converts timeout arguments
into the form required by the Object.wait method.
For example, you could implement a blocking poll
method (see
BlockingQueue.poll BlockingQueue.poll )
using:
public synchronized Object poll(long timeout, TimeUnit unit) throws InterruptedException {
while (empty) {
unit.timedWait(this, timeout);
...
}
}
Parameters:
obj - the object to wait on
Parameters:
timeout - the maximum time to wait. If less thanor equal to zero, do not wait at all.
throws:
InterruptedException - if interrupted while waiting.
See Also: Object.wait(longint) |
| toDays | | public long toDays(long duration)(Code) | | Equivalent to DAYS.convert(duration, this).
Parameters:
duration - the duration the converted duration
See Also: TimeUnit.convert
since:
1.6 |
| toHours | | public long toHours(long duration)(Code) | | Equivalent to HOURS.convert(duration, this).
Parameters:
duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also: TimeUnit.convert
since:
1.6 |
| toMicros | | public long toMicros(long duration)(Code) | | Equivalent to MICROSECONDS.convert(duration, this).
Parameters:
duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also: TimeUnit.convert |
| toMillis | | public long toMillis(long duration)(Code) | | Equivalent to MILLISECONDS.convert(duration, this).
Parameters:
duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also: TimeUnit.convert |
| toMinutes | | public long toMinutes(long duration)(Code) | | Equivalent to MINUTES.convert(duration, this).
Parameters:
duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also: TimeUnit.convert
since:
1.6 |
| toNanos | | public long toNanos(long duration)(Code) | | Equivalent to NANOSECONDS.convert(duration, this).
Parameters:
duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also: TimeUnit.convert |
| toSeconds | | public long toSeconds(long duration)(Code) | | Equivalent to SECONDS.convert(duration, this).
Parameters:
duration - the duration the converted duration,or Long.MIN_VALUE if conversion would negativelyoverflow, or Long.MAX_VALUE if it would positively overflow.
See Also: TimeUnit.convert |
| x | | static long x(long d, long m, long over)(Code) | | Scale d by m, checking for overflow.
This has a short name to make above code more readable.
|
|
|