- java.lang.Object
-
- java.lang.Enum<TimeUnit>
-
- java.util.concurrent.TimeUnit
-
- All Implemented Interfaces:
Serializable,Comparable<TimeUnit>
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
-
-
Enum Constant Summary
Enum 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 Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier 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
-
NANOSECONDS
public static final TimeUnit NANOSECONDS
Time unit representing one thousandth of a microsecond.
-
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.
-
SECONDS
public static final TimeUnit SECONDS
Time unit representing one second.
-
MINUTES
public static final TimeUnit MINUTES
Time unit representing sixty seconds.- Since:
- 1.6
-
HOURS
public static final TimeUnit HOURS
Time unit representing sixty minutes.- Since:
- 1.6
-
DAYS
public static final TimeUnit DAYS
Time unit representing twenty four hours.- Since:
- 1.6
-
-
Method Detail
-
values
public static TimeUnit[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TimeUnit c : TimeUnit.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public 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 nameNullPointerException- if the argument is null
-
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, 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 givensourceUnitsourceUnit- the unit of thesourceDurationargument- Returns:
- the converted duration in this unit,
or
Long.MIN_VALUEif conversion would negatively overflow, orLong.MAX_VALUEif 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 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- ifdurationis null- Since:
- 11
- See Also:
Duration.of(long,TemporalUnit)
-
toNanos
public 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.
-
toMicros
public 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.
-
toMillis
public 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.
-
toSeconds
public 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.
-
toMinutes
public 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
-
toHours
public 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
-
toDays
public long toDays(long duration)
Equivalent toDAYS.convert(duration, this).- Parameters:
duration- the duration- Returns:
- the converted duration
- Since:
- 1.6
-
timedWait
public 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 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
public 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 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
public 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
-
toChronoUnit
public ChronoUnit toChronoUnit()
Converts thisTimeUnitto the equivalentChronoUnit.- Returns:
- the converted equivalent ChronoUnit
- Since:
- 9
-
of
public static TimeUnit of(ChronoUnit chronoUnit)
Converts aChronoUnitto the equivalentTimeUnit.- Parameters:
chronoUnit- the ChronoUnit to convert- Returns:
- the converted equivalent TimeUnit
- Throws:
IllegalArgumentException- ifchronoUnithas no equivalent TimeUnitNullPointerException- ifchronoUnitis null- Since:
- 9
-
-