|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.realtime.Clock
public abstract class Clock
A clock marks the passing of time.
It has a concept of now that can be queried through
Clock.getTime()
, and it can have events
queued on it which will be fired when their appointed time is reached.
Constructor Summary | |
---|---|
Clock()
Constructor for the abstract class. |
Method Summary | |
---|---|
abstract RelativeTime |
getEpochOffset()
Returns the relative time of the offset of the epoch of this clock from the Epoch. |
static Clock |
getRealtimeClock()
There is always at least one clock object available: the system real-time clock. |
abstract RelativeTime |
getResolution()
Gets the resolution of the clock, the nominal interval between ticks. |
abstract AbsoluteTime |
getTime()
Gets the current time in a newly allocated object. |
abstract AbsoluteTime |
getTime(AbsoluteTime time)
Gets the current time in an existing object. |
abstract void |
setResolution(RelativeTime resolution)
Set the resolution of this . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Clock()
Method Detail |
---|
public abstract RelativeTime getEpochOffset()
this
clock from the Epoch.
For the real-time clock it will return
a RelativeTime value equal to 0.
An UnsupportedOperationException
is thrown if the clock
does not support the concept of date.
RelativeTime
object in the current execution context with the offset past
the Epoch for this
clock.
The returned object is associated with this
clock.
java.lang.UnsupportedOperationException
- Thrown if the
clock does not have the concept of date.public static Clock getRealtimeClock()
Clock
.
Clock
public abstract RelativeTime getResolution()
RelativeTime
object in the
current execution context representing
the resolution of this
.
The returned object is associated with this
clock.public abstract AbsoluteTime getTime()
AbsoluteTime
in the
current allocation context, representing the current time.
The returned object is associated with this
clock.public abstract AbsoluteTime getTime(AbsoluteTime time)
AbsoluteTime
is changed at some time between the
invocation of the method and the return of the method.
Note: This method will return an absolute time value
that represents the clock's notion of an absolute time. For clocks
that do not measure calendar time this absolute time may not represent
a wall clock time.
time
- The instance of AbsoluteTime
object
which will be updated in place.
The clock association of the time
parameter
is ignored.
When time
is not null
the returned object
is associated with this
clock.
If time
is null
, then nothing happens.
AbsoluteTime
passed as parameter,
representing the current time, associated with this
clock, or null
if time
was null
.void
to
AbsoluteTime.
public abstract void setResolution(RelativeTime resolution)
this
.
For some hardware clocks setting resolution is
impossible and if this method is called on those clocks,
then an UnsupportedOperationException
is thrown.
resolution
- The new resolution of this
, if
the requested value is supported by this clock. If resolution
is smaller than the minimum resolution supported by this clock
then it throws IllegalArgumentException. If the requested
resolution is not available and it is larger than the minimum
resolution, then the clock will be set to the closest
resolution that the clock supports, via truncation. The value
of the resolution parameter is not altered. The clock
association of the resolution
parameter is
ignored.
java.lang.IllegalArgumentException
- Thrown if
resolution
is null, or if the requested resolution
is smaller than the minimum resolution supported by this clock.
java.lang.UnsupportedOperationException
- Thrown if the
clock does not support setting its resolution.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |