TimeUnit

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 [ ] 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

Author

Doug Lea

Entries

Link copied to clipboard

Time unit representing one thousandth of a microsecond.

Link copied to clipboard

Time unit representing one thousandth of a millisecond.

Link copied to clipboard

Time unit representing one thousandth of a second.

Link copied to clipboard

Time unit representing one second.

Link copied to clipboard

Time unit representing sixty seconds.

Link copied to clipboard

Time unit representing sixty minutes.

Link copied to clipboard

Time unit representing twenty four hours.

Types

Link copied to clipboard
object Companion

Converts this TimeUnit to the equivalent ChronoUnit.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
expect val name: String
Link copied to clipboard
expect val ordinal: Int

Functions

Link copied to clipboard
fun convert(duration: Duration): Long

Converts the given time duration to this unit.

fun convert(sourceDuration: Long, sourceUnit: TimeUnit): Long

Converts the given time duration in the given unit to this unit. Conversions from finer to coarser granularities truncate, so lose precision. For example, converting 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.

Link copied to clipboard
fun toDays(duration: Long): Long

Equivalent to .convert.

Link copied to clipboard
fun toHours(duration: Long): Long

Equivalent to .convert.

Link copied to clipboard
fun toMicros(duration: Long): Long

Equivalent to .convert.

Link copied to clipboard
fun toMillis(duration: Long): Long

Equivalent to .convert.

Link copied to clipboard
fun toMinutes(duration: Long): Long

Equivalent to .convert.

Link copied to clipboard
fun toNanos(duration: Long): Long

Equivalent to .convert.

Link copied to clipboard
fun toSeconds(duration: Long): Long

Equivalent to .convert.

Link copied to clipboard
fun valueOf(value: String): TimeUnit

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.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.