- java.lang.Object
- 
- java.lang.Enum<TimeUnit>
- 
- java.util.concurrent.TimeUnit
 
 
- 
- All Implemented Interfaces:
- Serializable,- Comparable<TimeUnit>,- Constable
 
 public enum TimeUnit extends Enum<TimeUnit> ATimeUnitrepresents 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. ATimeUnitdoes 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 TimeUnitis 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 thelockis not available:
 while this code will timeout in 50 seconds:Lock lock = ...; if (lock.tryLock(50L, TimeUnit.MILLISECONDS)) ...
 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 givenLock lock = ...; if (lock.tryLock(50L, TimeUnit.SECONDS)) ...TimeUnit.- Since:
- 1.5
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces declared in class java.lang.EnumEnum.EnumDesc<E extends Enum<E>>
 
- 
 - 
Enum Constant SummaryEnum Constants Enum Constant Description DAYSTime unit representing twenty four hours.HOURSTime unit representing sixty minutes.MICROSECONDSTime unit representing one thousandth of a millisecond.MILLISECONDSTime unit representing one thousandth of a second.MINUTESTime unit representing sixty seconds.NANOSECONDSTime unit representing one thousandth of a microsecond.SECONDSTime unit representing one second.
 - 
Method SummaryModifier and Type Method Description longconvert(long sourceDuration, TimeUnit sourceUnit)Converts the given time duration in the given unit to this unit.longconvert(Duration duration)Converts the given time duration to this unit.static TimeUnitof(ChronoUnit chronoUnit)Converts aChronoUnitto the equivalentTimeUnit.voidsleep(long timeout)Performs aThread.sleepusing this time unit.voidtimedJoin(Thread thread, long timeout)Performs a timedThread.joinusing this time unit.voidtimedWait(Object obj, long timeout)Performs a timedObject.waitusing this time unit.ChronoUnittoChronoUnit()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 TimeUnitvalueOf(String name)Returns the enum constant of this type with the specified name.static TimeUnit[]values()Returns an array containing the constants of this enum type, in the order they are declared.
 
- 
- 
- 
Enum Constant Detail- 
NANOSECONDSpublic static final TimeUnit NANOSECONDS Time unit representing one thousandth of a microsecond.
 - 
MICROSECONDSpublic static final TimeUnit MICROSECONDS Time unit representing one thousandth of a millisecond.
 - 
MILLISECONDSpublic static final TimeUnit MILLISECONDS Time unit representing one thousandth of a second.
 - 
SECONDSpublic static final TimeUnit SECONDS Time unit representing one second.
 - 
MINUTESpublic static final TimeUnit MINUTES Time unit representing sixty seconds.- Since:
- 1.6
 
 - 
HOURSpublic static final TimeUnit HOURS Time unit representing sixty minutes.- Since:
- 1.6
 
 - 
DAYSpublic static final TimeUnit DAYS Time unit representing twenty four hours.- Since:
- 1.6
 
 
- 
 - 
Method Detail- 
valuespublic static TimeUnit[] values() Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static TimeUnit valueOf(String name) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
- NullPointerException- if the argument is null
 
 - 
convertpublic 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, 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.
 
 - 
convertpublic long convert(Duration duration) 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 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:
- Duration.of(long,TemporalUnit)
 
 - 
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
 
 - 
timedWaitpublic void timedWait(Object obj, long timeout) throws InterruptedException Performs 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
 
 - 
timedJoinpublic void timedJoin(Thread thread, long timeout) throws InterruptedException Performs 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
 
 - 
sleeppublic void sleep(long timeout) throws InterruptedExceptionPerforms 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
 
 - 
toChronoUnitpublic ChronoUnit toChronoUnit() Converts thisTimeUnitto the equivalentChronoUnit.- Returns:
- the converted equivalent ChronoUnit
- Since:
- 9
 
 - 
ofpublic static TimeUnit of(ChronoUnit chronoUnit) Converts 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
 
 
- 
 
-