HighResolutionTime (aicas Realtime Specification for Java API)

java.lang.Object
- javax.realtime.HighResolutionTime<T>

Type Parameters:

T - is the type of high resolution time.

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<T>

Direct Known Subclasses:

AbsoluteTime, RelativeTime
```
public abstract class HighResolutionTime<T extends HighResolutionTime<T>>
extends java.lang.Object
implements java.lang.Comparable<T>, java.lang.Cloneable
```
Class HighResolutionTime is the base class for AbsoluteTime and RelativeTime. It can be used to express time with nanosecond resolution. This class is never used directly; it is abstract and has no public constructor. Instead, one of its subclasses AbsoluteTime or RelativeTime should be used. When an API is defined that has a HighResolutionTime as a parameter, it can take either an absolute or a relative time and will do something appropriate.
Caution: This class is explicitly unsafe for multithreading when being changed. Code that mutates instances of this class should synchronize at a higher level.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract AbsoluteTime`	`absolute(Chronograph chronograph)` absolute converts this time to an absolute time relative to the given chronograph.
`abstract AbsoluteTime`	`absolute(Chronograph chronograph, AbsoluteTime dest)` absolute converts this time to an absolute time relative to the given chronograph.
`abstract AbsoluteTime`	`absolute(Clock clock)` absolute converts this time to an absolute time relative to the given clock.
`abstract AbsoluteTime`	`absolute(Clock clock, AbsoluteTime dest)` absolute converts this time to an absolute time relative to the given clock.
`java.lang.Object`	`clone()` produces a clone of this object.
`int`	`compareTo(T time)` Compares `this` `HighResolutionTime` with the specified `HighResolutionTime` `time`.
`boolean`	`equals(java.lang.Object object)` equals checks if this and object are equal.
`boolean`	`equals(T time)` equals checks if this and time are equal.
`Chronograph`	`getChronograph()` getChronograph returns a reference to the chronograph associated with this.
`Clock`	`getClock()` getClock returns a reference to the clock associated with this.
`long`	`getMilliseconds()` getMilliseconds returns the milliseconds part of this time object.
`int`	`getNanoseconds()` getNanoseconds returns the nanoseconds part of this time object.The time represented by this is getMilliseconds()*1000000+ getNanosecondes() ns.
`int`	`hashCode()` hashCode calculates a hashCode for this.
`abstract RelativeTime`	`relative(Chronograph chronograph)` relative returns a new relative time object for this relative to the given chronograph.
`abstract RelativeTime`	`relative(Chronograph chronograph, RelativeTime time)` relative converts this time to a relative time using the given chronograph.
`abstract RelativeTime`	`relative(Clock clock)` relative returns a new relative time object for this relative to the given clock.
`abstract RelativeTime`	`relative(Clock clock, RelativeTime time)` relative converts this time to a relative time using the given clock.
`T`	`set(Chronograph chronograph, long millis, int nanos)` Sets the all components of `this`.
`T`	`set(long millis)` Sets the millisecond component of `this` to the given argument, and the nanosecond component of `this` to 0.
`T`	`set(long millis, int nanos)` Sets the millisecond and nanosecond components of `this`.
`T`	`set(T time)` Changes the value represented by `this` to that of the given `time`.
`static boolean`	`waitForObject(java.lang.Object target, HighResolutionTime<?> time)` waitForObject waits for the given object using a HighResolutionTime as timeout.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - absolute
```
public abstract AbsoluteTime absolute(Chronograph chronograph)
```
    absolute converts this time to an absolute time relative to the given chronograph.
    
    Parameters:
    
    chronograph - The chronograph the result should be relative to.
    
    Returns:
    
    this or a new object allocated from the current memory area for the absolute time.
  - absolute
```
public abstract AbsoluteTime absolute(Clock clock)
```
    absolute converts this time to an absolute time relative to the given clock.
    
    Parameters:
    
    clock - The clock the result should be relative to.
    
    Returns:
    
    this or a new object allocated from the current memory area for the absolute time.
  - absolute
```
public abstract AbsoluteTime absolute(Chronograph chronograph,
                                      AbsoluteTime dest)
```
    absolute converts this time to an absolute time relative to the given chronograph. Use a preallocated AbsoluteTime object if present.
    
    Parameters:
    
    chronograph - The chronograph the result should be relative to.
    
    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.
  - absolute
```
public abstract AbsoluteTime absolute(Clock clock,
                                      AbsoluteTime dest)
```
    absolute converts this time to an absolute time relative to the given clock. Use a preallocated AbsoluteTime object if present.
    
    Parameters:
    
    clock - The clock the result should be relative to.
    
    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.
  - compareTo
```
public int compareTo(T time)
```
    Compares this HighResolutionTime with the specified HighResolutionTime time.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<T extends HighResolutionTime<T>>
    
    Parameters:
    
    time - To be compared with the time of this.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than time.
    
    Throws:
    
    StaticIllegalArgumentException - when the time parameter is not associated with the same chronograph as this, or when the time parameter is null.
    
    java.lang.ClassCastException - when the time parameter is not of the same class as this.
    
    Since:
    
    RTSJ 2.0
  - equals
```
public boolean equals(T time)
```
    equals checks if this and time are equal.
    
    Parameters:
    
    time - another HighResulutionTime object.
    
    Returns:
    
    true iff this.compareTo(time)==0 and clock.equals(time.getChronograph())
  - equals
```
public boolean equals(java.lang.Object object)
```
    equals checks if this and object are equal.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - another object.
    
    Returns:
    
    true iff object is an instance of HighResolutionTime and is equal to this.
  - getChronograph
```
public Chronograph getChronograph()
```
    getChronograph returns a reference to the chronograph associated with this.
    ensure
```
   (Result != null);
 
```
    Returns:
    
    the chronograph associated with this
    
    Since:
    
    RTSJ V1.0.1
  - getClock
```
public Clock getClock()
```
    getClock returns a reference to the clock associated with this.
    ensure
```
   (Result != null);
 
```
    Returns:
    
    the clock associated with this
    
    Since:
    
    RTSJ V1.0.1
  - getMilliseconds
```
public final long getMilliseconds()
```
    getMilliseconds returns the milliseconds part of this time object. The time represented by this is getMilliseconds()*1000000+ getNanosecondes() ns.
    
    Returns:
    
    the milliseconds
  - getNanoseconds
```
public final int getNanoseconds()
```
    getNanoseconds returns the nanoseconds part of this time object.The time represented by this is getMilliseconds()*1000000+ getNanosecondes() ns.
    
    Returns:
    
    the nanoseconds.
  - hashCode
```
public int hashCode()
```
    hashCode calculates a hashCode for this.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    integer hashCode.
  - set
```
public T set(T time)
```
    Changes the value represented by this to that of the given time. The Chronograph associated with this is set to be the Chronograph associated with the time parameter.
    
    Parameters:
    
    time - The new value of this
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.ClassCastException - when the type of this and the type of the parameter time are not the same.
    
    StaticIllegalArgumentException - when the parameter time is null.
    
    Since:
    
    RTSJ 2.0 returns itself
  - set
```
public T set(long millis)
```
    Sets the millisecond component of this to the given argument, and the nanosecond component of this to 0. This method is equivalent to set(millis, 0).
    
    Parameters:
    
    millis - This value shall be the value of the millisecond component of this at the completion of the call.
    
    Returns:
    
    this
    
    Since:
    
    RTSJ 2.0 returns itself
  - set
```
public T set(long millis,
             int nanos)
```
    Sets the millisecond and nanosecond components of this. The setting is subject to parameter normalization. When after normalization the time is negative then the time represented by this is set to a negative value, but note that negative times are not supported everywhere. For instance, a negative relative time is an invalid value for a periodic thread's period.
    
    Parameters:
    
    millis - The desired value for the millisecond component of this at the completion of the call. The actual value is the result of parameter normalization.
    
    nanos - The desired value for the nanosecond component of this at the completion of the call. The actual value is the
    
    Returns:
    
    this
    
    Throws:
    
    StaticIllegalArgumentException - when there is an overflow in the millisecond component while normalizing. result of parameter normalization.
    
    Since:
    
    RTSJ 2.0 returns itself
  - set
```
public T set(Chronograph chronograph,
             long millis,
             int nanos)
      throws StaticIllegalArgumentException
```
    Sets the all components of this. The setting is subject to parameter normalization. When after normalization the time is negative, the time represented by this is set to a negative value, but note, negative times are not supported everywhere. For instance, a negative relative time is an invalid value for a periodic thread's period.
    
    Parameters:
    
    chronograph - The time reference for the other components of this set during the call call.
    
    millis - The desired value for the millisecond component of this at the completion of the call. The actual value is the result of parameter normalization.
    
    nanos - The desired value for the nanosecond component of this at the completion of the call. The actual value is the result of parameter normalization.
    
    Returns:
    
    this
    
    Throws:
    
    StaticIllegalArgumentException - when there is an overflow in the millisecond component while normalizing.
    
    Since:
    
    RTSJ 2.0 returns itself
  - waitForObject
```
public static boolean waitForObject(java.lang.Object target,
                                    HighResolutionTime<?> time)
                             throws java.lang.InterruptedException
```
    waitForObject waits for the given object using a HighResolutionTime as timeout. This is equals to target.wait(), but it uses the higher accuracy of HighResolutionTime and it can handle AbsoluteTime and RelativeTime.
    
    Parameters:
    
    target - the target object to wait for.
    
    time - The timeout given as AbsoluteTime or RelativeTime.
    
    Returns:
    
    true when the notify was received before the timeout; false otherwise.
    
    Throws:
    
    java.lang.InterruptedException - when another thread caused this thread to be interrupted during the wait.
    
    Since:
    
    RTSJ 2.0 updated to add a return value.
  - relative
```
public abstract RelativeTime relative(Chronograph chronograph)
```
    relative returns a new relative time object for this relative to the given chronograph.
    
    Parameters:
    
    chronograph - The chronograph the result should be relative to.
    
    Returns:
    
    a new RelativeTime object.
  - relative
```
public abstract RelativeTime relative(Clock clock)
```
    relative returns a new relative time object for this relative to the given clock.
    
    Parameters:
    
    clock - The clock the result should be relative to.
    
    Returns:
    
    a new RelativeTime object.
  - relative
```
public abstract RelativeTime relative(Chronograph chronograph,
                                      RelativeTime time)
```
    relative converts this time to a relative time using the given chronograph. Use a preallocated RelativeTime object if present.
    
    Parameters:
    
    chronograph - The chronograph the result should be relative to.
    
    time - 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.
  - relative
```
public abstract RelativeTime relative(Clock clock,
                                      RelativeTime time)
```
    relative converts this time to a relative time using the given clock. Use a preallocated RelativeTime object if present.
    
    Parameters:
    
    clock - The clock the result should be relative to.
    
    time - 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.
  - clone
```
public java.lang.Object clone()
```
    produces a clone of this object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this object

Class HighResolutionTime<T extends HighResolutionTime<T>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

absolute

absolute

absolute

absolute

compareTo

equals

equals

getChronograph

getClock

getMilliseconds

getNanoseconds

hashCode

set

set

set

set

waitForObject

relative

relative

relative

relative

clone