org.omg.dds.core

Class Duration

java.lang.Object

org.omg.dds.core.Duration

All Implemented Interfaces:

Serializable, Comparable<Duration>, DDSObject

@Extensibility(value=FINAL_EXTENSIBILITY)
@Nested
public abstract class Duration
extends Object
implements Comparable<Duration>, Serializable, DDSObject

A span of elapsed time expressed with nanosecond precision. Instances of this type are immutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Duration()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Duration	add(Duration duration)
abstract Duration	add(long duration, TimeUnit unit)
abstract long	getDuration(TimeUnit inThisUnit) Truncate this duration to a whole-number quantity of the given time unit.
abstract long	getRemainder(TimeUnit primaryUnit, TimeUnit remainderUnit) If getting the magnitude of this duration in the given primaryUnit would cause truncation with respect to the given remainderUnit, return the magnitude of the truncation in the latter (presumably finer-grained) unit.
static Duration	infiniteDuration(ServiceEnvironment env)
abstract boolean	isInfinite() Report whether this duration lasts forever.
abstract boolean	isZero() Report whether this duration lasts no time at all.
static Duration	newDuration(long duration, TimeUnit unit, ServiceEnvironment env) Construct a time duration of the given magnitude.
abstract Duration	subtract(Duration duration)
abstract Duration	subtract(long duration, TimeUnit unit)
static Duration	zeroDuration(ServiceEnvironment env)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Constructor Detail

Duration

public Duration()

Method Detail

newDuration

public static Duration newDuration(long duration,
                   TimeUnit unit,
                   ServiceEnvironment env)

Construct a time duration of the given magnitude. A duration of magnitude Long.MAX_VALUE indicates an infinite duration, regardless of the units specified.

Parameters:

env - Identifies the Service instance to which the new object will belong.

See Also:

isInfinite(), infiniteDuration(ServiceEnvironment)

infiniteDuration

public static Duration infiniteDuration(ServiceEnvironment env)

Parameters:

env - Identifies the Service instance to which the object will belong.

Returns:

An unmodifiable Duration of infinite length.

zeroDuration

public static Duration zeroDuration(ServiceEnvironment env)

Parameters:

env - Identifies the Service instance to which the object will belong.

Returns:

A Duration of zero length.

getDuration

public abstract long getDuration(TimeUnit inThisUnit)

Truncate this duration to a whole-number quantity of the given time unit. For example, if this duration is equal to one second plus 100 nanoseconds, calling this method with an argument of TimeUnit.SECONDS will result in the value 1. If this duration is infinite, this method shall return Long.MAX_VALUE, regardless of the units given. If this duration cannot be expressed in the given units without overflowing, this method shall return Long.MAX_VALUE. In such a case, the caller may wish to use this method in combination with getRemainder(TimeUnit, TimeUnit) to obtain the full duration without lack of precision.

Parameters:

inThisUnit - The time unit in which the return result will be measured.

See Also:

getRemainder(TimeUnit, TimeUnit), Long.MAX_VALUE, TimeUnit

getRemainder

public abstract long getRemainder(TimeUnit primaryUnit,
                TimeUnit remainderUnit)

If getting the magnitude of this duration in the given primaryUnit would cause truncation with respect to the given remainderUnit, return the magnitude of the truncation in the latter (presumably finer-grained) unit. For example, if this duration is equal to one second plus 100 nanoseconds, calling this method with arguments of TimeUnit.SECONDS and TimeUnit.NANOSECONDS respectively will result in the value 100. This method is equivalent to the following pseudo-code: (this - getDuration(primaryUnit)).getDuration(remainderUnit) If remainderUnit is represents a coarser granularity than primaryUnit (for example, the former is TimeUnit.HOURS but the latter is TimeUnit.SECONDS), this method shall return 0. If the resulting duration cannot be expressed in the given units without overflowing, this method shall return Long.MAX_VALUE.

Parameters:

primaryUnit -

remainderUnit - The time unit in which the return result will be measured.

See Also:

getDuration(TimeUnit), Long.MAX_VALUE, TimeUnit

isZero

public abstract boolean isZero()

Report whether this duration lasts no time at all. The result of this method is equivalent to the following: this.getDuration(TimeUnit.NANOSECONDS) == 0;

See Also:

getDuration(TimeUnit)

isInfinite

public abstract boolean isInfinite()

Report whether this duration lasts forever. If this duration is infinite, the following relationship shall be true: this.equals(infiniteDuration(this.getEnvironment()))

See Also:

infiniteDuration(ServiceEnvironment)

add

public abstract Duration add(Duration duration)

Returns:

a new Duration that is the sum of this Duration and the given Duration.

add

public abstract Duration add(long duration,
           TimeUnit unit)

Returns:

a new Duration that is the sum of this Duration and the given duration.

subtract

public abstract Duration subtract(Duration duration)

Returns:

a new Duration that is the difference after subtracting the given Duration.

subtract

public abstract Duration subtract(long duration,
                TimeUnit unit)

Returns:

a new Duration that is the difference after subtracting the given Duration.