public enum

TimeUnit

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ java.util.concurrent.TimeUnit

Class Overview

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

Public Methods
long convert(long sourceDuration, TimeUnit sourceUnit)
Convert the given time duration in the given unit to this unit.
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.
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)
final static TimeUnit[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Public Methods

public long convert (long sourceDuration, TimeUnit sourceUnit)

Since: API Level 1

Convert 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 the time duration in the given sourceUnit
sourceUnit the unit of the sourceDuration argument
Returns
  • the converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

public void sleep (long timeout)

Since: API Level 1

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 the minimum time to sleep. If less than or equal to zero, do not sleep at all.
Throws
InterruptedException if interrupted while sleeping

public void timedJoin (Thread thread, long timeout)

Since: API Level 1

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

public void timedWait (Object obj, long timeout)

Since: API Level 1

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 synchronized Object poll(long timeout, TimeUnit unit)
     throws InterruptedException {
   while (empty) {
     unit.timedWait(this, 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

public long toDays (long duration)

Since: API Level 9

Equivalent to DAYS.convert(duration, this).

Parameters
duration the duration
Returns
  • the converted duration
See Also

public long toHours (long duration)

Since: API Level 9

Equivalent to HOURS.convert(duration, this).

Parameters
duration the duration
Returns
  • the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
See Also

public long toMicros (long duration)

Since: API Level 1

Equivalent to MICROSECONDS.convert(duration, this).

Parameters
duration the duration
Returns
  • the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
See Also

public long toMillis (long duration)

Since: API Level 1

Equivalent to MILLISECONDS.convert(duration, this).

Parameters
duration the duration
Returns
  • the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
See Also

public long toMinutes (long duration)

Since: API Level 9

Equivalent to MINUTES.convert(duration, this).

Parameters
duration the duration
Returns
  • the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
See Also

public long toNanos (long duration)

Since: API Level 1

Equivalent to NANOSECONDS.convert(duration, this).

Parameters
duration the duration
Returns
  • the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
See Also

public long toSeconds (long duration)

Since: API Level 1

Equivalent to SECONDS.convert(duration, this).

Parameters
duration the duration
Returns
  • the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
See Also

public static TimeUnit valueOf (String name)

Since: API Level 1

public static final TimeUnit[] values ()

Since: API Level 1