Added in API level 1

Summary: Enums | Methods | Inherited Methods

TimeUnit

public final enum TimeUnit
extends Enum<TimeUnit>

java.lang.Object
↳	java.lang.Enum<java.util.concurrent.TimeUnit>
	↳	java.util.concurrent.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 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.

Summary

Enum values
`TimeUnit`	`DAYS` Time unit representing twenty four hours.
`TimeUnit`	`HOURS` Time unit representing sixty minutes.
`TimeUnit`	`MICROSECONDS` Time unit representing one thousandth of a millisecond.
`TimeUnit`	`MILLISECONDS` Time unit representing one thousandth of a second.
`TimeUnit`	`MINUTES` Time unit representing sixty seconds.
`TimeUnit`	`NANOSECONDS` Time unit representing one thousandth of a microsecond.
`TimeUnit`	`SECONDS` Time unit representing one second.

Public methods
`long`	`convert(long sourceDuration, TimeUnit sourceUnit)` Converts the given time duration in the given unit to this unit.
`long`	`convert(Duration duration)` Converts the given time duration to this unit.
`static TimeUnit`	`of(ChronoUnit chronoUnit)` Converts a `ChronoUnit` to the equivalent `TimeUnit`.
`void`	`sleep(long timeout)` Performs a `Thread.sleep` using this time unit.
`void`	`timedJoin(Thread thread, long timeout)` Performs a timed `Thread.join` using this time unit.
`void`	`timedWait(Object obj, long timeout)` Performs a timed `Object.wait` using this time unit.
`ChronoUnit`	`toChronoUnit()` Converts this `TimeUnit` to the equivalent `ChronoUnit`.
`long`	`toDays(long duration)` Equivalent to `DAYS.convert(duration, this)`.
`long`	`toHours(long duration)` Equivalent to `HOURS.convert(duration, this)`.
`long`	`toMicros(long duration)` Equivalent to `MICROSECONDS.convert(duration, this)`.
`long`	`toMillis(long duration)` Equivalent to `MILLISECONDS.convert(duration, this)`.
`long`	`toMinutes(long duration)` Equivalent to `MINUTES.convert(duration, this)`.
`long`	`toNanos(long duration)` Equivalent to `NANOSECONDS.convert(duration, this)`.
`long`	`toSeconds(long duration)` Equivalent to `SECONDS.convert(duration, this)`.
`static TimeUnit`	`valueOf(String name)`
`static final TimeUnit[]`	`values()`

Inherited methods

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(TimeUnit o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`final Class<TimeUnit>`	`getDeclaringClass()` Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()` Returns a hash code for this enum constant.
`final String`	`name()` Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()` Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)` Returns the enum constant of the specified enum class with the specified name.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(TimeUnit o)

Compares this object with the specified object for order.

Enum values

DAYS

Added in API level 9

public static final TimeUnit DAYS

Time unit representing twenty four hours.

HOURS

Added in API level 9

public static final TimeUnit HOURS

Time unit representing sixty minutes.

MICROSECONDS

Added in API level 1

public static final TimeUnit MICROSECONDS

Time unit representing one thousandth of a millisecond.

MILLISECONDS

Added in API level 1

public static final TimeUnit MILLISECONDS

Time unit representing one thousandth of a second.

MINUTES

Added in API level 9

public static final TimeUnit MINUTES

Time unit representing sixty seconds.

NANOSECONDS

Added in API level 1

public static final TimeUnit NANOSECONDS

Time unit representing one thousandth of a microsecond.

SECONDS

Added in API level 1

public static final TimeUnit SECONDS

Time unit representing one second.

Public methods

convert

Added in API level 1

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

For example, to convert 10 minutes to milliseconds, use: TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)

Parameters
`sourceDuration`	`long`: the time duration in the given `sourceUnit`
`sourceUnit`	`TimeUnit`: the unit of the `sourceDuration` argument

Returns
`long`	the converted duration in this unit, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

convert

Added in API level 33

public long convert (Duration duration)

Converts the given time duration to this unit.

For any TimeUnit unit, unit.convert(Duration.ofNanos(n)) is equivalent to unit.convert(n, NANOSECONDS), and unit.convert(Duration.of(n, unit.toChronoUnit())) is equivalent to n (in the absence of overflow).

API Note:

This method differs from Duration#toNanos() in that it does not throw ArithmeticException on numeric overflow.

Parameters
`duration`	`Duration`: the time duration

Returns
`long`	the converted duration in this unit, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

Throws
`NullPointerException`	if `duration` is null

See also:

Duration.of(long, TemporalUnit)

of

Added in API level 33

public static TimeUnit of (ChronoUnit chronoUnit)

Converts a ChronoUnit to the equivalent TimeUnit.

Parameters
`chronoUnit`	`ChronoUnit`: the ChronoUnit to convert

Returns
`TimeUnit`	the converted equivalent TimeUnit

Throws
`IllegalArgumentException`	if `chronoUnit` has no equivalent TimeUnit
`NullPointerException`	if `chronoUnit` is null

sleep

Added in API level 1

public void sleep (long timeout)

Performs a Thread.sleep using this time unit. This is a convenience method that converts time arguments into the form required by the Thread.sleep method.

Parameters
`timeout`	`long`: the minimum time to sleep. If less than or equal to zero, do not sleep at all.

Throws
`InterruptedException`	if interrupted while sleeping

timedJoin

Added in API level 1

public void timedJoin (Thread thread, 
                long timeout)

Performs a timed Thread.join using this time unit. This is a convenience method that converts time arguments into the form required by the Thread.join method.

Parameters
`thread`	`Thread`: the thread to wait for
`timeout`	`long`: the maximum time to wait. If less than or equal to zero, do not wait at all.

Throws
`InterruptedException`	if interrupted while waiting

timedWait

Added in API level 1

public void timedWait (Object obj, 
                long timeout)

Performs a timed Object.wait using this time unit. This is a convenience method that converts timeout arguments into the form required by the Object.wait method.

For example, you could implement a blocking poll method (see BlockingQueue.poll) using:

 public E poll(long timeout, TimeUnit unit)
     throws InterruptedException {
   synchronized (lock) {
     while (isEmpty()) {
       unit.timedWait(lock, timeout);
       ...
     }
   }
 }

Parameters
`obj`	`Object`: the object to wait on
`timeout`	`long`: the maximum time to wait. If less than or equal to zero, do not wait at all.

Throws
`InterruptedException`	if interrupted while waiting

toChronoUnit

Added in API level 33

public ChronoUnit toChronoUnit ()

Converts this TimeUnit to the equivalent ChronoUnit.

Returns
`ChronoUnit`	the converted equivalent ChronoUnit

toDays

Added in API level 9

public long toDays (long duration)

Equivalent to DAYS.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration

toHours

Added in API level 9

public long toHours (long duration)

Equivalent to HOURS.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

toMicros

Added in API level 1

public long toMicros (long duration)

Equivalent to MICROSECONDS.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

toMillis

Added in API level 1

public long toMillis (long duration)

Equivalent to MILLISECONDS.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

toMinutes

Added in API level 9

public long toMinutes (long duration)

Equivalent to MINUTES.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

toNanos

Added in API level 1

public long toNanos (long duration)

Equivalent to NANOSECONDS.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

toSeconds

Added in API level 1

public long toSeconds (long duration)

Equivalent to SECONDS.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

valueOf

public static TimeUnit valueOf (String name)

Parameters
`name`	`String`

Returns
`TimeUnit`

values

public static final TimeUnit[] values ()

Returns
`TimeUnit[]`