public enum TimeUnit extends Enum<TimeUnit>
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 and Description |
---|
DAYS |
HOURS |
MICROSECONDS |
MILLISECONDS |
MINUTES |
NANOSECONDS |
SECONDS |
Modifier and Type | Method and Description |
---|---|
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 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.
|
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 name
NullPointerException
- if the argument is null
public 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 sourceUnit
sourceUnit
- the unit of the sourceDuration 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 long toMinutes(long duration)
duration
- the duration
convert(long, java.util.concurrent.TimeUnit)
public long toHours(long duration)
duration
- the duration
convert(long, java.util.concurrent.TimeUnit)
public long toDays(long duration)
duration
- the duration
convert(long, java.util.concurrent.TimeUnit)
public 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 on
timeout
- the maximum time to wait. If less than or equal to zero, do not wait at all.
InterruptedException
- if interrupted while waiting
public 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 for
timeout
- the maximum time to wait. If less than or equal to zero, do not wait at all.
InterruptedException
- if interrupted while waiting
public 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 sleeping
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, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.