javax.realtime.HighResolutionTime
javax.realtime.AbsoluteTime
java.lang.Object
An object that represents a specific point in time given by
milliseconds plus nanoseconds past some point in time fixed by the
clock. For the default real-time clock the
fixed point is the Epoch
(January 1, 1970, 00:00:00 GMT).
The correctness of the Epoch as a time base depends on the
real-time clock
synchronization with an external world time reference.
This representation was designed to be compatible with
the standard Java representation of an absolute time in the
Date class.
A time object in normalized form represents negative time if
both components are nonzero and negative, or one is nonzero and negative
and the other is zero.
For add and subtract negative values
behave as they do in arithmetic.
Caution: This class is explicitly unsafe in multithreaded situations when it is being changed. No synchronization is done. It is assumed that users of this class who are mutating instances will be doing their own synchronization at a higher level.
| Constructor Summary | |
AbsoluteTime()
Equivalent to new AbsoluteTime(0,0).
|
|
AbsoluteTime(AbsoluteTime time)
Make a new AbsoluteTime object from the given
AbsoluteTime object.
|
|
AbsoluteTime(AbsoluteTime time,
Clock clock)
Make a new AbsoluteTime object from the given
AbsoluteTime object.
|
|
AbsoluteTime(Clock clock)
Equivalent to new AbsoluteTime(0,0,clock).
|
|
AbsoluteTime(java.util.Date date)
Equivalent to new AbsoluteTime (date.getTime(),0).
|
|
AbsoluteTime(java.util.Date date,
Clock clock)
Equivalent to new AbsoluteTime (date.getTime(),0,clock).
|
|
AbsoluteTime(long millis,
int nanos)
Construct an AbsoluteTime object with time millisecond
and nanosecond components past the real-time clock's Epoch
(00:00:00 GMT on January 1, 1970) based on the parameter
millis plus the parameter nanos.
|
|
AbsoluteTime(long millis,
int nanos,
Clock clock)
Construct an AbsoluteTime object with time millisecond
and nanosecond components past the
epoch for clock.
|
|
| Method Summary | |
AbsoluteTime |
absolute(Clock clock)
Return a copy of this modified if necessary to
have the specified clock association.
|
AbsoluteTime |
absolute(Clock clock,
AbsoluteTime dest)
Return a copy of this modified if necessary to
have the specified clock association.
|
AbsoluteTime |
add(long millis,
int nanos)
Create a new object representing the result of adding millis and nanos to
the values from this
and normalizing the result.
|
AbsoluteTime |
add(long millis,
int nanos,
AbsoluteTime dest)
Return an object containing the value resulting from adding millis and nanos to
the values from this
and normalizing the result.
|
AbsoluteTime |
add(RelativeTime time)
Create a new instance of AbsoluteTime
representing the result of adding time to
the value of this
and normalizing the result.
|
AbsoluteTime |
add(RelativeTime time,
AbsoluteTime dest)
Return an object containing the value resulting from adding time to
the value of this
and normalizing the result.
|
java.util.Date |
getDate()
Convert the time given by this to a Date format.
|
RelativeTime |
relative(Clock clock)
Convert the time of this to a relative time, using the
given instance of Clock to determine the current time.
|
RelativeTime |
relative(Clock clock,
RelativeTime dest)
Convert the time of this to a relative time, using the
given instance of Clock to determine the current time.
|
void |
set(java.util.Date date)
Change the time represented by this to that given
by the parameter.
|
RelativeTime |
subtract(AbsoluteTime time)
Create a new instance of RelativeTime
representing the result of subtracting time from
the value of this
and normalizing the result.
|
RelativeTime |
subtract(AbsoluteTime time,
RelativeTime dest)
Return an object containing the value resulting from subtracting time from
the value of this
and normalizing the result.
|
AbsoluteTime |
subtract(RelativeTime time)
Create a new instance of AbsoluteTime
representing the result of subtracting time from
the value of this
and normalizing the result.
|
AbsoluteTime |
subtract(RelativeTime time,
AbsoluteTime dest)
Return an object containing the value resulting from subtracting time from
the value of this
and normalizing the result.
|
java.lang.String |
toString()
Create a printable string of the time given by this.
|
| Methods inherited from class javax.realtime.HighResolutionTime |
clone, compareTo, compareTo, equals, equals, getClock, getMilliseconds, getNanoseconds, hashCode, set, set, set, waitForObject |
| Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public AbsoluteTime()
AbsoluteTime(0,0).
The clock association is implicitly made with the real-time clock.
public AbsoluteTime(AbsoluteTime time)
AbsoluteTime object from the given
AbsoluteTime object.
time parameter.
time - The AbsoluteTime object which is the
source for the copy.
java.lang.IllegalArgumentException - Thrown if the time
parameter is null.
public AbsoluteTime(AbsoluteTime time,
Clock clock)
AbsoluteTime object from the given
AbsoluteTime object.
clock parameter.
If clock is null the association is made with
the real-time clock.
time - The AbsoluteTime object which is the
source for the copy.clock - The clock providing the association for the newly
constructed object.
java.lang.IllegalArgumentException - Thrown if the time
parameter is null.public AbsoluteTime(Clock clock)
AbsoluteTime(0,0,clock).
clock parameter.
If clock is null the association is made with
the real-time clock.
clock - The clock providing the association for the newly
constructed object.public AbsoluteTime(java.util.Date date)
AbsoluteTime (date.getTime(),0).
date - The java.util.Date representation of the
time past the Epoch.
java.lang.IllegalArgumentException - Thrown if the date
parameter is null.
public AbsoluteTime(java.util.Date date,
Clock clock)
AbsoluteTime (date.getTime(),0,clock).
date is used to set the milliseconds
component of the new AbsoluteTime object (with
nanoseconds component set to 0), the new object represents the
date only if the clock parameter has an
epoch equal to Epoch.
clock parameter.
If clock is null the association is made with
the real-time clock.
date - The java.util.Date
representation of the time past the Epoch.clock - The clock providing the association for the newly
constructed object.
java.lang.IllegalArgumentException - Thrown if the date
parameter is null.
public AbsoluteTime(long millis,
int nanos)
AbsoluteTime object with time millisecond
and nanosecond components past the real-time clock's Epoch
(00:00:00 GMT on January 1, 1970) based on the parameter
millis plus the parameter nanos.
The construction is subject to millis and
nanos parameters normalization.
If there is an overflow in the millisecond component
when normalizing then an IllegalArgumentException
will be thrown.
If after normalization the time object is negative then the time
represented by this is time before the Epoch.
millis - The desired value for the millisecond component
of this.
The actual value is the result of parameter normalization.nanos - The desired value for the nanosecond component
of this.
The actual value is the result of parameter normalization.
java.lang.IllegalArgumentException - Thrown if there is an overflow in the
millisecond component when normalizing.
public AbsoluteTime(long millis,
int nanos,
Clock clock)
AbsoluteTime object with time millisecond
and nanosecond components past the
epoch for clock.
The value of the AbsoluteTime instance is based on the
parameter
millis plus the parameter nanos.
The construction is subject to millis and
nanos parameters normalization.
If there is an overflow in the millisecond component
when normalizing then an IllegalArgumentException
will be thrown.
If after normalization the time object is negative then the time
represented by this is time before the epoch.
The clock association is made with the clock parameter.
If clock is null the association is made with
the real-time clock.
Note: The start of a clock's epoch is an attribute of the clock. It is defined as the Epoch (00:00:00 GMT on Jan 1, 1970) for the default real-time clock, but other classes of clock may define other epochs.
millis - The desired value for the millisecond component
of this.
The actual value is the result of parameter normalization.nanos - The desired value for the nanosecond component
of this.
The actual value is the result of parameter normalization.clock - The clock providing the association for the newly
constructed object.
java.lang.IllegalArgumentException - Thrown if there is an overflow in the
millisecond component when normalizing.| Method Detail |
public AbsoluteTime absolute(Clock clock)
this modified if necessary to
have the specified clock association.
A new object is allocated for the result.
This method is the implementation of the
abstract method of the HighResolutionTime
base class. No conversion into AbsoluteTime is needed
in this case.
The clock association of the result is with
the clock passed as a parameter.
If clock is null the association is made with
the real-time clock.
absolute in class HighResolutionTimeclock - The clock parameter is
used only as the new clock association with the result,
since no conversion is needed.
this in a
newly allocated AbsoluteTime object,
associated with the clock parameter.
public AbsoluteTime absolute(Clock clock,
AbsoluteTime dest)
this modified if necessary to
have the specified clock association.
If dest is not null, the result is placed
in dest
and returned. Otherwise, a new object is allocated for the result.
This method is the implementation of the
abstract method of the HighResolutionTime
base class. No conversion into AbsoluteTime is needed
in this case.
The clock association of the result is with
the clock passed as a parameter.
If clock is null the association is made with
the real-time clock.
absolute in class HighResolutionTimeclock - The clock parameter is
used only as the new clock association with the result,
since no conversion is needed.dest - If dest is not null, the result is placed
there and returned. Otherwise, a new object is allocated for the result.
this in
dest if dest is not null,
otherwise the result is returned in a newly allocated object.
It is associated with the clock parameter.
public AbsoluteTime add(long millis,
int nanos)
millis and nanos to
the values from this
and normalizing the result.
The result will have the same clock association as this.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
millis - The number of milliseconds to be added
to this.nanos - The number of nanoseconds to be added
to this.
AbsoluteTime object whose time is
the normalization of
this plus millis and nanos.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.
public AbsoluteTime add(long millis,
int nanos,
AbsoluteTime dest)
millis and nanos to
the values from this
and normalizing the result.
If dest is not null, the result is placed
there and returned. Otherwise, a new object is allocated for the result.
The result will have the same clock association as this,
and the clock association with dest is ignored.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
millis - The number of milliseconds to be added
to this.nanos - The number of nanoseconds to be added
to this.dest - If dest is not null,
the result is placed there and returned. Otherwise, a new
object is allocated for the result.
this plus millis and nanos in
dest if dest is not null,
otherwise the result is returned in a newly allocated object.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.public AbsoluteTime add(RelativeTime time)
AbsoluteTime
representing the result of adding time to
the value of this
and normalizing the result.
The clock associated with
this and the clock
associated with the time parameter
must be the same, and such association
is used for the result.
An IllegalArgumentException is thrown if the
clock associated with
this and the clock
associated with the time parameter
are different.
An IllegalArgumentException is thrown if the
time parameter is null.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
time - The time to add to this.
AbsoluteTime object whose time is
the normalization of
this plus the parameter time.
java.lang.IllegalArgumentException - Thrown if the
clock associated with
this and the clock
associated with the time parameter
are different, or when the
time parameter is null.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.
public AbsoluteTime add(RelativeTime time,
AbsoluteTime dest)
time to
the value of this
and normalizing the result.
If dest is not null, the result is placed
there and returned. Otherwise, a new object is allocated for the result.
The clock associated with
this and the clock
associated with the time parameter
must be the same, and such association
is used for the result.
The clock
associated with the dest parameter
is ignored.
An IllegalArgumentException is thrown if the
clock associated with
this and the clock
associated with the time parameter
are different.
An IllegalArgumentException is thrown if the
time parameter is null.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
time - The time to add to this.dest - If dest is not null,
the result is placed there and returned. Otherwise, a new
object is allocated for the result.
this plus the RelativeTime
parameter time in
dest if dest is not null,
otherwise the result is returned in a newly allocated object.
java.lang.IllegalArgumentException - Thrown if the
clock associated with
this and the clock
associated with the time parameter
are different, or when the
time parameter is null.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.public java.util.Date getDate()
this to a Date format.
Note that Date represents time as milliseconds so the
nanoseconds of this will be lost.
An UnsupportedOperationException is thrown if the clock
associated with this does not have the concept of date.
Date object with a value of the
time past the Epoch represented by this.
java.lang.UnsupportedOperationException - Thrown if the
clock associated with this does not have the concept
of date.public RelativeTime relative(Clock clock)
this to a relative time, using the
given instance of Clock to determine the current time.
The calculation is the current time indicated by the given instance of
Clock subtracted from the time given by this.
If clock is null the
real-time clock is assumed.
A destination object is allocated to return the result.
The clock association of the result is with
the clock passed as a parameter.
relative in class HighResolutionTimeclock - The instance of Clock used to convert the
time of this into relative time,
and the new clock association for the result.
RelativeTime conversion in a newly allocated
object, associated with the clock parameter.
java.lang.ArithmeticException - Thrown if the result
does not fit in the normalized format.
public RelativeTime relative(Clock clock,
RelativeTime dest)
this to a relative time, using the
given instance of Clock to determine the current time.
The calculation is the current time indicated by the given instance of
Clock subtracted from the time given by this.
If clock is null the
real-time clock is assumed.
If dest is not null, the result is placed
there and returned. Otherwise, a new object is allocated for the result.
The clock association of the result is with
the clock passed as a parameter.
relative in class HighResolutionTimeclock - The instance of Clock used to convert the
time of this into relative time,
and the new clock association for the result.dest - If dest is not null,
the result is placed there and returned. Otherwise, a new object is
allocated for the result.
RelativeTime conversion in
dest if dest is not null,
otherwise the result is returned in a newly allocated object.
It is associated with the clock parameter.
java.lang.ArithmeticException - Thrown if the result
does not fit in the normalized format.public void set(java.util.Date date)
this to that given
by the parameter.
Note that Date represents time as milliseconds so the
nanoseconds of this will be set to 0.
An IllegalArgumentException is thrown if
the parameter date is null.
The clock association is implicitly made with the real-time clock.
date - A reference to a Date which will become
the time represented by this
after the completion of this method.
java.lang.IllegalArgumentException - Thrown if
the parameter date is null.public RelativeTime subtract(AbsoluteTime time)
RelativeTime
representing the result of subtracting time from
the value of this
and normalizing the result.
The clock associated with
this and the clock
associated with the time parameter
must be the same, and such association
is used for the result.
An IllegalArgumentException is thrown if the
clock associated with
this and the clock
associated with the time parameter
are different.
An IllegalArgumentException is thrown if the
time parameter is null.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
time - The time to subtract from this.
RelativeTime object whose time is
the normalization of
this minus the AbsoluteTime
parameter time.
java.lang.IllegalArgumentException - if the
clock associated with
this and the clock
associated with the time parameter
are different, or when the
time parameter is null.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.
public RelativeTime subtract(AbsoluteTime time,
RelativeTime dest)
time from
the value of this
and normalizing the result.
If dest is not null, the result is placed
there and returned. Otherwise, a new object is allocated for the result.
The clock associated with
this and the clock
associated with the time parameter
must be the same, and such association
is used for the result.
The clock
associated with the dest parameter
is ignored.
An IllegalArgumentException is thrown if the
clock associated with
this and the clock
associated with the time parameter
are different.
An IllegalArgumentException is thrown if the
time parameter is null.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
time - The time to subtract from this.dest - If dest is not null,
the result is placed there and returned. Otherwise, a new
object is allocated for the result.
this minus the AbsoluteTime
parameter time in
dest if dest is not null,
otherwise the result is returned in a newly allocated object.
java.lang.IllegalArgumentException - if the
clock associated with
this and the clock
associated with the time parameter
are different, or when the
time parameter is null.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.public AbsoluteTime subtract(RelativeTime time)
AbsoluteTime
representing the result of subtracting time from
the value of this
and normalizing the result.
The clock associated with
this and the clock
associated with the time parameter
must be the same, and such association
is used for the result.
An IllegalArgumentException is thrown if the
clock associated with
this and the clock
associated with the time parameter
are different.
An IllegalArgumentException is thrown if the
time parameter is null.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
time - The time to subtract from this.
AbsoluteTime object whose time is
the normalization of
this minus the parameter time.
java.lang.IllegalArgumentException - Thrown if the
clock associated with
this and the clock
associated with the time parameter
are different, or when the
time parameter is null.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.
public AbsoluteTime subtract(RelativeTime time,
AbsoluteTime dest)
time from
the value of this
and normalizing the result.
If dest is not null, the result is placed
there and returned. Otherwise, a new object is allocated for the result.
The clock associated with
this and the clock
associated with the time parameter
must be the same, and such association
is used for the result.
The clock
associated with the dest parameter
is ignored.
An IllegalArgumentException is thrown if the
clock associated with
this and the clock
associated with the time parameter
are different.
An IllegalArgumentException is thrown if the
time parameter is null.
An ArithmeticException is thrown if the result does not
fit in the normalized format.
time - The time to subtract from this.dest - If dest is not null,
the result is placed there and returned. Otherwise, a new
object is allocated for the result.
this minus the RelativeTime
parameter time in
dest if dest is not null,
otherwise the result is returned in a newly allocated object.
java.lang.IllegalArgumentException - Thrown if the
clock associated with
this and the clock
associated with the time parameter
are different, or when the
time parameter is null.
java.lang.ArithmeticException - Thrown if the result does not fit
in the normalized format.public java.lang.String toString()
this.
The string shall be a decimal representation of the milliseconds and nanosecond values; formatted as follows "(2251 ms, 750000 ns)"
this.