javax.realtime

Class HighResolutionTime

java.lang.Object

javax.realtime.HighResolutionTime

All Implemented Interfaces:

java.lang.Comparable<HighResolutionTime>

Direct Known Subclasses:

AbsoluteTime, RelativeTime

@SCJAllowed
public abstract class HighResolutionTime
extends java.lang.Object
implements java.lang.Comparable<HighResolutionTime>

HighResolutionTime is the base class for time given with nanosecond accuracy.

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 operations, negative values behave as they do in Java arithmetic.

Methods of this class are not synchronized by the implementation.

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 only meaningful for AbsoluteTime
- semantic issue: Java arithmetic means no overflow detection
- semantic issue: method set: if parameter null, no Exception?

- implementation issue: public int compareTo (Object arg0) is inherited from interface Comparable

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(HighResolutionTime time) Compares this with the specified HighResolutionTime time.
boolean	equals(HighResolutionTime time)
Clock	getClock()
long	getMilliseconds()
int	getNanoseconds()
int	hashCode()
void	set(HighResolutionTime time) Change the value represented by this to that of the given time.
void	set(long millis) Sets the millisecond component of this to the given argument, and the nanosecond component of this to 0.
void	set(long millis, int nanos) Sets the millisecond and nanosecond components of this to the given arguments.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getClock

public final Clock getClock()

Returns:

a reference to the clock associated with this.

getMilliseconds

public final long getMilliseconds()

Returns:

the milliseconds component of the time represented by this.

getNanoseconds

public final int getNanoseconds()

Returns:

the nanoseconds component of the time represented by this.

set

public void set(HighResolutionTime time)

Change the value represented by this to that of the given time.

Parameters:

time - is the new value for this.

Throws:

java.lang.ClassCastException - if the time parameter is not of the same class as this.

java.lang.IllegalArgumentException - if the time parameter is not associated with the same clock as this, or when the time parameter is null.

set

public void set(long millis)

Sets the millisecond component of this to the given argument, and the nanosecond component of this to 0. The clock is unchanged.

Parameters:

millis - is the new value of the millisecond component.

set

public void set(long millis,
       int nanos)

Sets the millisecond and nanosecond components of this to the given arguments. The clock is unchanged.

Parameters:

millis - is the new value of the millisecond component.

nanos - is the new value of the nanosecond component.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(HighResolutionTime time)

Parameters:

time -

Returns:

true just when the parameter time is of the same type and has the same values as this.

compareTo

public int compareTo(HighResolutionTime time)

Compares this with the specified HighResolutionTime time.

Specified by:

compareTo in interface java.lang.Comparable<HighResolutionTime>

Parameters:

time - is the second argument to the comparison.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than time.

Throws:

java.lang.ClassCastException - if the time parameter is not of the same class as this.

java.lang.IllegalArgumentException - if the time parameter is not associated with the same clock as this, or when the time parameter is null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object