Most visited

Recently visited

Results for

Summary: Enums | Methods | Inherited Methods

TimeUnit

public final enum TimeUnit
extends Enum<TimeUnit>

java.lang.Object
↳	java.lang.Enum<java.util.concurrent.TimeUnit>
	↳	java.util.concurrent.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.

Summary

Enum values
`TimeUnit`	`DAYS` Time unit representing twenty four hours.
`TimeUnit`	`HOURS` Time unit representing sixty minutes.
`TimeUnit`	`MICROSECONDS` Time unit representing one thousandth of a millisecond.
`TimeUnit`	`MILLISECONDS` Time unit representing one thousandth of a second.
`TimeUnit`	`MINUTES` Time unit representing sixty seconds.
`TimeUnit`	`NANOSECONDS` Time unit representing one thousandth of a microsecond.
`TimeUnit`	`SECONDS` Time unit representing one second.

Public methods
`long`	`convert(long sourceDuration, TimeUnit sourceUnit)` Converts 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)`
`static final TimeUnit[]`	`values()`

Inherited methods

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(TimeUnit o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`final Class<TimeUnit>`	`getDeclaringClass()` Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()` Returns a hash code for this enum constant.
`final String`	`name()` Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()` Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumType, String name)` Returns the enum constant of the specified enum type with the specified name.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          java.lang.Comparable


      compareTo(TimeUnit o)

Compares this object with the specified object for order.

Enum values

DAYS

public static final TimeUnit DAYS

Time unit representing twenty four hours.

HOURS

public static final TimeUnit HOURS

Time unit representing sixty minutes.

MICROSECONDS

public static final TimeUnit MICROSECONDS

Time unit representing one thousandth of a millisecond.

MILLISECONDS

public static final TimeUnit MILLISECONDS

Time unit representing one thousandth of a second.

MINUTES

public static final TimeUnit MINUTES

Time unit representing sixty seconds.

NANOSECONDS

public static final TimeUnit NANOSECONDS

Time unit representing one thousandth of a microsecond.

SECONDS

public static final TimeUnit SECONDS

Time unit representing one second.

Public methods

convert

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.

sleep

public void sleep (long timeout)

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.

Throws
`InterruptedException`	if interrupted while sleeping

timedJoin

public void timedJoin (Thread thread, 
                long timeout)

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.

Throws
`InterruptedException`	if interrupted while waiting

timedWait

public void timedWait (Object obj, 
                long timeout)

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 synchronized Object poll(long timeout, TimeUnit unit)
     throws InterruptedException {
   while (empty) {
     unit.timedWait(this, 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.

Throws
`InterruptedException`	if interrupted while waiting

toDays

public long toDays (long duration)

Equivalent to DAYS.convert(duration, this).

Parameters
`duration`	`long`: the duration

Returns
`long`	the converted duration

toHours

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.

toMicros

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

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

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.

toNanos

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

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

public static TimeUnit valueOf (String name)

Parameters
`name`	`String`

Returns
`TimeUnit`

values

public static final TimeUnit[] values ()

Returns
`TimeUnit[]`

Interfaces

Classes

Enums

Exceptions

Most visited

Recently visited

Results for

TimeUnit

Summary

Enum values

Public methods

Inherited methods

Enum values

DAYS

HOURS

MICROSECONDS

MILLISECONDS

MINUTES

NANOSECONDS

SECONDS

Public methods

convert

sleep

timedJoin

timedWait

toDays

toHours

toMicros

toMillis

toMinutes

toNanos

toSeconds

valueOf

values