java.util.concurrent.TimeUnit
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 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 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.
Summary
Enum Values
Public Methods
Methods inherited
from class
java.lang.Enum
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Enum Values
public
static
final
TimeUnit
MICROSECONDS
TimeUnit which represents one microsecond.
public
static
final
TimeUnit
MILLISECONDS
TimeUnit which represents one millisecond.
public
static
final
TimeUnit
NANOSECONDS
TimeUnit which represents one nanosecond.
public
static
final
TimeUnit
SECONDS
TimeUnit which represents one second.
Public Methods
public
long
convert(long duration, TimeUnit unit)
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.
Parameters
duration
| the time duration in the given unit |
unit
| the unit of the duration argument |
Returns
- the converted duration in this unit,
or Long.MIN_VALUE if conversion would negatively
overflow, or Long.MAX_VALUE if it would positively overflow.
public
void
sleep(long timeout)
Perform 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)
Perform 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 |
timeout
| the maximum time to wait |
public
void
timedWait(Object obj, long timeout)
Perform 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)
using:
public synchronized Object poll(long timeout, TimeUnit unit) throws InterruptedException {
while (empty) {
unit.timedWait(this, timeout);
...
}
}
Parameters
obj
| the object to wait on |
timeout
| the maximum time to wait. |
public
long
toMicros(long duration)
Equivalent to
MICROSECONDS.convert(duration, this).
Returns
- the converted duration,
or Long.MIN_VALUE if conversion would negatively
overflow, or Long.MAX_VALUE if it would positively overflow.
public
long
toMillis(long duration)
Equivalent to
MILLISECONDS.convert(duration, this).
Returns
- the converted duration,
or Long.MIN_VALUE if conversion would negatively
overflow, or Long.MAX_VALUE if it would positively overflow.
public
long
toNanos(long duration)
Equivalent to
NANOSECONDS.convert(duration, this).
Returns
- the converted duration,
or Long.MIN_VALUE if conversion would negatively
overflow, or Long.MAX_VALUE if it would positively overflow.
public
long
toSeconds(long duration)
Equivalent to
SECONDS.convert(duration, this).