javax.realtime

Class AbsoluteTime

java.lang.Object

javax.realtime.HighResolutionTime<AbsoluteTime>

javax.realtime.AbsoluteTime

All Implemented Interfaces:

Cloneable, Comparable<AbsoluteTime>

public class AbsoluteTime
extends HighResolutionTime<AbsoluteTime>

Jamaica Real-Time Specification for Java class AbsoluteTime.

This class represents an absolute point in the time represented by a Clock.

Constructor Summary

Constructors

Constructor and Description
AbsoluteTime() Constructor to create absolute time 0ms, 0ns.
AbsoluteTime(AbsoluteTime time) Constructor to create an absolute time with millis and nanos taken from an existing absolute time.
AbsoluteTime(AbsoluteTime time, Clock clock) Constructor to create an absolute time with millis and nanos taken from an existing absolute time.
AbsoluteTime(Clock clock) Constructor to create absolute time 0ms, 0ns with given clock association.
AbsoluteTime(Date date) Constructor to create an absolute time from a time represented by an instance of Date.
AbsoluteTime(Date date, Clock clock) Constructor to create an absolute time from a time represented by an instance of Date.
AbsoluteTime(long millis, int nanos) Constructor to create an absolute time from given milli and nano seconds.
AbsoluteTime(long millis, int nanos, Clock clock) Constructor to create an absolute time from given milli and nano seconds.

Method Summary

Modifier and Type	Method and Description
AbsoluteTime	absolute(Clock clock) absolute implements abstract method inherited from HighResolutionTime.
AbsoluteTime	absolute(Clock clock, AbsoluteTime dest) absolute implements abstract method inherited from HighResolutionTime.
AbsoluteTime	add(long millis, int nanos) add adds time given in milliseconds and nanoseconds to this absolute time.
AbsoluteTime	add(long millis, int nanos, AbsoluteTime dest) add adds time given in milliseconds and nanoseconds to this absolute time.
AbsoluteTime	add(RelativeTime time) add adds interval given as RelativeTime instance to this absolute time.
AbsoluteTime	add(RelativeTime time, AbsoluteTime dest) add adds interval given as RelativeTime instance to this absolute time.
Date	getDate() getDate converts this absolute time to an instance of Date that represents the same time.
RelativeTime	relative(Clock clock) relative implements abstract method inherited from HighResolutionTime.
RelativeTime	relative(Clock clock, RelativeTime dest) relative implements abstract method inherited from HighResolutionTime.
AbsoluteTime	set(Date date) set sets the time represented by this to the time represented by an instance of Date.
RelativeTime	subtract(AbsoluteTime time) subtract subtracts another absolute time from this absolute time.
RelativeTime	subtract(AbsoluteTime time, RelativeTime dest) subtract subtracts another absolute time from this absolute time.
AbsoluteTime	subtract(RelativeTime time) subtract subtracts an interval given as an instance of RelativeTime from this.
AbsoluteTime	subtract(RelativeTime time, AbsoluteTime dest) subtract subtracts an interval given as an instance of RelativeTime from this.
String	toString() Creates a printable string of the time given by this.

Methods inherited from class javax.realtime.HighResolutionTime

clone, 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

AbsoluteTime

public AbsoluteTime()

Constructor to create absolute time 0ms, 0ns.

AbsoluteTime

public AbsoluteTime(AbsoluteTime time)

Constructor to create an absolute time with millis and nanos taken from an existing absolute time. Use time.getClock() as associated clock.

Parameters:

time - the original absolute time, must not be null.

AbsoluteTime

public AbsoluteTime(Date date)

Constructor to create an absolute time from a time represented by an instance of Date. Use the RealtimeClock as associated clock.

Note, the usage of the present method may introduce some drifting time effects. In fact, two AbsolutTime objects constructed with an identical date parameter potentially reflecting different points in time.

Parameters:

date - the original Date, must not be null.

AbsoluteTime

public AbsoluteTime(long millis,
                    int nanos)

Constructor to create an absolute time from given milli and nano seconds. nanos should be positive.

ensure

   (this.getMilliseconds() == millis,
    this.getNanosecondes() == nanos);
 

Parameters:

millis - the milliseconds value for the new absolute time.

nanos - the nanoseconds value for the new absolute time.

AbsoluteTime

public AbsoluteTime(Clock clock)

Constructor to create absolute time 0ms, 0ns with given clock association.

Parameters:

clock - the clock to be associated with this time, Clock.getRealtimeClock if null.

AbsoluteTime

public AbsoluteTime(AbsoluteTime time,
                    Clock clock)

Constructor to create an absolute time with millis and nanos taken from an existing absolute time. Use given clock association.

Parameters:

time - the original absolute time, must not be null.

clock - the clock to be associated with this time, Clock.getRealtimeClock if null.

AbsoluteTime

public AbsoluteTime(Date date,
                    Clock clock)

Constructor to create an absolute time from a time represented by an instance of Date. Use given clock association.

Note, the usage of the present method may introduce some drifting time effects. In fact, two AbsolutTime objects constructed with an identical date parameter potentially reflect different points in time.

Parameters:

date - the original Date, must not be null.

clock - the clock to be associated with this time, Clock.getRealtimeClock if null.

AbsoluteTime

public AbsoluteTime(long millis,
                    int nanos,
                    Clock clock)

Constructor to create an absolute time from given milli and nano seconds. nanos should be positive. Use given clock association.

ensure

   (this.getMilliseconds() == millis,
    this.getNanosecondes() == nanos);
 

Parameters:

millis - the milliseconds value for the new absolute time.

nanos - the nanoseconds value for the new absolute time.

clock - the clock to be associated with this time, Clock.getRealtimeClock if null.

Method Detail

absolute

public AbsoluteTime absolute(Clock clock,
                             AbsoluteTime dest)

absolute implements abstract method inherited from HighResolutionTime. It converts this time to an absolute time relative to the given clock. Use a preallocated AbsoluteTime object if present.

For AbsoluteTime, the result is this iff dest is null.

Specified by:

absolute in class HighResolutionTime<AbsoluteTime>

Parameters:

clock - The clock the result should be relative to, the realtime clock is considered iff it is null.

dest - The preallocated AbsoluteTime object to hold the result. May be null to indicate that a new object should be allocated.

Returns:

The AbsoluteTime conversion in dest when dest is not null, otherwise the result is returned in a newly allocated object.

absolute

public AbsoluteTime absolute(Clock clock)

absolute implements abstract method inherited from HighResolutionTime. absolute converts this time to an absolute time relative to the given clock and a new object is allocated for the result.

For AbsoluteTime, no conversion into AbsoluteTime is needed in this case.

Specified by:

absolute in class HighResolutionTime<AbsoluteTime>

Parameters:

clock - The clock the result should be relative to. When clock is null the association is made with the default realtime clock.

Returns:

The copy of this in a newly allocated AbsoluteTime object, associated with the clock parameter.

add

public AbsoluteTime add(long millis,
                        int nanos)

add adds time given in milliseconds and nanoseconds to this absolute time.

Parameters:

millis - the milliseconds part of the interval to be added.

nanos - the nanoseconds part of the interval to be added.

Returns:

a new instance of AbsoluteTime of the time of this plus the interval millis/ nanos.

add

public AbsoluteTime add(long millis,
                        int nanos,
                        AbsoluteTime dest)

add adds time given in milliseconds and nanoseconds to this absolute time.

Parameters:

millis - the milliseconds part of the interval to be added.

nanos - the nanoseconds part of the interval to be added.

dest - The preallocated AbsoluteTime object to hold the result. May be null to indicate that a new object should be allocated.

Returns:

dest, if dest is not null, the newly allocated object otherwise. The result represents that absolute time of this plus the interval millis/ nanos.

add

public AbsoluteTime add(RelativeTime time)

add adds interval given as RelativeTime instance to this absolute time.

Parameters:

time - the interval to be added

Returns:

a new instance of AbsoluteTime of the time of this plus the interval time.

add

public AbsoluteTime add(RelativeTime time,
                        AbsoluteTime dest)

add adds interval given as RelativeTime instance to this absolute time.

Parameters:

time - the interval to be added

dest - The preallocated AbsoluteTime object to hold the result. May be null to indicate that a new object should be allocated.

Returns:

dest, if dest is not null, the newly allocated object otherwise. The result represents that absolute time of this plus the interval time.

getDate

public Date getDate()

getDate converts this absolute time to an instance of Date that represents the same time. Precision is lost in this conversion, the precision of Data is restricted to milliseconds.

Returns:

a new instance of Date.

set

public AbsoluteTime set(Date date)

set sets the time represented by this to the time represented by an instance of Date.

Note, the usage of the present method may introduce some drifting time effects. As a consequence, the equality is not assured between the results of getDate() calls on two AbsoluteTime objects with the same date.

Parameters:

date - an instance of Date, must not be null.

Since:

RTSJ 2.0 returns itself

subtract

public RelativeTime subtract(AbsoluteTime time)

subtract subtracts another absolute time from this absolute time.

Parameters:

time - the other absolute time.

Returns:

a new instance of RelativeTime of the length of the interval between this and time.

subtract

public RelativeTime subtract(AbsoluteTime time,
                             RelativeTime dest)

subtract subtracts another absolute time from this absolute time.

Parameters:

time - the other absolute time.

dest - The preallocated RelativeTime object to hold the result. May be null to indicate that a new object should be allocated.

Returns:

dest, if dest is not null, the newly allocated object otherwise. The result represents the interval between this and time.

subtract

public AbsoluteTime subtract(RelativeTime time)

subtract subtracts an interval given as an instance of RelativeTime from this.

Parameters:

time - the interval to be subtracted.

Returns:

a new instance of AbsoluteTime of the time of this minus the interval time.

subtract

public AbsoluteTime subtract(RelativeTime time,
                             AbsoluteTime dest)

subtract subtracts an interval given as an instance of RelativeTime from this.

Parameters:

time - the interval to be subtracted.

dest - The preallocated RelativeTime object to hold the result. May be null to indicate that a new object should be allocated.

Returns:

dest, if dest is not null, the newly allocated object otherwise. The result represents the absolute time of this minus the interval time.

toString

public String toString()

Creates a printable string of the time given by this.

The string shall be a decimal representation of the milliseconds and nanosecond values; formatted as follows "(2251 ms, 750000 ns)"

Overrides:

toString in class Object

Returns:

a String object converted from the time given by this.

relative

public RelativeTime relative(Clock clock)

relative implements abstract method inherited from HighResolutionTime. relative returns a new relative time object for this relative to the given clock.

Specified by:

relative in class HighResolutionTime<AbsoluteTime>

Parameters:

clock - The clock the result should be relative to.

Returns:

a new RelativeTime object.

relative

public RelativeTime relative(Clock clock,
                             RelativeTime dest)

relative implements abstract method inherited from HighResolutionTime. relative returns a new relative time object for this relative to the given clock.

Specified by:

relative in class HighResolutionTime<AbsoluteTime>

Parameters:

clock - The clock the result should be relative to.

dest - The preallocated RelativeTime object to hold the result. May be null to indicate that a new object should be allocated.

Returns:

time, if time is not null, the newly allocated object otherwise.