Package be.panako.util
Enum Class TimeUnit
- All Implemented Interfaces:
Serializable
,Comparable<TimeUnit>
,Constable
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
java.util.concurrent.locks.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
.- Since:
- 1.5
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptiondouble
Convert the given time duration in the given unit to this unit.double
toDays
(double duration) Equivalent toDAYS.convert(duration, this)
.double
toHours
(double duration) Equivalent toHOURS.convert(duration, this)
.double
toMicros
(double duration) Equivalent toMICROSECONDS.convert(duration, this)
.double
toMillis
(double duration) Equivalent toMILLISECONDS.convert(duration, this)
.double
toMinutes
(double duration) Equivalent toMINUTES.convert(duration, this)
.double
toNanos
(double duration) Equivalent toNANOSECONDS.convert(duration, this)
.double
toSeconds
(double duration) Equivalent toSECONDS.convert(duration, this)
.static TimeUnit
Returns the enum constant of this class with the specified name.static TimeUnit[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NANOSECONDS
-
MICROSECONDS
-
MILLISECONDS
-
SECONDS
-
MINUTES
-
HOURS
-
DAYS
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
convert
Convert the given time duration in the given unit to this unit. Conversions from finer to coarser granularities truncate, so lose precision. For example converting999
milliseconds to seconds results in0
. Conversions from coarser to finer granularities with arguments that would numerically overflow saturate todouble.MIN_VALUE
if negative ordouble.MAX_VALUE
if positive.For example, to convert 10 minutes to milliseconds, use:
TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
- Parameters:
sourceDuration
- the time duration in the givensourceUnit
sourceUnit
- the unit of thesourceDuration
argument- Returns:
- the converted duration in this unit
-
toNanos
public double toNanos(double duration) Equivalent toNANOSECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
double.MIN_VALUE
if conversion would negatively overflow, ordouble.MAX_VALUE
if it would positively overflow. - See Also:
-
toMicros
public double toMicros(double duration) Equivalent toMICROSECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
double.MIN_VALUE
if conversion would negatively overflow, ordouble.MAX_VALUE
if it would positively overflow. - See Also:
-
toMillis
public double toMillis(double duration) Equivalent toMILLISECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
double.MIN_VALUE
if conversion would negatively overflow, ordouble.MAX_VALUE
if it would positively overflow. - See Also:
-
toSeconds
public double toSeconds(double duration) Equivalent toSECONDS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
double.MIN_VALUE
if conversion would negatively overflow, ordouble.MAX_VALUE
if it would positively overflow. - See Also:
-
toMinutes
public double toMinutes(double duration) Equivalent toMINUTES.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
double.MIN_VALUE
if conversion would negatively overflow, ordouble.MAX_VALUE
if it would positively overflow. - Since:
- 1.6
- See Also:
-
toHours
public double toHours(double duration) Equivalent toHOURS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration,
or
double.MIN_VALUE
if conversion would negatively overflow, ordouble.MAX_VALUE
if it would positively overflow. - Since:
- 1.6
- See Also:
-
toDays
public double toDays(double duration) Equivalent toDAYS.convert(duration, this)
.- Parameters:
duration
- the duration- Returns:
- the converted duration
- Since:
- 1.6
- See Also:
-