javax.safetycritical

Class HighResolutionTime

java.lang.Object

javax.safetycritical.HighResolutionTime

All Implemented Interfaces:

java.lang.Comparable

Direct Known Subclasses:

AbsoluteTime, RelativeTime

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

HighResolutionTime is the base class for time given by milliseconds plus nanoseconds.

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.

Version:

1.0; - May 2012

Author:

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

Relative_to_SCJ_Draft_Version_0.79:

- semantic issue: clock is only meaningful for AbsoluteTime
- semantic issue: Java arithmetic means no overflow detection
- semantic issue: constructor should be protected
- semantic issue: method set: if parameter null, no Exception?

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

• public static void waitForObject(java.lang.Object target, HighResolutionTime time) throws java.lang.InterruptedException

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(HighResolutionTime time) Compares this with the specified HighResolutionTime time.
int	compareTo(java.lang.Object arg0)
boolean	equals(HighResolutionTime time)
Clock	getClock()
long	getMilliseconds()
int	getNanoseconds()
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()
static void	waitForObject(java.lang.Object target, HighResolutionTime time)

Methods inherited from class java.lang.Object

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

Method Detail

getClock

public Clock getClock()

Returns:

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. If null, this is left unchanged.

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.

equals

public boolean equals(HighResolutionTime time)

Parameters:

time -

Returns:

is true if 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.

Parameters:

time - is the second argument to the comparison.

Returns:

the result of the comparison.

compareTo

public int compareTo(java.lang.Object arg0)

Specified by:

compareTo in interface java.lang.Comparable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

waitForObject

@SCJAllowed(value=LEVEL_2)
public static void waitForObject(java.lang.Object target,
                                        HighResolutionTime time)
                          throws java.lang.InterruptedException

Relative_to_SCJ_Draft_Version_0.79:

Omitted ?; - not implemented

Throws:

java.lang.InterruptedException