- 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 SummaryNested classes/interfaces declared in class java.lang.EnumEnum.EnumDesc<E extends Enum<E>>
- 
Enum Constant SummaryEnum ConstantsEnum 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 SummaryModifier and TypeMethodDescriptionlongConverts the given time duration in the given unit to this unit.longConverts the given time duration to this unit.static TimeUnitof(ChronoUnit chronoUnit) Converts aChronoUnitto the equivalentTimeUnit.voidsleep(long timeout) Performs aThread.sleepusing this time unit.voidPerforms a timedThread.joinusing this time unit.voidPerforms a timedObject.waitusing this time unit.Converts thisTimeUnitto the equivalentChronoUnit.longtoDays(long duration) Equivalent toDAYS.convert(duration, this).longtoHours(long duration) Equivalent toHOURS.convert(duration, this).longtoMicros(long duration) Equivalent toMICROSECONDS.convert(duration, this).longtoMillis(long duration) Equivalent toMILLISECONDS.convert(duration, this).longtoMinutes(long duration) Equivalent toMINUTES.convert(duration, this).longtoNanos(long duration) Equivalent toNANOSECONDS.convert(duration, this).longtoSeconds(long duration) Equivalent toSECONDS.convert(duration, this).static TimeUnitReturns 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- 
NANOSECONDSTime unit representing one thousandth of a microsecond.
- 
MICROSECONDSTime unit representing one thousandth of a millisecond.
- 
MILLISECONDSTime unit representing one thousandth of a second.
- 
SECONDSTime unit representing one second.
- 
MINUTESTime unit representing sixty seconds.- Since:
- 1.6
 
- 
HOURSTime unit representing sixty minutes.- Since:
- 1.6
 
- 
DAYSTime unit representing twenty four hours.- Since:
- 1.6
 
 
- 
- 
Method Details- 
valuesReturns 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
 
- 
valueOfReturns 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 name
- NullPointerException- if the argument is null
 
- 
convertConverts the given time duration in the given unit to this unit. Conversions from finer to coarser granularities truncate, so lose precision. For example, converting999milliseconds to seconds results in0. Conversions from coarser to finer granularities with arguments that would numerically overflow saturate toLong.MIN_VALUEif negative orLong.MAX_VALUEif 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
- sourceUnit- the unit of the- sourceDurationargument
- Returns:
- the converted duration in this unit,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
 
- 
convertConverts 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 throwArithmeticExceptionon numeric overflow.
- Parameters:
- duration- the time duration
- Returns:
- the converted duration in this unit,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
- Throws:
- NullPointerException- if- durationis null
- Since:
- 11
- See Also:
 
- 
toNanospublic long toNanos(long duration) Equivalent toNANOSECONDS.convert(duration, this).- Parameters:
- duration- the duration
- Returns:
- the converted duration,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
 
- 
toMicrospublic long toMicros(long duration) Equivalent toMICROSECONDS.convert(duration, this).- Parameters:
- duration- the duration
- Returns:
- the converted duration,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
 
- 
toMillispublic long toMillis(long duration) Equivalent toMILLISECONDS.convert(duration, this).- Parameters:
- duration- the duration
- Returns:
- the converted duration,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
 
- 
toSecondspublic long toSeconds(long duration) Equivalent toSECONDS.convert(duration, this).- Parameters:
- duration- the duration
- Returns:
- the converted duration,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
 
- 
toMinutespublic long toMinutes(long duration) Equivalent toMINUTES.convert(duration, this).- Parameters:
- duration- the duration
- Returns:
- the converted duration,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
- Since:
- 1.6
 
- 
toHourspublic long toHours(long duration) Equivalent toHOURS.convert(duration, this).- Parameters:
- duration- the duration
- Returns:
- the converted duration,
 or Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif it would positively overflow.
- Since:
- 1.6
 
- 
toDayspublic long toDays(long duration) Equivalent toDAYS.convert(duration, this).- Parameters:
- duration- the duration
- Returns:
- the converted duration
- Since:
- 1.6
 
- 
timedWaitPerforms a timedObject.waitusing this time unit. This is a convenience method that converts timeout arguments into the form required by theObject.waitmethod.For example, you could implement a blocking pollmethod (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 on
- timeout- the maximum time to wait. If less than or equal to zero, do not wait at all.
- Throws:
- InterruptedException- if interrupted while waiting
 
- 
timedJoinPerforms a timedThread.joinusing this time unit. This is a convenience method that converts time arguments into the form required by theThread.joinmethod.- Parameters:
- thread- the thread to wait for
- timeout- the maximum time to wait. If less than or equal to zero, do not wait at all.
- Throws:
- InterruptedException- if interrupted while waiting
 
- 
sleepPerforms aThread.sleepusing this time unit. This is a convenience method that converts time arguments into the form required by theThread.sleepmethod.- 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
 
- 
toChronoUnitConverts thisTimeUnitto the equivalentChronoUnit.- Returns:
- the converted equivalent ChronoUnit
- Since:
- 9
 
- 
ofConverts aChronoUnitto the equivalentTimeUnit.- Parameters:
- chronoUnit- the ChronoUnit to convert
- Returns:
- the converted equivalent TimeUnit
- Throws:
- IllegalArgumentException- if- chronoUnithas no equivalent TimeUnit
- NullPointerException- if- chronoUnitis null
- Since:
- 9
 
 
-