OpenJDK 1.23 · java.util.concurrent.TimeUnit · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final long	DAY_SCALE
public static final TimeUnit	DAYS Time unit representing twenty four hours.
private static final long	HOUR_SCALE
public static final TimeUnit	HOURS Time unit representing sixty minutes.
private final long	maxMicros
private final long	maxMillis
private final long	maxNanos
private final long	maxSecs
private static final long	MICRO_SCALE
private final long	microRatio
public static final TimeUnit	MICROSECONDS Time unit representing one thousandth of a millisecond.
private static final long	MILLI_SCALE
private final int	milliRatio
public static final TimeUnit	MILLISECONDS Time unit representing one thousandth of a second.
private static final long	MINUTE_SCALE
public static final TimeUnit	MINUTES Time unit representing sixty seconds.
private static final long	NANO_SCALE
public static final TimeUnit	NANOSECONDS Time unit representing one thousandth of a microsecond.
private final long	scale
private static final long	SECOND_SCALE
public static final TimeUnit	SECONDS Time unit representing one second.
private final int	secRatio

Access	Constructor and Description
private	TimeUnit(long s)

Method Summary

Modifier and Type	Method and Description
public long	Returns: the converted duration in this unit, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. convert(long the time duration in the given `sourceUnit` sourceDuration, TimeUnit the unit of the `sourceDuration` argument sourceUnit) Converts the given time duration in the given unit to this unit.
public long	Returns: the converted duration in this unit, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. convert(Duration the time duration duration) Converts the given time duration to this unit.
private static long	cvt(long duration d, long result unit scale dst, long source unit scale src) General conversion utility.
private int	Returns: the number of nanoseconds excessNanos(long the duration d, long the number of milliseconds m) Utility to compute the excess-nanosecond argument to wait, sleep, join.
public static TimeUnit	Returns: the converted equivalent TimeUnit of(ChronoUnit the ChronoUnit to convert chronoUnit) Converts a `ChronoUnit` to the equivalent `TimeUnit`.
public void	sleep(long the minimum time to sleep. If less than or equal to zero, do not sleep at all. timeout) Performs a `Thread.sleep` using this time unit.
public void	timedJoin(Thread the thread to wait for thread, long the maximum time to wait. If less than or equal to zero, do not wait at all. timeout) Performs a timed `Thread.join` using this time unit.
public void	timedWait(Object the object to wait on obj, long the maximum time to wait. If less than or equal to zero, do not wait at all. timeout) Performs a timed `Object.wait` using this time unit.
public ChronoUnit	Returns: the converted equivalent ChronoUnit toChronoUnit() Converts this `TimeUnit` to the equivalent `ChronoUnit`.
public long	Returns: the converted duration toDays(long the duration duration) Equivalent to `DAYS.convert(duration, this)`.
public long	Returns: the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. toHours(long the duration duration) Equivalent to `HOURS.convert(duration, this)`.
public long	Returns: the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. toMicros(long the duration duration) Equivalent to `MICROSECONDS.convert(duration, this)`.
public long	Returns: the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. toMillis(long the duration duration) Equivalent to `MILLISECONDS.convert(duration, this)`.
public long	Returns: the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. toMinutes(long the duration duration) Equivalent to `MINUTES.convert(duration, this)`.
public long	Returns: the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. toNanos(long the duration duration) Equivalent to `NANOSECONDS.convert(duration, this)`.
public long	Returns: the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. toSeconds(long the duration duration) Equivalent to `SECONDS.convert(duration, this)`.
public static TimeUnit	valueOf(String name)
public static TimeUnit[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

DAY_SCALE	back to summary
private static final long DAY_SCALE

DAYS	back to summary
public static final TimeUnit DAYS Time unit representing twenty four hours. Since 1.6

HOUR_SCALE	back to summary
private static final long HOUR_SCALE

HOURS	back to summary
public static final TimeUnit HOURS Time unit representing sixty minutes. Since 1.6

maxMicros	back to summary
private final long maxMicros

maxMillis	back to summary
private final long maxMillis

maxNanos	back to summary
private final long maxNanos

maxSecs	back to summary
private final long maxSecs

MICRO_SCALE	back to summary
private static final long MICRO_SCALE

microRatio	back to summary
private final long microRatio

MICROSECONDS	back to summary
public static final TimeUnit MICROSECONDS Time unit representing one thousandth of a millisecond.

MILLI_SCALE	back to summary
private static final long MILLI_SCALE

milliRatio	back to summary
private final int milliRatio

MILLISECONDS	back to summary
public static final TimeUnit MILLISECONDS Time unit representing one thousandth of a second.

MINUTE_SCALE	back to summary
private static final long MINUTE_SCALE

MINUTES	back to summary
public static final TimeUnit MINUTES Time unit representing sixty seconds. Since 1.6

NANO_SCALE	back to summary
private static final long NANO_SCALE

NANOSECONDS	back to summary
public static final TimeUnit NANOSECONDS Time unit representing one thousandth of a microsecond.

scale	back to summary
private final long scale

SECOND_SCALE	back to summary
private static final long SECOND_SCALE

SECONDS	back to summary
public static final TimeUnit SECONDS Time unit representing one second.

secRatio	back to summary
private final int secRatio

TimeUnit	back to summary
private TimeUnit(long s)

Method Detail

convert back to summary

convert	back to summary
public long convert(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)` Parameters sourceDuration:long the time duration in the given `sourceUnit` sourceUnit:TimeUnit the unit of the `sourceDuration` argument Returns:long the converted duration in this unit, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

public long convert(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)

Parameters

sourceDuration:long: the time duration in the given sourceUnit
sourceUnit:TimeUnit: the unit of the sourceDuration argument

Returns:long

the converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

convert back to summary

convert	back to summary
public long convert(Duration duration) Converts the given time duration to this unit. 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). API Note This method differs from `Duration#toNanos()` in that it does not throw `ArithmeticException` on numeric overflow. Parameters duration:Duration the time duration Returns:long the converted duration in this unit, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. Exceptions NullPointerException: if `duration` is null Since 11 See Also `Duration#of(long, TemporalUnit)`

public long convert(Duration duration)

Converts the given time duration to this unit.

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).

API Note

This method differs from Duration#toNanos() in that it does not throw ArithmeticException on numeric overflow.

Parameters

duration:Duration: the time duration

Returns:long

the converted duration in this unit, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

Exceptions

NullPointerException:: if duration is null

Since

See Also

Duration#of(long, TemporalUnit)

cvt	back to summary
private static long cvt(long d, long dst, long src) General conversion utility. Parameters d:long duration dst:long result unit scale src:long source unit scale

cvt

back to summary

private static long cvt(long d, long dst, long src)

General conversion utility.

Parameters

d:long: duration
dst:long: result unit scale
src:long: source unit scale

excessNanos	back to summary
private int excessNanos(long d, long m) Utility to compute the excess-nanosecond argument to wait, sleep, join. Parameters d:long the duration m:long the number of milliseconds Returns:int the number of nanoseconds

excessNanos

back to summary

private int excessNanos(long d, long m)

Utility to compute the excess-nanosecond argument to wait, sleep, join.

Parameters

d:long: the duration
m:long: the number of milliseconds

Returns:int

the number of nanoseconds

of back to summary

of	back to summary
public static TimeUnit of(ChronoUnit chronoUnit) Converts a `ChronoUnit` to the equivalent `TimeUnit`. Parameters chronoUnit:ChronoUnit the ChronoUnit to convert Returns:TimeUnit the converted equivalent TimeUnit Exceptions IllegalArgumentException: if `chronoUnit` has no equivalent TimeUnit NullPointerException: if `chronoUnit` is null Since 9

public static TimeUnit of(ChronoUnit chronoUnit)

Converts a ChronoUnit to the equivalent TimeUnit.

Parameters

chronoUnit:ChronoUnit: the ChronoUnit to convert

Returns:TimeUnit

the converted equivalent TimeUnit

Exceptions

IllegalArgumentException:: if chronoUnit has no equivalent TimeUnit
NullPointerException:: if chronoUnit is null

Since

sleep back to summary

sleep	back to summary
public void sleep(long timeout) throws InterruptedException 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. Parameters timeout:long the minimum time to sleep. If less than or equal to zero, do not sleep at all. Exceptions InterruptedException: if interrupted while sleeping

public void sleep(long timeout) throws InterruptedException

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.

Parameters

timeout:long: the minimum time to sleep. If less than or equal to zero, do not sleep at all.

Exceptions

InterruptedException:: if interrupted while sleeping

timedJoin back to summary

timedJoin	back to summary
public void timedJoin(Thread thread, long timeout) throws InterruptedException 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. Parameters thread:Thread the thread to wait for timeout:long the maximum time to wait. If less than or equal to zero, do not wait at all. Exceptions InterruptedException: if interrupted while waiting

public void timedJoin(Thread thread, long timeout) throws InterruptedException

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.

Parameters

thread:Thread: the thread to wait for
timeout:long: the maximum time to wait. If less than or equal to zero, do not wait at all.

Exceptions

InterruptedException:: if interrupted while waiting

timedWait back to summary

timedWait	back to summary
public void timedWait(Object obj, long timeout) throws InterruptedException 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); ... } } }` Parameters obj:Object the object to wait on timeout:long the maximum time to wait. If less than or equal to zero, do not wait at all. Exceptions InterruptedException: if interrupted while waiting

public void timedWait(Object obj, long timeout) throws InterruptedException

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);
      ...
    }
  }
}

Parameters

obj:Object: the object to wait on
timeout:long: the maximum time to wait. If less than or equal to zero, do not wait at all.

Exceptions

InterruptedException:: if interrupted while waiting

toChronoUnit back to summary

toChronoUnit	back to summary
public ChronoUnit toChronoUnit() Converts this `TimeUnit` to the equivalent `ChronoUnit`. Returns:ChronoUnit the converted equivalent ChronoUnit Since 9

public ChronoUnit toChronoUnit()

Converts this TimeUnit to the equivalent ChronoUnit.

Returns:ChronoUnit: the converted equivalent ChronoUnit
Since: 9

toDays back to summary

toDays	back to summary
public long toDays(long duration) Equivalent to `DAYS.convert(duration, this)`. Parameters duration:long the duration Returns:long the converted duration Since 1.6

public long toDays(long duration)

Equivalent to DAYS.convert(duration, this).

Parameters

duration:long: the duration

Returns:long

the converted duration

Since

1.6

toHours back to summary

toHours	back to summary
public long toHours(long duration) Equivalent to `HOURS.convert(duration, this)`. Parameters duration:long the duration Returns:long the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. Since 1.6

public long toHours(long duration)

Equivalent to HOURS.convert(duration, this).

Parameters

duration:long: the duration

Returns:long

the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

Since

1.6

toMicros back to summary

toMicros	back to summary
public long toMicros(long duration) Equivalent to `MICROSECONDS.convert(duration, this)`. Parameters duration:long the duration Returns:long the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

public long toMicros(long duration)

Equivalent to MICROSECONDS.convert(duration, this).

Parameters

duration:long: the duration

Returns:long

the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toMillis back to summary

toMillis	back to summary
public long toMillis(long duration) Equivalent to `MILLISECONDS.convert(duration, this)`. Parameters duration:long the duration Returns:long the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

public long toMillis(long duration)

Equivalent to MILLISECONDS.convert(duration, this).

Parameters

duration:long: the duration

Returns:long

the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toMinutes back to summary

toMinutes	back to summary
public long toMinutes(long duration) Equivalent to `MINUTES.convert(duration, this)`. Parameters duration:long the duration Returns:long the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow. Since 1.6

public long toMinutes(long duration)

Equivalent to MINUTES.convert(duration, this).

Parameters

duration:long: the duration

Returns:long

the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

Since

1.6

toNanos back to summary

toNanos	back to summary
public long toNanos(long duration) Equivalent to `NANOSECONDS.convert(duration, this)`. Parameters duration:long the duration Returns:long the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

public long toNanos(long duration)

Equivalent to NANOSECONDS.convert(duration, this).

Parameters

duration:long: the duration

Returns:long

the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

toSeconds back to summary

toSeconds	back to summary
public long toSeconds(long duration) Equivalent to `SECONDS.convert(duration, this)`. Parameters duration:long the duration Returns:long the converted duration, or `Long.MIN_VALUE` if conversion would negatively overflow, or `Long.MAX_VALUE` if it would positively overflow.

public long toSeconds(long duration)

Equivalent to SECONDS.convert(duration, this).

Parameters

duration:long: the duration

Returns:long

the converted duration, or Long.MIN_VALUE if conversion would negatively overflow, or Long.MAX_VALUE if it would positively overflow.

valueOf	back to summary
public static TimeUnit valueOf(String name)

values	back to summary
public static TimeUnit[] values()

public final Enum TimeUnit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail