Skip to content

Most visited

Recently visited

navigation
Added in API level 1

TimeUnit

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

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

Inherited methods

From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum values

DAYS

Added in API level 9
TimeUnit DAYS

Time unit representing twenty four hours

HOURS

Added in API level 9
TimeUnit HOURS

Time unit representing sixty minutes

MICROSECONDS

Added in API level 1
TimeUnit MICROSECONDS

Time unit representing one thousandth of a millisecond

MILLISECONDS

Added in API level 1
TimeUnit MILLISECONDS

Time unit representing one thousandth of a second

MINUTES

Added in API level 9
TimeUnit MINUTES

Time unit representing sixty seconds

NANOSECONDS

Added in API level 1
TimeUnit NANOSECONDS

Time unit representing one thousandth of a microsecond

SECONDS

Added in API level 1
TimeUnit SECONDS

Time unit representing one second

Public methods

convert

Added in API level 1
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.

sleep

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

toDays

Added in API level 9
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
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
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
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
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
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
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

Added in API level 1
TimeUnit valueOf (String name)

Parameters
name String
Returns
TimeUnit

values

Added in API level 1
TimeUnit[] values ()

Returns
TimeUnit[]
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.