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
.
Inherited Method Summary
From class
java.lang.Enum
final
Object
|
clone()
Throws CloneNotSupportedException.
|
final
int
|
|
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)
Compares this instance with the specified object and indicates if they
are equal.
|
void
|
finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
final
Class<?>
|
getClass()
Returns the unique instance of Class that represents this
object's class.
|
int
|
hashCode()
Returns an integer hash code for this object.
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
final
void
|
wait(long timeout, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
final
void
|
wait(long timeout)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
Enum Values
public
static
final
TimeUnit
DAYS
Time unit representing twenty four hours.
public
static
final
TimeUnit
HOURS
Time unit representing sixty minutes.
public
static
final
TimeUnit
MICROSECONDS
Time unit representing one thousandth of a millisecond.
public
static
final
TimeUnit
MILLISECONDS
Time unit representing one thousandth of a second.
public
static
final
TimeUnit
MINUTES
Time unit representing sixty seconds.
public
static
final
TimeUnit
NANOSECONDS
Time unit representing one thousandth of a microsecond.
public
static
final
TimeUnit
SECONDS
Time unit representing one second.