java.util.concurrent
Enum TimeUnit

public enum 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.
Since1.5
VersionNot specified.
AuthorDoug Lea
Wiki javadoc Use textile entry format.
Add your comments here.
Enum Constant Summary
DAYS
No description provided.
HOURS
No description provided.
MICROSECONDS
No description provided.
MILLISECONDS
No description provided.
MINUTES
No description provided.
NANOSECONDS
No description provided.
SECONDS
No description provided.
Method Summary
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 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 )
No description provided.
static TimeUnit[] values()
No description provided.
DAYS
DAYS
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
HOURS
HOURS
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
MICROSECONDS
MICROSECONDS
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
MILLISECONDS
MILLISECONDS
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
MINUTES
MINUTES
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
NANOSECONDS
NANOSECONDS
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
SECONDS
SECONDS
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
convert
public long convert ( long sourceDuration, TimeUnit sourceUnit )
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
TypeNameDescription
long sourceDuration the time duration in the given sourceUnit
TimeUnit sourceUnit the unit of the sourceDuration argument
Wiki javadoc Use textile entry format.
Add your comments here.
sleep
public void sleep ( long timeout )
Performs a Thread.sleep using this unit. This is a convenience method that converts time arguments into the form required by the Thread.sleep method.
Parameters
TypeNameDescription
long timeout the minimum time to sleep. If less than or equal to zero, do not sleep at all.
Returns void No description provided.
Exceptions
InterruptedException if interrupted while sleeping.
See also
Wiki javadoc Use textile entry format.
Add your comments here.
timedJoin
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
TypeNameDescription
Thread thread the thread to wait for
long timeout the maximum time to wait. If less than or equal to zero, do not wait at all.
Returns void No description provided.
Exceptions
InterruptedException if interrupted while waiting.
See also
Wiki javadoc Use textile entry format.
Add your comments here.
timedWait
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 synchronized Object poll(long timeout, TimeUnit unit) throws InterruptedException {
    while (empty) {
      unit.timedWait(this, timeout);
      ...
    }
  }
Parameters
TypeNameDescription
Object obj the object to wait on
long timeout the maximum time to wait. If less than or equal to zero, do not wait at all.
Returns void No description provided.
Exceptions
InterruptedException if interrupted while waiting.
See also
Wiki javadoc Use textile entry format.
Add your comments here.
toDays
public long toDays ( long duration )
Equivalent to DAYS.convert(duration, this).
Since: 1.6
Parameters
TypeNameDescription
long duration the duration
Wiki javadoc Use textile entry format.
Add your comments here.
toHours
public long toHours ( long duration )
Equivalent to HOURS.convert(duration, this).
Since: 1.6
Parameters
TypeNameDescription
long duration the duration
Wiki javadoc Use textile entry format.
Add your comments here.
toMicros
public long toMicros ( long duration )
Equivalent to MICROSECONDS.convert(duration, this).
Parameters
TypeNameDescription
long duration the duration
Wiki javadoc Use textile entry format.
Add your comments here.
toMillis
public long toMillis ( long duration )
Equivalent to MILLISECONDS.convert(duration, this).
Parameters
TypeNameDescription
long duration the duration
Wiki javadoc Use textile entry format.
Add your comments here.
toMinutes
public long toMinutes ( long duration )
Equivalent to MINUTES.convert(duration, this).
Since: 1.6
Parameters
TypeNameDescription
long duration the duration
Wiki javadoc Use textile entry format.
Add your comments here.
toNanos
public long toNanos ( long duration )
Equivalent to NANOSECONDS.convert(duration, this).
Parameters
TypeNameDescription
long duration the duration
Wiki javadoc Use textile entry format.
Add your comments here.
toSeconds
public long toSeconds ( long duration )
Equivalent to SECONDS.convert(duration, this).
Parameters
TypeNameDescription
long duration the duration
Wiki javadoc Use textile entry format.
Add your comments here.
valueOf
public static TimeUnit valueOf ( String name )
No description provided.
Parameters
TypeNameDescription
String name No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
values
public static TimeUnit[] values ( )
No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.