|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.emory.mathcs.backport.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.
Field Summary | |
---|---|
static TimeUnit |
DAYS
|
static TimeUnit |
HOURS
|
static TimeUnit |
MICROSECONDS
|
static TimeUnit |
MILLISECONDS
|
static TimeUnit |
MINUTES
|
static TimeUnit |
NANOSECONDS
|
static TimeUnit |
SECONDS
|
Method Summary | |
---|---|
abstract 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(java.lang.Thread thread,
long timeout)
Performs a timed Thread.join using this time unit. |
void |
timedWait(java.lang.Object obj,
long timeout)
Performs a timed Object.wait using this time unit. |
abstract long |
toDays(long duration)
Equivalent to DAYS.convert(duration, this). |
abstract long |
toHours(long duration)
Equivalent to HOURS.convert(duration, this). |
abstract long |
toMicros(long duration)
Equivalent to MICROSECONDS.convert(duration, this). |
abstract long |
toMillis(long duration)
Equivalent to MILLISECONDS.convert(duration, this). |
abstract long |
toMinutes(long duration)
Equivalent to MINUTES.convert(duration, this). |
abstract long |
toNanos(long duration)
Equivalent to NANOSECONDS.convert(duration, this). |
abstract long |
toSeconds(long duration)
Equivalent to SECONDS.convert(duration, this). |
java.lang.String |
toString()
|
static TimeUnit[] |
values()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final TimeUnit NANOSECONDS
public static final TimeUnit MICROSECONDS
public static final TimeUnit MILLISECONDS
public static final TimeUnit SECONDS
public static final TimeUnit MINUTES
public static final TimeUnit HOURS
public static final TimeUnit DAYS
Method Detail |
public static TimeUnit[] values()
public abstract long convert(long sourceDuration, TimeUnit sourceUnit)
For example, to convert 10 minutes to milliseconds, use: TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
sourceDuration
- the time duration in the given sourceUnitsourceUnit
- the unit of the sourceDuration argument
public abstract long toNanos(long duration)
duration
- the duration
convert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toMicros(long duration)
duration
- the duration
convert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toMillis(long duration)
duration
- the duration
convert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toSeconds(long duration)
duration
- the duration
convert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toMinutes(long duration)
duration
- the duration
convert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toHours(long duration)
duration
- the duration
convert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toDays(long duration)
duration
- the duration
convert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public void timedWait(java.lang.Object obj, long timeout) throws java.lang.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. If less than
or equal to zero, do not wait at all.
InterruptedException
- if interrupted while waiting.Object.wait(long, int)
public void timedJoin(java.lang.Thread thread, long timeout) throws java.lang.InterruptedException
thread
- the thread to wait fortimeout
- the maximum time to wait. If less than
or equal to zero, do not wait at all.
InterruptedException
- if interrupted while waiting.Thread.join(long, int)
public void sleep(long timeout) throws java.lang.InterruptedException
timeout
- the maximum time to sleep. If less than
or equal to zero, do not sleep at all.
InterruptedException
- if interrupted while sleeping.Thread.sleep(long)
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |