@Deprecated @RestrictedSince(value="2.80") @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public enum TimeUnit2 extends Enum<TimeUnit2>
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 and Description |
---|
DAYS
Deprecated.
|
HOURS
Deprecated.
|
MICROSECONDS
Deprecated.
|
MILLISECONDS
Deprecated.
|
MINUTES
Deprecated.
|
NANOSECONDS
Deprecated.
|
SECONDS
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
long |
convert(long sourceDuration,
TimeUnit sourceUnit)
Deprecated.
Convert the given time duration in the given unit to this
unit.
|
long |
convert(long sourceDuration,
TimeUnit2 sourceUnit)
Deprecated.
Convert the given time duration in the given unit to this
unit.
|
void |
sleep(long timeout)
Deprecated.
Performs a
Thread.sleep using this unit. |
void |
timedJoin(Thread thread,
long timeout)
Deprecated.
Performs a timed
Thread.join using this time unit. |
void |
timedWait(Object obj,
long timeout)
Deprecated.
Performs a timed
Object.wait using this time unit. |
long |
toDays(long duration)
Deprecated.
Equivalent to
DAYS.convert(duration, this) . |
long |
toHours(long duration)
Deprecated.
Equivalent to
HOURS.convert(duration, this) . |
long |
toMicros(long duration)
Deprecated.
Equivalent to
MICROSECONDS.convert(duration, this) . |
long |
toMillis(long duration)
Deprecated.
Equivalent to
MILLISECONDS.convert(duration, this) . |
long |
toMinutes(long duration)
Deprecated.
Equivalent to
MINUTES.convert(duration, this) . |
long |
toNanos(long duration)
Deprecated.
Equivalent to
NANOSECONDS.convert(duration, this) . |
long |
toSeconds(long duration)
Deprecated.
Equivalent to
SECONDS.convert(duration, this) . |
static TimeUnit2 |
valueOf(String name)
Deprecated.
Returns the enum constant of this type with the specified name.
|
static TimeUnit2[] |
values()
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final TimeUnit2 NANOSECONDS
public static final TimeUnit2 MICROSECONDS
public static final TimeUnit2 MILLISECONDS
public static final TimeUnit2 SECONDS
public static final TimeUnit2 MINUTES
public static final TimeUnit2 HOURS
public static final TimeUnit2 DAYS
public static TimeUnit2[] values()
for (TimeUnit2 c : TimeUnit2.values()) System.out.println(c);
public static TimeUnit2 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, TimeUnit2 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 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.convert(long, hudson.util.TimeUnit2)
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.convert(long, hudson.util.TimeUnit2)
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.convert(long, hudson.util.TimeUnit2)
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.convert(long, hudson.util.TimeUnit2)
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.convert(long, hudson.util.TimeUnit2)
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.convert(long, hudson.util.TimeUnit2)
public long toDays(long duration)
DAYS.convert(duration, this)
.duration
- the durationconvert(long, hudson.util.TimeUnit2)
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 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(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 waiting.Thread.join(long, int)
public void sleep(long timeout) throws InterruptedException
Thread.sleep
using this 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.Thread.sleep(long)
Copyright © 2004–2019. All rights reserved.