Serializable
, Comparable<TimeUnit>
public enum TimeUnit extends Enum<TimeUnit>
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
.Enum Constant | Description |
---|---|
DAYS |
Time unit representing twenty four hours.
|
HOURS |
Time unit representing sixty minutes.
|
MICROSECONDS |
Time unit representing one thousandth of a millisecond.
|
MILLISECONDS |
Time unit representing one thousandth of a second.
|
MINUTES |
Time unit representing sixty seconds.
|
NANOSECONDS |
Time unit representing one thousandth of a microsecond.
|
SECONDS |
Time unit representing one second.
|
Modifier and Type | Method | Description |
---|---|---|
long |
convert(long sourceDuration,
TimeUnit sourceUnit) |
Converts the given time duration in the given unit to this unit.
|
static TimeUnit |
of(ChronoUnit chronoUnit) |
Converts a
ChronoUnit to the equivalent TimeUnit . |
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. |
ChronoUnit |
toChronoUnit() |
Converts this
TimeUnit to the equivalent ChronoUnit . |
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) |
Returns the enum constant of this type with the specified name.
|
static TimeUnit[] |
values() |
Returns an array containing the constants of this enum type, in
the order they are declared.
|
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()
for (TimeUnit c : TimeUnit.values()) System.out.println(c);
public static TimeUnit valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic long convert(long sourceDuration, TimeUnit sourceUnit)
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)
sourceDuration
- the time duration in the given sourceUnit
sourceUnit
- the unit of the sourceDuration
argumentLong.MIN_VALUE
if conversion would negatively overflow,
or Long.MAX_VALUE
if it would positively overflow.public long toNanos(long duration)
NANOSECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow,
or Long.MAX_VALUE
if it would positively overflow.public long toMicros(long duration)
MICROSECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow,
or Long.MAX_VALUE
if it would positively overflow.public long toMillis(long duration)
MILLISECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow,
or Long.MAX_VALUE
if it would positively overflow.public long toSeconds(long duration)
SECONDS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow,
or Long.MAX_VALUE
if it would positively overflow.public long toMinutes(long duration)
MINUTES.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow,
or Long.MAX_VALUE
if it would positively overflow.public long toHours(long duration)
HOURS.convert(duration, this)
.duration
- the durationLong.MIN_VALUE
if conversion would negatively overflow,
or Long.MAX_VALUE
if it would positively overflow.public long toDays(long duration)
DAYS.convert(duration, this)
.duration
- the durationpublic void timedWait(Object obj, long timeout) throws InterruptedException
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);
...
}
}
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 waitingpublic void timedJoin(Thread thread, long timeout) throws InterruptedException
Thread.join
using this time unit.
This is a convenience method that converts time arguments into the
form required by the Thread.join
method.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 waitingpublic void sleep(long timeout) throws InterruptedException
Thread.sleep
using
this time unit.
This is a convenience method that converts time arguments into the
form required by the Thread.sleep
method.timeout
- the minimum time to sleep. If less than
or equal to zero, do not sleep at all.InterruptedException
- if interrupted while sleepingpublic ChronoUnit toChronoUnit()
TimeUnit
to the equivalent ChronoUnit
.public static TimeUnit of(ChronoUnit chronoUnit)
ChronoUnit
to the equivalent TimeUnit
.chronoUnit
- the ChronoUnit to convertIllegalArgumentException
- if chronoUnit
has no
equivalent TimeUnitNullPointerException
- if chronoUnit
is null Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps