javax.realtime

Class RelativeTime

java.lang.Object

javax.realtime.HighResolutionTime

javax.realtime.RelativeTime

All Implemented Interfaces:

java.lang.Comparable<HighResolutionTime>

@SCJAllowed
public class RelativeTime
extends HighResolutionTime

An object that represents a duration in milliseconds and nanoseconds. The time interval is kept in normalized form.
A negative duration relative to now represents time in the past. 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.

Version:

1.2; - December 2013

Author:

Anders P. Ravn, Aalborg University, apr@cs.aau.dk,
Hans Søndergaard, VIA University College, Denmark, hso@via.dk

Relative_to_SCJ_Draft_Version_0.94:

- semantic issue: Clock is meaningless and ignored (RTSJ thinks otherwise).

Constructor Summary

Constructors

Constructor and Description
RelativeTime() Equivalent to RelativeTime(0,0).
RelativeTime(Clock clock) Constructs a duration of zero milliseconds and zero nanoseconds.
RelativeTime(long millis, int nanos) Construct a RelativeTime object representing a duration based on the parameter millis plus the parameter nanos.
RelativeTime(long millis, int nanos, Clock clock) Constructs a RelativeTime object representing a duration based on the parameters.
RelativeTime(RelativeTime time) Makes a new RelativeTime object from the given RelativeTime object.

Method Summary

Methods

Modifier and Type	Method and Description
RelativeTime	add(long millis, int nanos) Creates a new object representing the result of adding millis and nanos to the values from this and normalizing the result.
RelativeTime	add(long millis, int nanos, RelativeTime dest) Returns an object containing the value resulting from adding millis and nanos to this and normalizing the result.
RelativeTime	add(RelativeTime time) Creates a new object representing the result of adding time to the value of this.
RelativeTime	add(RelativeTime time, RelativeTime dest) Returns an object containing the value resulting from adding time to this and normalizing the result.
RelativeTime	subtract(RelativeTime time) Creates a new RelativeTime object representing the result of subtracting time from the value of this.
RelativeTime	subtract(RelativeTime time, RelativeTime dest) Creates a new RelativeTime object representing the result of subtracting time from the value of this.

Methods inherited from class javax.realtime.HighResolutionTime

compareTo, equals, getClock, getMilliseconds, getNanoseconds, hashCode, set, set, set, toString

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelativeTime

public RelativeTime()

Equivalent to RelativeTime(0,0).

RelativeTime

public RelativeTime(long millis,
            int nanos)

Construct a RelativeTime object representing a duration based on the parameter millis plus the parameter nanos. The construction is subject to normalization of these values.
The clock association is implicitly made with the real-time clock.

Parameters:

millis - is the milliseconds.

nanos - is the nanoseconds.

RelativeTime

public RelativeTime(Clock clock)

Constructs a duration of zero milliseconds and zero nanoseconds. The clock association is made with the clock parameter. If clock is null the association is made with the real-time clock.

Parameters:

clock - is the clock argument.

RelativeTime

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

Constructs a RelativeTime object representing a duration based on the parameters. If clock is null the association is made with the real-time clock.

Parameters:

millis - is the milliseconds

nanos - is the nanoseconds

clock - is the clock

RelativeTime

public RelativeTime(RelativeTime time)

Makes a new RelativeTime object from the given RelativeTime object.

Parameters:

time - is the copied object.

Throws:

java.lang.IllegalArgumentException - if time is null.

Method Detail

add

public RelativeTime add(long millis,
               int nanos)

Creates a new object representing the result of adding millis and nanos to the values from this and normalizing the result. The result will have the same clock association as this.

Parameters:

millis - is the milliseconds to be added.

nanos - is the nanoseconds to be added.

Returns:

the new object with the added durations.

add

public RelativeTime add(RelativeTime time)

Creates a new object representing the result of adding time to the value of this.

Parameters:

time - is the duration to be added.

Returns:

the new object with the added durations.

Throws:

java.lang.IllegalArgumentException - if time is null.

java.lang.IllegalArgumentException - if the clock associated with this and the clock associated with the time parameter are different.

add

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

Returns an object containing the value resulting from adding millis and nanos to 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 of dest is ignored.

Parameters:

millis - is the milliseconds to be added.

nanos - is the nanoseconds to be added.

dest - is the destination, if initially null a new RelativeTime() object is created.

Returns:

the the resulting value.

add

public RelativeTime add(RelativeTime time,
               RelativeTime dest)

Returns an object containing the value resulting from adding time to 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 are expected to be the same, and it is used for the result. The clock associated with the dest parameter is ignored.

Parameters:

time - is the time to be added

dest - is the destination, if null a new RelativeTime() object is created

Returns:

the resulting value.

Throws:

java.lang.IllegalArgumentException - if time is null.

java.lang.IllegalArgumentException - if the clock associated with this and the clock associated with the time parameter are different.

subtract

public RelativeTime subtract(RelativeTime time)

Creates a new RelativeTime object representing the result of subtracting time from the value of this.

Parameters:

time - the value to be subtracted.

Returns:

the difference between durations.

Throws:

java.lang.IllegalArgumentException - if time is null.

java.lang.IllegalArgumentException - if the clock associated with this and the clock associated with the time parameter are different.

subtract

public RelativeTime subtract(RelativeTime time,
                    RelativeTime dest)

Creates a new RelativeTime object representing the result of subtracting time from the value of this. 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 are expected to be the same, and such association is used for the result. The clock associated with the dest parameter is ignored.

Parameters:

time - is the duration to be subtracted

dest - is the destination, if null a new RelativeTime() object is created

Returns:

the dest object with the resulting value.

Throws:

java.lang.IllegalArgumentException - if time is null.

java.lang.IllegalArgumentException - if the clock associated with this and the clock associated with the time parameter are different.