be.hogent.tarsos.util
Enum TimeUnit

java.lang.Object
  java.lang.Enum<TimeUnit>
      be.hogent.tarsos.util.TimeUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeUnit>

public enum TimeUnit
extends java.lang.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.

Since:

1.5

Author:

Doug Lea

Enum Constant Summary

DAYS

HOURS

MICROSECONDS

MILLISECONDS

MINUTES

NANOSECONDS

SECONDS

Method Summary

double	convert(double sourceDuration, TimeUnit sourceUnit) Convert the given time duration in the given unit to this unit.
double	toDays(double duration) Equivalent to DAYS.convert(duration, this).
double	toHours(double duration) Equivalent to HOURS.convert(duration, this).
double	toMicros(double duration) Equivalent to MICROSECONDS.convert(duration, this).
double	toMillis(double duration) Equivalent to MILLISECONDS.convert(duration, this).
double	toMinutes(double duration) Equivalent to MINUTES.convert(duration, this).
double	toNanos(double duration) Equivalent to NANOSECONDS.convert(duration, this).
double	toSeconds(double duration) Equivalent to SECONDS.convert(duration, this).
static TimeUnit	valueOf(java.lang.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 inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NANOSECONDS

public static final TimeUnit NANOSECONDS

MICROSECONDS

public static final TimeUnit MICROSECONDS

MILLISECONDS

public static final TimeUnit MILLISECONDS

SECONDS

public static final TimeUnit SECONDS

MINUTES

public static final TimeUnit MINUTES

HOURS

public static final TimeUnit HOURS

DAYS

public static final TimeUnit DAYS

Method Detail

values

public static TimeUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimeUnit c : TimeUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimeUnit valueOf(java.lang.String name)

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

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

convert

public double convert(double sourceDuration,
                      TimeUnit sourceUnit)

Convert 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 double.MIN_VALUE if negative or double.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 given sourceUnit

sourceUnit - the unit of the sourceDuration argument

Returns:

the converted duration in this unit

toNanos

public double toNanos(double duration)

Equivalent to NANOSECONDS.convert(duration, this).

Parameters:

duration - the duration

Returns:

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

See Also:

convert(double, be.hogent.tarsos.util.TimeUnit)

toMicros

public double toMicros(double duration)

Equivalent to MICROSECONDS.convert(duration, this).

Parameters:

duration - the duration

Returns:

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

See Also:

convert(double, be.hogent.tarsos.util.TimeUnit)

toMillis

public double toMillis(double duration)

Equivalent to MILLISECONDS.convert(duration, this).

Parameters:

duration - the duration

Returns:

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

See Also:

convert(double, be.hogent.tarsos.util.TimeUnit)

toSeconds

public double toSeconds(double duration)

Equivalent to SECONDS.convert(duration, this).

Parameters:

duration - the duration

Returns:

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

See Also:

convert(double, be.hogent.tarsos.util.TimeUnit)

toMinutes

public double toMinutes(double duration)

Equivalent to MINUTES.convert(duration, this).

Parameters:

duration - the duration

Returns:

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

Since:

1.6

See Also:

convert(double, be.hogent.tarsos.util.TimeUnit)

toHours

public double toHours(double duration)

Equivalent to HOURS.convert(duration, this).

Parameters:

duration - the duration

Returns:

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

Since:

1.6

See Also:

convert(double, be.hogent.tarsos.util.TimeUnit)

toDays

public double toDays(double duration)

Equivalent to DAYS.convert(duration, this).

Parameters:

duration - the duration

Returns:

the converted duration

Since:

1.6

See Also:

convert(double, be.hogent.tarsos.util.TimeUnit)