Serializable, Comparable<TimeUnit>, Constable
public enum TimeUnit extends 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
.
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.
long convert(long sourceDuration, TimeUnit sourceUnit)
Converts the given time duration in the given unit to this unit.
long convert(Duration duration)
Converts the given time duration 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.
Methods declared in class java.lang.Enumclone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfTime unit representing one thousandth of a microsecond.
Time unit representing one thousandth of a millisecond.
Time unit representing one thousandth of a second.
Time unit representing one second.
Time unit representing sixty seconds.
Time unit representing sixty minutes.
Time unit representing twenty four hours.
Returns an array containing the constants of this enum type, in the order they are declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
name - the name of the enum constant to be returned.
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null
(
long sourceDuration, TimeUnit sourceUnit)Converts 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)
sourceDuration - the time duration in the given sourceUnit
sourceUnit - the unit of the sourceDuration argument
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
(
Duration duration)For any TimeUnit unit, unit.convert(Duration.ofNanos(n)) is equivalent to unit.convert(n, NANOSECONDS), and unit.convert(Duration.of(n, unit.toChronoUnit())) is equivalent to n (in the absence of overflow).
Duration.toNanos() in that it does not throw ArithmeticException on numeric overflow.
duration - the time duration
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
NullPointerException - if duration is null
Duration.of(long,TemporalUnit)
public long toNanos(long duration)
duration - the duration
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
public long toMicros(long duration)
duration - the duration
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
public long toMillis(long duration)
duration - the duration
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
public long toSeconds(long duration)
duration - the duration
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
public long toMinutes(long duration)
duration - the duration
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
public long toHours(long duration)
duration - the duration
Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
public long toDays(long duration)
duration - the duration
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 E poll(long timeout, TimeUnit unit)
throws InterruptedException {
synchronized (lock) {
while (isEmpty()) {
unit.timedWait(lock, timeout);
...
}
}
}
obj - the object to wait on
timeout - the maximum time to wait. If less than or equal to zero, do not wait at all.
InterruptedException - if interrupted while waiting
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.
thread - the thread to wait for
timeout - the maximum time to wait. If less than or equal to zero, do not wait at all.
InterruptedException - if interrupted while waiting
Performs a
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 sleeping
Converts this TimeUnit to the equivalent ChronoUnit.
Converts a ChronoUnit to the equivalent TimeUnit.
chronoUnit - the ChronoUnit to convert
IllegalArgumentException - if chronoUnit has no equivalent TimeUnit
NullPointerException - if chronoUnit is null
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4