TimeUnit
public
final
enum
TimeUnit
extends Enum<TimeUnit>
java.lang.Object | ||
↳ | java.lang.Enum<java.util.concurrent.TimeUnit> | |
↳ | 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 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 lock
is not available:
Lock lock = ...;
if (lock.tryLock(50L, TimeUnit.MILLISECONDS)) ...
Lock lock = ...;
if (lock.tryLock(50L, TimeUnit.SECONDS)) ...
TimeUnit
.
Summary
Enum values | |
---|---|
TimeUnit |
DAYS
Time unit representing twenty four hours. |
TimeUnit |
HOURS
Time unit representing sixty minutes. |
TimeUnit |
MICROSECONDS
Time unit representing one thousandth of a millisecond. |
TimeUnit |
MILLISECONDS
Time unit representing one thousandth of a second. |
TimeUnit |
MINUTES
Time unit representing sixty seconds. |
TimeUnit |
NANOSECONDS
Time unit representing one thousandth of a microsecond. |
TimeUnit |
SECONDS
Time unit representing one second. |
Public methods | |
---|---|
long
|
convert(long sourceDuration, TimeUnit sourceUnit)
Converts the given time duration in the given unit to this unit. |
long
|
convert(Duration duration)
Converts the given time duration to this unit. |
static
TimeUnit
|
of(ChronoUnit chronoUnit)
Converts a |
void
|
sleep(long timeout)
Performs a |
void
|
timedJoin(Thread thread, long timeout)
Performs a timed |
void
|
timedWait(Object obj, long timeout)
Performs a timed |
ChronoUnit
|
toChronoUnit()
Converts this |
long
|
toDays(long duration)
Equivalent to
|
long
|
toHours(long duration)
Equivalent to
|
long
|
toMicros(long duration)
Equivalent to
|
long
|
toMillis(long duration)
Equivalent to
|
long
|
toMinutes(long duration)
Equivalent to
|
long
|
toNanos(long duration)
Equivalent to
|
long
|
toSeconds(long duration)
Equivalent to
|
static
TimeUnit
|
valueOf(String name)
|
static
final
TimeUnit[]
|
values()
|
Inherited methods | |
---|---|
Enum values
DAYS
public static final TimeUnit DAYS
Time unit representing twenty four hours.
MICROSECONDS
public static final TimeUnit MICROSECONDS
Time unit representing one thousandth of a millisecond.
MILLISECONDS
public static final TimeUnit MILLISECONDS
Time unit representing one thousandth of a second.
MINUTES
public static final TimeUnit MINUTES
Time unit representing sixty seconds.
NANOSECONDS
public static final TimeUnit NANOSECONDS
Time unit representing one thousandth of a microsecond.
SECONDS
public static final TimeUnit SECONDS
Time unit representing one second.
Public methods
convert
public long convert (long sourceDuration, TimeUnit sourceUnit)
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 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 |
long : the time duration in the given sourceUnit |
sourceUnit |
TimeUnit : the unit of the sourceDuration argument |
Returns | |
---|---|
long |
the converted duration in this unit,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
convert
public long convert (Duration duration)
Converts the given time duration to this unit.
For any TimeUnit unit
,
unit.convert(Duration.ofNanos(n))
is equivalent to
unit.convert(n, NANOSECONDS)
, and
unit.convert(Duration.of(n, unit.toChronoUnit()))
is equivalent to n
(in the absence of overflow).
API Note:
- This method differs from
Duration#toNanos()
in that it does not throwArithmeticException
on numeric overflow.
Parameters | |
---|---|
duration |
Duration : the time duration |
Returns | |
---|---|
long |
the converted duration in this unit,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
Throws | |
---|---|
NullPointerException |
if duration is null |
See also:
of
public static TimeUnit of (ChronoUnit chronoUnit)
Converts a ChronoUnit
to the equivalent TimeUnit
.
Parameters | |
---|---|
chronoUnit |
ChronoUnit : the ChronoUnit to convert |
Returns | |
---|---|
TimeUnit |
the converted equivalent TimeUnit |
Throws | |
---|---|
IllegalArgumentException |
if chronoUnit has no
equivalent TimeUnit |
NullPointerException |
if chronoUnit is null |
sleep
public void sleep (long timeout)
Performs a Thread.sleep
using
this time unit.
This is a convenience method that converts time arguments into the
form required by the Thread.sleep
method.
Parameters | |
---|---|
timeout |
long : the minimum time to sleep. If less than
or equal to zero, do not sleep at all. |
Throws | |
---|---|
InterruptedException |
if interrupted while sleeping |
timedJoin
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 |
Thread : the thread to wait for |
timeout |
long : the maximum time to wait. If less than
or equal to zero, do not wait at all. |
Throws | |
---|---|
InterruptedException |
if interrupted while waiting |
timedWait
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
)
using:
public E poll(long timeout, TimeUnit unit)
throws InterruptedException {
synchronized (lock) {
while (isEmpty()) {
unit.timedWait(lock, timeout);
...
}
}
}
Parameters | |
---|---|
obj |
Object : the object to wait on |
timeout |
long : the maximum time to wait. If less than
or equal to zero, do not wait at all. |
Throws | |
---|---|
InterruptedException |
if interrupted while waiting |
toChronoUnit
public ChronoUnit toChronoUnit ()
Converts this TimeUnit
to the equivalent ChronoUnit
.
Returns | |
---|---|
ChronoUnit |
the converted equivalent ChronoUnit |
toDays
public long toDays (long duration)
Equivalent to
DAYS.convert(duration, this)
.
Parameters | |
---|---|
duration |
long : the duration |
Returns | |
---|---|
long |
the converted duration |
toHours
public long toHours (long duration)
Equivalent to
HOURS.convert(duration, this)
.
Parameters | |
---|---|
duration |
long : the duration |
Returns | |
---|---|
long |
the converted duration,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
toMicros
public long toMicros (long duration)
Equivalent to
MICROSECONDS.convert(duration, this)
.
Parameters | |
---|---|
duration |
long : the duration |
Returns | |
---|---|
long |
the converted duration,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
toMillis
public long toMillis (long duration)
Equivalent to
MILLISECONDS.convert(duration, this)
.
Parameters | |
---|---|
duration |
long : the duration |
Returns | |
---|---|
long |
the converted duration,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
toMinutes
public long toMinutes (long duration)
Equivalent to
MINUTES.convert(duration, this)
.
Parameters | |
---|---|
duration |
long : the duration |
Returns | |
---|---|
long |
the converted duration,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
toNanos
public long toNanos (long duration)
Equivalent to
NANOSECONDS.convert(duration, this)
.
Parameters | |
---|---|
duration |
long : the duration |
Returns | |
---|---|
long |
the converted duration,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
toSeconds
public long toSeconds (long duration)
Equivalent to
SECONDS.convert(duration, this)
.
Parameters | |
---|---|
duration |
long : the duration |
Returns | |
---|---|
long |
the converted duration,
or Long.MIN_VALUE if conversion would negatively overflow,
or Long.MAX_VALUE if it would positively overflow. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-02-16 UTC.