public abstract class TimeUnit
extends java.lang.Object
implements java.io.Serializable
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.
Modifier and Type | Field and Description |
---|---|
static TimeUnit |
DAYS |
static TimeUnit |
HOURS |
static TimeUnit |
MICROSECONDS |
static TimeUnit |
MILLISECONDS |
static TimeUnit |
MINUTES |
static TimeUnit |
NANOSECONDS |
static TimeUnit |
SECONDS |
Modifier and Type | Method and Description |
---|---|
abstract long |
convert(long sourceDuration,
TimeUnit sourceUnit)
Convert the given time duration in the given unit to this
unit.
|
java.lang.String |
name()
Returns the name of this enum constant, exactly as declared in its enum
declaration.
|
int |
ordinal()
Returns the ordinal of this enumeration constant (its position in its
enum declaration, where the initial constant is assigned an ordinal of
zero).
|
protected java.lang.Object |
readResolve() |
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 |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static TimeUnit[] |
values() |
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
public static TimeUnit[] values()
public static TimeUnit valueOf(java.lang.String name)
name
- the name of the enum constant to be returnedjava.lang.IllegalArgumentException
- if this enum type has no constant with the specified namepublic 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 argumentpublic abstract long toNanos(long duration)
duration
- the durationconvert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toMicros(long duration)
duration
- the durationconvert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toMillis(long duration)
duration
- the durationconvert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toSeconds(long duration)
duration
- the durationconvert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toMinutes(long duration)
duration
- the durationconvert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toHours(long duration)
duration
- the durationconvert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public abstract long toDays(long duration)
duration
- the durationconvert(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)
public java.lang.String name()
toString()
method in preference to this one, as the toString
method may return a more user-friendly name. This method is
designed primarily for use in specialized situations where correctness
depends on getting the exact name, which will not vary from release to
release.public int ordinal()
EnumSet
and EnumMap
.protected java.lang.Object readResolve() throws java.io.ObjectStreamException
java.io.ObjectStreamException
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.java.lang.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.java.lang.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.java.lang.InterruptedException
- if interrupted while sleeping.Thread.sleep(long)
public java.lang.String toString()
toString
in class java.lang.Object