Enum Class TimeUnit
- All Implemented Interfaces:
Serializable
,Comparable<TimeUnit>
,Constable
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)) ...
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
-
Nested Class Summary
Nested classes/interfaces declared in class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionTime unit representing twenty four hours.Time unit representing sixty minutes.Time unit representing one thousandth of a millisecond.Time unit representing one thousandth of a second.Time unit representing sixty seconds.Time unit representing one thousandth of a microsecond.Time unit representing one second. -
Method Summary
Modifier and TypeMethodDescriptionlong
Converts the given time duration in the given unit to this unit.long
Converts the given time duration to this unit.static TimeUnit
of
(ChronoUnit chronoUnit) Converts aChronoUnit
to the equivalentTimeUnit
.void
sleep
(long timeout) Performs aThread.sleep
using this time unit.void
Performs a timedThread.join
using this time unit.void
Performs a timedObject.wait
using this time unit.Converts thisTimeUnit
to the equivalentChronoUnit
.long
toDays
(long duration) Equivalent toDAYS.convert(duration, this)
.long
toHours
(long duration) Equivalent toHOURS.convert(duration, this)
.long
toMicros
(long duration) Equivalent toMICROSECONDS.convert(duration, this)
.long
toMillis
(long duration) Equivalent toMILLISECONDS.convert(duration, this)
.long
toMinutes
(long duration) Equivalent toMINUTES.convert(duration, this)
.long
toNanos
(long duration) Equivalent toNANOSECONDS.convert(duration, this)
.long
toSeconds
(long duration) Equivalent toSECONDS.convert(duration, this)
.static TimeUnit
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.
-
Enum Constant Details
-
NANOSECONDS
Time unit representing one thousandth of a microsecond. -
MICROSECONDS
Time unit representing one thousandth of a millisecond. -
MILLISECONDS
Time unit representing one thousandth of a second. -
SECONDS
Time unit representing one second. -
MINUTES
-
HOURS
-
DAYS
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
convert
Converts the given time duration in the given unit to this unit. Conversions from finer to coarser granularities truncate, so lose precision. For example, converting999
milliseconds to seconds results in0
. Conversions from coarser to finer granularities with arguments that would numerically overflow saturate toLong.MIN_VALUE
if negative orLong.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 givensourceUnit
sourceUnit
- the unit of thesourceDuration
argument- Returns:
- the converted duration in this unit,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow.
-
convert
Converts the given time duration to this unit.For any TimeUnit
unit
,unit.convert(Duration.ofNanos(n))
is equivalent tounit.convert(n, NANOSECONDS)
, andunit.convert(Duration.of(n, unit.toChronoUnit()))
is equivalent ton
(in the absence of overflow).- API Note:
- This method differs from
Duration.toNanos()
in that it does not throwArithmeticException
on numeric overflow. - Parameters:
duration
- the time duration- Returns:
- the converted duration in this unit,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow. - Throws:
NullPointerException
- ifduration
is null- Since:
- 11
- See Also:
-
toNanos
public long toNanos(long duration) Equivalent toNANOSECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow.
-
toMicros
public long toMicros(long duration) Equivalent toMICROSECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow.
-
toMillis
public long toMillis(long duration) Equivalent toMILLISECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow.
-
toSeconds
public long toSeconds(long duration) Equivalent toSECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow.
-
toMinutes
public long toMinutes(long duration) Equivalent toMINUTES.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow. - Since:
- 1.6
-
toHours
public long toHours(long duration) Equivalent toHOURS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
Long.MIN_VALUE
if conversion would negatively overflow, orLong.MAX_VALUE
if it would positively overflow. - Since:
- 1.6
-
toDays
public long toDays(long duration) Equivalent toDAYS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration
- Since:
- 1.6
-
timedWait
Performs a timedObject.wait
using this time unit. This is a convenience method that converts timeout arguments into the form required by theObject.wait
method.For example, you could implement a blocking
poll
method (seeBlockingQueue.poll
) using:public E poll(long timeout, TimeUnit unit) throws InterruptedException { synchronized (lock) { while (isEmpty()) { unit.timedWait(lock, timeout); ... } } }
- Parameters:
obj
- the object to wait ontimeout
- the maximum time to wait. If less than or equal to zero, do not wait at all.- Throws:
InterruptedException
- if interrupted while waiting
-
timedJoin
Performs a timedThread.join
using this time unit. This is a convenience method that converts time arguments into the form required by theThread.join
method.- Parameters:
thread
- the thread to wait fortimeout
- the maximum time to wait. If less than or equal to zero, do not wait at all.- Throws:
InterruptedException
- if interrupted while waiting
-
sleep
Performs aThread.sleep
using this time unit. This is a convenience method that converts time arguments into the form required by theThread.sleep
method.- Parameters:
timeout
- the minimum time to sleep. If less than or equal to zero, do not sleep at all.- Throws:
InterruptedException
- if interrupted while sleeping
-
toChronoUnit
Converts thisTimeUnit
to the equivalentChronoUnit
.- Returns:
- the converted equivalent ChronoUnit
- Since:
- 9
-
of
Converts aChronoUnit
to the equivalentTimeUnit
.- Parameters:
chronoUnit
- the ChronoUnit to convert- Returns:
- the converted equivalent TimeUnit
- Throws:
IllegalArgumentException
- ifchronoUnit
has no equivalent TimeUnitNullPointerException
- ifchronoUnit
is null- Since:
- 9
-