AbsoluteDateInterval (patrius 4.3 API)

java.lang.Object
- fr.cnes.sirius.patrius.math.interval.GenericInterval<T>
- - fr.cnes.sirius.patrius.math.interval.ComparableInterval<AbsoluteDate>
  - - fr.cnes.sirius.patrius.time.AbsoluteDateInterval

All Implemented Interfaces:

Serializable, Comparable<ComparableInterval<AbsoluteDate>>
```
public final class AbsoluteDateInterval
extends ComparableInterval<AbsoluteDate>
```
This class implements an interval based on the AbsoluteDate class,
using the ComparableInterval class.

This implementation enforces that AbsoluteDate.PAST_INFINITE and AbsoluteDate.FUTURE_INFINITE cannot be closed boundaries.

Since:

3.0

Version:

$Id: AbsoluteDateInterval.java 18083 2017-10-02 16:54:39Z bignon $

Author:

cardosop

See Also:

Serialized Form

Use sample :

final AbsoluteDate lowEnd = new AbsoluteDate(); final AbsoluteDate upEnd = new AbsoluteDate(lowEnd, 4578.14); final IntervalEndpointType lowInt = IntervalEndpointType.CLOSED; final IntervalEndpointType upInt = IntervalEndpointType.OPEN; final AbsoluteDateInterval dateInterval = new AbsoluteDateInterval(lowInt, lowEnd, upEnd, upInt);

Concurrency :

immutable

Constructor Summary

Constructors
Constructor and Description
`AbsoluteDateInterval(AbsoluteDate lowerData, AbsoluteDate upperData)` Builds a new `AbsoluteDateInterval` with closed endpoints.
`AbsoluteDateInterval(ComparableInterval<AbsoluteDate> interval)` Builds a new `AbsoluteDateInterval` from a `ComparableInterval`<`AbsoluteDate`>.
`AbsoluteDateInterval(ComparableInterval<Double> interval, AbsoluteDate referenceDate)` Builds a new `AbsoluteDateInterval` from a `ComparableInterval`<`Double`> and a reference `AbsoluteDate`.
`AbsoluteDateInterval(IntervalEndpointType lowerEndpointIn, AbsoluteDate lowerDataIn, AbsoluteDate upperDataIn, IntervalEndpointType upperEndpointIn)` Builds a new `AbsoluteDateInterval`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareDurationTo(AbsoluteDateInterval interval)` Checks if the duration of the interval is longer, shorter or equal to the duration of another interval.
`double`	`durationFrom(AbsoluteDateInterval interval)` Computes the duration in seconds between the two intervals.
`AbsoluteDateInterval`	`extendTo(AbsoluteDate epoch)` Returns the interval after extending it so that it includes (closed endpoint) or is connected (open endpoint) to the specified value.
`double`	`getDuration()` Computes the interval duration (its length) in seconds.
`AbsoluteDateInterval`	`getIntersectionWith(AbsoluteDateInterval interval)` Returns the intersection with another interval.
`AbsoluteDateInterval`	`mergeTo(AbsoluteDateInterval interval)` Returns this interval merged with another interval (if they can be merged).
`AbsoluteDateInterval`	`scale(double scalingFactor)` Returns the interval scaled by a given factor with respect to its midpoint.
`AbsoluteDateInterval`	`scale(double scalingFactor, AbsoluteDate epoch)` Returns the interval scaled by a given factor with respect to the specified epoch.
`AbsoluteDateInterval`	`shift(double shift)` Returns the interval with its lower an upper bounds shifted by the specified value.
`AbsoluteDateInterval`	`shift(double lowerShift, double upperShift)` Returns the interval with its lower an upper bounds shifted by the specified values.
`String`	`toString(AbsoluteDate date)` Returns a String representing the durations between the interval's bounds and a specified date.

Methods inherited from class fr.cnes.sirius.patrius.math.interval.ComparableInterval
compareLowerEndTo, compareTo, compareUpperEndTo, contains, equals, getIntersectionWith, hashCode, includes, isConnectedTo, mergeTo, overlaps

Methods inherited from class fr.cnes.sirius.patrius.math.interval.GenericInterval
getLowerData, getLowerEndpoint, getUpperData, getUpperEndpoint, toString

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

- Constructor Detail
  - AbsoluteDateInterval
```
public AbsoluteDateInterval(AbsoluteDate lowerData,
                            AbsoluteDate upperData)
```
    Builds a new AbsoluteDateInterval with closed endpoints.
    
    Parameters:
    
    lowerData - the lower end AbsoluteDate
    
    upperData - the upper end AbsoluteDate
    
    Throws:
    
    MathIllegalArgumentException - when the interval is invalid (unchecked exception).
    In addition to GenericInterval and ComparableInterval checks, the infinite date boundaries also have to be opened.
    
    See Also:
    
    ComparableInterval, GenericInterval, AbsoluteDate
  - AbsoluteDateInterval
```
public AbsoluteDateInterval(IntervalEndpointType lowerEndpointIn,
                            AbsoluteDate lowerDataIn,
                            AbsoluteDate upperDataIn,
                            IntervalEndpointType upperEndpointIn)
```
    Builds a new AbsoluteDateInterval.
    
    Parameters:
    
    lowerDataIn - lower end AbsoluteDate
    
    upperDataIn - upper end AbsoluteDate
    
    lowerEndpointIn - lower end boundary type
    
    upperEndpointIn - upper end boundary type
    
    Throws:
    
    MathIllegalArgumentException - when the interval is invalid (unchecked exception).
    In addition to GenericInterval and ComparableInterval checks, the infinite date boundaries also have to be opened.
    
    See Also:
    
    ComparableInterval, GenericInterval, AbsoluteDate
  - AbsoluteDateInterval
```
public AbsoluteDateInterval(ComparableInterval<AbsoluteDate> interval)
```
    Builds a new AbsoluteDateInterval from a ComparableInterval<AbsoluteDate>.
    
    Parameters:
    
    interval - the interval
    
    Throws:
    
    MathIllegalArgumentException - when the interval is invalid (unchecked exception).
    In addition to GenericInterval and ComparableInterval checks, the infinite date boundaries also have to be opened.
    
    See Also:
    
    ComparableInterval, GenericInterval, AbsoluteDate
  - AbsoluteDateInterval
```
public AbsoluteDateInterval(ComparableInterval<Double> interval,
                            AbsoluteDate referenceDate)
```
    Builds a new AbsoluteDateInterval from a ComparableInterval<Double> and a reference AbsoluteDate.
    The bounds of the interval returned are computed by shifting the reference date by the lower and upper data of the interval provided.
    
    Parameters:
    
    interval - the interval
    
    referenceDate - the reference date
    
    Throws:
    
    MathIllegalArgumentException - when the interval is invalid (unchecked exception).
    In addition to GenericInterval and ComparableInterval checks, the infinite date boundaries also have to be opened.
    
    See Also:
    
    ComparableInterval, GenericInterval, AbsoluteDate
- Method Detail
  - getDuration
```
public double getDuration()
```
    Computes the interval duration (its length) in seconds.
    The duration is the number of seconds physically elapsed between the lower and the upper endpoint, as computed by AbsoluteDate.durationFrom().
    This means the duration is measured in a linear time scale (TAI time scale).
    
    Returns:
    
    the interval duration in seconds
    
    See Also:
    
    AbsoluteDate.durationFrom(AbsoluteDate)
  - durationFrom
```
public double durationFrom(AbsoluteDateInterval interval)
```
    Computes the duration in seconds between the two intervals.
    The duration between two intervals is the duration between the end of the earlier interval and the beginning of the later. If the intervals overlap, this duration is 0.
    The sign of the result is positive if the given interval comes earlier.
    
    Parameters:
    
    interval - the given interval
    
    Returns:
    
    the duration in seconds
    
    See Also:
    
    AbsoluteDate.durationFrom(AbsoluteDate)
  - compareDurationTo
```
public int compareDurationTo(AbsoluteDateInterval interval)
```
    Checks if the duration of the interval is longer, shorter or equal to the duration of another interval.
    It returns a positive integer if the duration is longer, a negative integer if the duration is shorter and zero if the durations of the two intervals are identical.
    The method checks also the lower and upper end points of the intervals, considering that an interval with an open end point is shorter than an interval with the same duration and a closed end point.
    
    Parameters:
    
    interval - other interval
    
    Returns:
    
    a negative integer, zero, or a positive integer
  - mergeTo
```
public AbsoluteDateInterval mergeTo(AbsoluteDateInterval interval)
```
    Returns this interval merged with another interval (if they can be merged).
    To be merged, the two intervals must overlap or be connected. If that is not the case, the method returns null.
    
    Parameters:
    
    interval - the interval to be merged
    
    Returns:
    
    the merged interval
  - getIntersectionWith
```
public AbsoluteDateInterval getIntersectionWith(AbsoluteDateInterval interval)
```
    Returns the intersection with another interval.
    If the intervals do not overlap, the method returns null.
    
    Parameters:
    
    interval - the interval to be intersected
    
    Returns:
    
    the interval representing the intersection between the two intervals.
  - shift
```
public AbsoluteDateInterval shift(double shift)
```
    Returns the interval with its lower an upper bounds shifted by the specified value.
    
    Parameters:
    
    shift - the shift applied to the lower and the upper bounds (in seconds)
    
    Returns:
    
    the shifted interval
  - shift
```
public AbsoluteDateInterval shift(double lowerShift,
                                  double upperShift)
```
    Returns the interval with its lower an upper bounds shifted by the specified values.
    
    Parameters:
    
    lowerShift - the shift applied to the lower bound (in seconds)
    
    upperShift - the shift applied to the upper bound (in seconds)
    
    Returns:
    
    the shifted interval
  - scale
```
public AbsoluteDateInterval scale(double scalingFactor)
```
    Returns the interval scaled by a given factor with respect to its midpoint.
    
    Parameters:
    
    scalingFactor - the scaling factor
    
    Returns:
    
    the scaled interval
  - scale
```
public AbsoluteDateInterval scale(double scalingFactor,
                                  AbsoluteDate epoch)
```
    Returns the interval scaled by a given factor with respect to the specified epoch.
    
    Parameters:
    
    scalingFactor - the scaling factor
    
    epoch - the epoch of reference
    
    Returns:
    
    the scaled interval
  - extendTo
```
public AbsoluteDateInterval extendTo(AbsoluteDate epoch)
```
    Returns the interval after extending it so that it includes (closed endpoint) or is connected (open endpoint) to the specified value.
    
    Overrides:
    
    extendTo in class ComparableInterval<AbsoluteDate>
    
    Parameters:
    
    epoch - the target value
    
    Returns:
    
    the extended interval
  - toString
```
public String toString(AbsoluteDate date)
```
    Returns a String representing the durations between the interval's bounds and a specified date.
    
    Parameters:
    
    date - the reference date
    
    Returns:
    
    a String with boundary brackets and values.

Class AbsoluteDateInterval

Constructor Summary

Method Summary

Methods inherited from class fr.cnes.sirius.patrius.math.interval.ComparableInterval

Methods inherited from class fr.cnes.sirius.patrius.math.interval.GenericInterval

Methods inherited from class java.lang.Object

Constructor Detail

AbsoluteDateInterval

AbsoluteDateInterval

AbsoluteDateInterval

AbsoluteDateInterval

Method Detail

getDuration

durationFrom

compareDurationTo

mergeTo

getIntersectionWith

shift

shift

scale

scale

extendTo

toString