Serializable
, Comparable<TimeUnit>
, Constable
public enum TimeUnit extends Enum<TimeUnit>
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)) ...
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
.Enum.EnumDesc<E extends Enum<E>>
Enum Constant | Description |
---|---|
DAYS |
Time unit representing twenty four hours. |
HOURS |
Time unit representing sixty minutes. |
MICROSECONDS |
Time unit representing one thousandth of a millisecond. |
MILLISECONDS |
Time unit representing one thousandth of a second. |
MINUTES |
Time unit representing sixty seconds. |
NANOSECONDS |
Time unit representing one thousandth of a microsecond. |
SECONDS |
Time unit representing one second. |
Modifier and Type | Method | Description |
---|---|---|
long |
convert |
Converts the given time duration in the given unit to this unit. |
long |
convert |
Converts the given time duration to this unit. |
static TimeUnit |
of |
Converts a ChronoUnit to the equivalent TimeUnit . |
void |
sleep |
Performs a Thread.sleep using this time unit. |
void |
timedJoin |
Performs a timed Thread.join using this time unit. |
void |
timedWait |
Performs a timed Object.wait using this time unit. |
ChronoUnit |
toChronoUnit() |
Converts this TimeUnit to the equivalent ChronoUnit . |
long |
toDays |
Equivalent to DAYS.convert(duration, this) . |
long |
toHours |
Equivalent to HOURS.convert(duration, this) . |
long |
toMicros |
Equivalent to MICROSECONDS.convert(duration, this) . |
long |
toMillis |
Equivalent to MILLISECONDS.convert(duration, this) . |
long |
toMinutes |
Equivalent to MINUTES.convert(duration, this) . |
long |
toNanos |
Equivalent to NANOSECONDS.convert(duration, this) . |
long |
toSeconds |
Equivalent to SECONDS.convert(duration, this) . |
static TimeUnit |
valueOf |
Returns the enum constant of this class with the specified name. |
static TimeUnit[] |
values() |
Returns an array containing the constants of this enum class, in the order they are declared. |
public static final TimeUnit NANOSECONDS
public static final TimeUnit MICROSECONDS
public static final TimeUnit MILLISECONDS
public static final TimeUnit SECONDS
public static final TimeUnit MINUTES
public static final TimeUnit HOURS
public static final TimeUnit DAYS
public static TimeUnit[] values()
public static TimeUnit valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is nullpublic long convert(long sourceDuration, TimeUnit sourceUnit)
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)
sourceDuration
- the time duration in the given sourceUnit
sourceUnit
- the unit of the sourceDuration
argumentLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.public long convert(Duration duration)
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).
Duration.toNanos()
in that it does not throw ArithmeticException
on numeric overflow.duration
- the time durationLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.NullPointerException
- if duration
is nullpublic long toNanos(long duration)
NANOSECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.public long toMicros(long duration)
MICROSECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.public long toMillis(long duration)
MILLISECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.public long toSeconds(long duration)
SECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.public long toMinutes(long duration)
MINUTES.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.public long toHours(long duration)
HOURS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow, or Long.MAX_VALUE
if it would positively overflow.public long toDays(long duration)
DAYS.convert(duration, this)
.duration
- the durationpublic void timedWait(Object obj, long timeout) throws InterruptedException
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);
...
}
}
}
obj
- the object to wait ontimeout
- the maximum time to wait. If less than or equal to zero, do not wait at all.InterruptedException
- if interrupted while waitingpublic void timedJoin(Thread thread, long timeout) throws InterruptedException
Thread.join
using this time unit. This is a convenience method that converts time arguments into the form required by the Thread.join
method.thread
- the thread to wait fortimeout
- the maximum time to wait. If less than or equal to zero, do not wait at all.InterruptedException
- if interrupted while waitingpublic void sleep(long timeout) throws InterruptedException
Thread.sleep
using this time unit. This is a convenience method that converts time arguments into the form required by the Thread.sleep
method.timeout
- the minimum time to sleep. If less than or equal to zero, do not sleep at all.InterruptedException
- if interrupted while sleepingpublic ChronoUnit toChronoUnit()
TimeUnit
to the equivalent ChronoUnit
.public static TimeUnit of(ChronoUnit chronoUnit)
ChronoUnit
to the equivalent TimeUnit
.chronoUnit
- the ChronoUnit to convertIllegalArgumentException
- if chronoUnit
has no equivalent TimeUnitNullPointerException
- if chronoUnit
is null
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/TimeUnit.html