java.lang.Object 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. TimeUnit is a "featherweight" class. It does not maintain time information, but only helps organize and use time representations that may be maintained separately across various contexts.
This class cannot be directly instantiated. Use the SECONDS
, MILLISECONDS
, MICROSECONDS
, and NANOSECONDS
static instances that provide predefined units of
precision. If you use these frequently, consider statically
importing this class.
A TimeUnit is mainly used to inform blocking methods which
can timeout, how the timeout 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.
Field Summary | |
---|---|
static TimeUnit |
MICROSECONDS
Unit for one-microsecond granularities. |
static TimeUnit |
MILLISECONDS
Unit for one-millisecond granularities. |
static TimeUnit |
NANOSECONDS
Unit for one-nanosecond granularities. |
static TimeUnit |
SECONDS
Unit for one-second granularities. |
Method Summary | |
---|---|
long |
convert(long duration,
TimeUnit unit)
Convert the given time duration in the given unit to this unit. |
void |
sleep(long timeout)
Perform a Thread.sleep using this unit. |
void |
timedJoin(Thread thread,
long timeout)
Perform a timed Thread.join using this time unit. |
void |
timedWait(Object obj,
long timeout)
Perform a timed Object.wait using this time unit. |
long |
toMicros(long duration)
Equivalent to MICROSECONDS.convert(duration, this). |
long |
toMillis(long duration)
Equivalent to MILLISECONDS.convert(duration, this). |
long |
toNanos(long duration)
Equivalent to NANOSECONDS.convert(duration, this). |
long |
toSeconds(long duration)
Equivalent to SECONDS.convert(duration, this). |
String |
toString()
Return the common name for this unit. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final TimeUnit SECONDS
public static final TimeUnit MILLISECONDS
public static final TimeUnit MICROSECONDS
public static final TimeUnit NANOSECONDS
Method Detail |
---|
public long convert(long duration, TimeUnit unit)
duration
- the time duration in the given unitunit
- the unit of the duration argument
public long toNanos(long duration)
duration
- the duration
convert(long, java.util.concurrent.TimeUnit)
public long toMicros(long duration)
duration
- the duration
convert(long, java.util.concurrent.TimeUnit)
public long toMillis(long duration)
duration
- the duration
convert(long, java.util.concurrent.TimeUnit)
public long toSeconds(long duration)
duration
- the duration
convert(long, java.util.concurrent.TimeUnit)
public void timedWait(Object obj, long timeout) throws InterruptedException
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); ... } }
obj
- the object to wait ontimeout
- the maximum time to wait.
InterruptedException
- if interrupted while waiting.Object.wait(long, int)
public void timedJoin(Thread thread, long timeout) throws InterruptedException
thread
- the thread to wait fortimeout
- the maximum time to wait
InterruptedException
- if interrupted while waiting.Thread.join(long, int)
public void sleep(long timeout) throws InterruptedException
timeout
- the minimum time to sleep
InterruptedException
- if interrupted while sleeping.Thread.sleep(long)
public String toString()
toString
in class Object