agi.foundation.time

(agi.foundation.core-2024r3.jar)

Class TimeInterval1<T>

java.lang.Object

agi.foundation.time.TimeInterval1<T>

Type Parameters:

T - The type of the Data (get) associated with the interval.

All Implemented Interfaces:

IEquatable<TimeInterval1<T>>, IEquatableEpsilon<TimeInterval1<T>>

public final class TimeInterval1<T>
extends Object
implements IEquatable<TimeInterval1<T>>, IEquatableEpsilon<TimeInterval1<T>>

An interval defined by a start date and a stop date. The end points are optionally included in the interval.

Field Summary

Fields

Modifier and Type	Field and Description
static IEqualityComparer	DefaultComparer A comparer for the Data (get) property that considers two Data (get) properties to be equal if Default (get) reports that they are equal.

Constructor Summary

Constructors

Constructor and Description
TimeInterval1(JulianDate start, JulianDate stop) Initializes a new interval with the specified start date and stop date.
TimeInterval1(JulianDate start, JulianDate stop, boolean isStartIncluded, boolean isStopIncluded) Initializes a new interval with the specified start date and stop date, also specifying whether the start and stop dates are included.
TimeInterval1(JulianDate start, JulianDate stop, T data) Initializes a new interval with the specified start date, stop date, and data.
TimeInterval1(JulianDate start, JulianDate stop, T data, boolean isStartIncluded, boolean isStopIncluded) Initializes a new interval with the specified start date, stop date, and data, also specifying whether the start and stop dates are included.

Method Summary

Modifier and Type	Method and Description
TimeIntervalCollection1<T>	add(TimeInterval1<T> other) Adds two intervals together, producing an interval list that includes both intervals.
TimeIntervalCollection1<T>	add(TimeIntervalCollection1<T> intervalList) Adds an interval list to this interval, producing a new interval list that includes this interval plus all intervals in the input list.
<TNew> TimeInterval1<TNew>	changeData(TNew newData) Creates a new interval that is identical to this time interval, except that it has a different value for the Data (get) property.
boolean	contains(JulianDate date) Determines if the interval contains a specified date.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equals(TimeInterval1<T> other, IEqualityComparer<T> dataComparer) Indicates whether another instance of this type is exactly equal to this instance.
static <T> boolean	equals(TimeInterval1<T> left, TimeInterval1<T> right) Returns true if the two instances are exactly equal.
boolean	equalsEpsilon(TimeInterval1<T> other, double epsilon) Determines if this time interval is equal to another time interval, using an epsilon to compare the Start (get) and Stop (get) properties of the two intervals.
boolean	equalsEpsilon(TimeInterval1<T> other, double epsilon, IEqualityComparer<T> dataComparer) Determines if this time interval is equal to another time interval, using an epsilon to compare the Start (get) and Stop (get) properties of the two intervals.
boolean	equalsType(TimeInterval1<T> other) Indicates whether another instance of this type is exactly equal to this instance.
static <T> MergeTimeIntervalDataCallback<T>	getAcceptLeft() Gets a MergeTimeIntervalDataCallback that simply accepts the data on the left-hand side.
static <T> MergeTimeIntervalDataCallback<T>	getAcceptRight() Gets a MergeTimeIntervalDataCallback that simply accepts the data on the right-hand side.
T	getData() Gets the user-defined data associated with this interval.
static <T> TimeInterval1<T>	getEmpty() Gets an empty interval.
int	getHashCode(IEqualityComparer<T> dataComparer) Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
boolean	getIsEmpty() Gets a value indicating whether the interval is empty.
boolean	getIsStartIncluded() Gets a value indicating whether the Start (get) date is included in the interval.
boolean	getIsStopIncluded() Gets a value indicating whether the Stop (get) date is included in the interval.
JulianDate	getStart() Gets the start date of the interval.
JulianDate	getStop() Gets the stop date of the interval.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
TimeInterval1<T>	intersect(TimeInterval other) Computes an interval which is the intersection of this interval with another, with the data from this one.
TimeInterval1<T>	intersect(TimeInterval1<T> other) Computes an interval which is the intersection of this interval with another.
TimeInterval1<T>	intersect(TimeInterval1<T> other, IEqualityComparer<T> dataComparer) Computes an interval which is the intersection of this interval with another.
TimeInterval1<T>	intersectMergingData(TimeInterval1<T> other, MergeTimeIntervalDataCallback<T> mergeCallback) Computes an interval which is the intersection of this interval with another while also providing a means to merge the data of the two intervals.
static <T> boolean	notEquals(TimeInterval1<T> left, TimeInterval1<T> right) Returns true if the two instances are not exactly equal.
TimeInterval	removeData() Creates a new interval that is identical to this one except that it does not have a Data (get) property.
Duration	toDuration() Returns a Duration representing the span of time between the Start (get) and Stop (get) of the interval.
String	toString() Returns a string with interval in the format "[Start, Stop) - Data".
TimeInterval1<T>	toTimeStandard(TimeStandard timeStandard) Returns a TimeInterval1 equivalent to this one where the time standard of the start and end dates has been converted to the specified standard.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DefaultComparer

@Nonnull
public static final IEqualityComparer DefaultComparer

A comparer for the Data (get) property that considers two Data (get) properties to be equal if Default (get) reports that they are equal.

Constructor Detail

TimeInterval1

public TimeInterval1(@Nonnull
                     JulianDate start,
                     @Nonnull
                     JulianDate stop)

Initializes a new interval with the specified start date and stop date. The new interval is closed, meaning that both end points are included.

Parameters:

start - The first date in the interval.

stop - The last date in the interval.

TimeInterval1

public TimeInterval1(@Nonnull
                     JulianDate start,
                     @Nonnull
                     JulianDate stop,
                     T data)

Initializes a new interval with the specified start date, stop date, and data. The new interval is closed, meaning that both end points are included.

Parameters:

start - The first date in the interval.

stop - The last date in the interval.

data - The user-defined data associated with this interval.

TimeInterval1

public TimeInterval1(@Nonnull
                     JulianDate start,
                     @Nonnull
                     JulianDate stop,
                     boolean isStartIncluded,
                     boolean isStopIncluded)

Initializes a new interval with the specified start date and stop date, also specifying whether the start and stop dates are included.

Parameters:

start - The date that starts the interval.

stop - The date that stops the interval.

isStartIncluded - true if the start date is included in the interval.

isStopIncluded - true if the stop date is included in the interval.

TimeInterval1

public TimeInterval1(@Nonnull
                     JulianDate start,
                     @Nonnull
                     JulianDate stop,
                     T data,
                     boolean isStartIncluded,
                     boolean isStopIncluded)

Initializes a new interval with the specified start date, stop date, and data, also specifying whether the start and stop dates are included.

Parameters:

start - The date that starts the interval.

stop - The date that stops the interval.

data - The user-defined data associated with this interval.

isStartIncluded - true if the start date is included in the interval.

isStopIncluded - true if the stop date is included in the interval.

Method Detail

getStart

@Nonnull
public final JulianDate getStart()

Gets the start date of the interval.

getStop

@Nonnull
public final JulianDate getStop()

Gets the stop date of the interval.

getIsStartIncluded

public final boolean getIsStartIncluded()

Gets a value indicating whether the Start (get) date is included in the interval.

getIsStopIncluded

public final boolean getIsStopIncluded()

Gets a value indicating whether the Stop (get) date is included in the interval.

getData

public final T getData()

Gets the user-defined data associated with this interval.

getIsEmpty

public final boolean getIsEmpty()

Gets a value indicating whether the interval is empty. Emptiness is defined as either the stop time comes before the start time, or the interval represents zero duration with exclusive endpoints. To determine if the amount of time contained in an interval is zero, convert to a duration using TimeInterval1.toDuration() and check for equality with Zero (get).

toDuration

@Nonnull
public final Duration toDuration()

Returns a Duration representing the span of time between the Start (get) and Stop (get) of the interval.

Returns:

The duration.

toTimeStandard

@Nonnull
public final TimeInterval1<T> toTimeStandard(TimeStandard timeStandard)

Returns a TimeInterval1 equivalent to this one where the time standard of the start and end dates has been converted to the specified standard.

Parameters:

timeStandard - The time standard of the new interval.

Returns:

An equivalent interval with the new time standard.

intersect

@Nonnull
public final TimeInterval1<T> intersect(@Nullable
                                                  TimeInterval1<T> other)

Computes an interval which is the intersection of this interval with another.

TimeInterval1.DefaultComparer is used to compare the Data (get) properties of this interval and the other interval. If the comparer reports that the Data (get) properties are not equal, the intersection is an empty interval. If the comparer reports that the Data (get) properties are equal, the new interval representing the intersection will have the same value for its Data (get) property as the interval on which this method is called.

Parameters:

other - The interval to intersect with this interval.

Returns:

The intersection of the two intervals.

intersect

@Nonnull
public final TimeInterval1<T> intersect(@Nullable
                                                  TimeInterval1<T> other,
                                                  @Nonnull
                                                  IEqualityComparer<T> dataComparer)

Computes an interval which is the intersection of this interval with another.

dataComparer is used to compare the Data (get) properties of this interval and the other interval. If the comparer reports that the Data (get) properties are not equal, the intersection is an empty interval. If the comparer reports that the Data (get) properties are equal, the new interval representing the intersection will have the same value for its Data (get) property as the interval on which this method is called.

Parameters:

other - The interval to intersect with this interval.

dataComparer - The object to use to compare the Data (get) properties of the two intervals.

Returns:

The intersection of the two intervals.

intersect

@Nonnull
public final TimeInterval1<T> intersect(@Nonnull
                                                  TimeInterval other)

Computes an interval which is the intersection of this interval with another, with the data from this one.

Parameters:

other - The interval to intersect with this interval.

Returns:

The intersection of the two intervals, with the data from this one.

intersectMergingData

@Nonnull
public final TimeInterval1<T> intersectMergingData(@Nullable
                                                             TimeInterval1<T> other,
                                                             @Nullable
                                                             MergeTimeIntervalDataCallback<T> mergeCallback)

Computes an interval which is the intersection of this interval with another while also providing a means to merge the data of the two intervals.

Parameters:

other - The interval to intersect with this interval.

mergeCallback - A callback to use to 'merge' the data on the two intervals, or null. If this interval intersects with the other one, the two data instances will be merged with this callback to create the data on the resulting interval. If the callback is null, this will intersect the two intervals and return the new interval with the data from 'this' interval.

Returns:

The intersection of the two intervals, with its data representing the merge of the data in the two existing intervals.

add

@Nonnull
public final TimeIntervalCollection1<T> add(@Nullable
                                                      TimeInterval1<T> other)

Adds two intervals together, producing an interval list that includes both intervals.

Parameters:

other - The interval to add.

Returns:

A collection that contains both intervals.

add

@Nonnull
public final TimeIntervalCollection1<T> add(@Nullable
                                                      TimeIntervalCollection1<T> intervalList)

Adds an interval list to this interval, producing a new interval list that includes this interval plus all intervals in the input list. The input list is not changed by this method.

Parameters:

intervalList - The interval list to add.

Returns:

A new interval list.

contains

public final boolean contains(@Nonnull
                              JulianDate date)

Determines if the interval contains a specified date.

Parameters:

date - The date to test.

Returns:

true if the interval contains the date; otherwise false.

changeData

@Nonnull
public final <TNew> TimeInterval1<TNew> changeData(TNew newData)

Creates a new interval that is identical to this time interval, except that it has a different value for the Data (get) property.

Type Parameters:

TNew - The type of the new data.

Parameters:

newData - The new value for the Data (get) property.

Returns:

An equivalent interval with new data.

removeData

@Nonnull
public final TimeInterval removeData()

Creates a new interval that is identical to this one except that it does not have a Data (get) property.

Returns:

An equivalent interval without data.

equalsEpsilon

public final boolean equalsEpsilon(TimeInterval1<T> other,
                                   double epsilon)

Determines if this time interval is equal to another time interval, using an epsilon to compare the Start (get) and Stop (get) properties of the two intervals. The dates are considered equal if they are within epsilon seconds of each other. All other properties must be identical.

Specified by:

equalsEpsilon in interface IEquatableEpsilon<TimeInterval1<T>>

Parameters:

other - The time interval to compare to this time interval.

epsilon - The largest difference between the Start (get) and Stop (get) dates, in seconds, such that they will be considered equal.

Returns:

true if the Start (get) and Stop (get) dates of the intervals are equal as defined by the epsilon value and all other properties are identical.

equalsEpsilon

public final boolean equalsEpsilon(TimeInterval1<T> other,
                                   double epsilon,
                                   @Nonnull
                                   IEqualityComparer<T> dataComparer)

Determines if this time interval is equal to another time interval, using an epsilon to compare the Start (get) and Stop (get) properties of the two intervals. The dates are considered equal if they are within epsilon seconds of each other. All other properties must be identical.

Parameters:

other - The time interval to compare to this time interval.

epsilon - The largest difference between the Start (get) and Stop (get) dates, in seconds, such that they will be considered equal.

dataComparer - The object to use to compare the Data (get) properties of the two intervals.

Returns:

true if the Start (get) and Stop (get) dates of the intervals are equal as defined by the epsilon value and all other properties are identical.

equalsType

public final boolean equalsType(TimeInterval1<T> other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<TimeInterval1<T>>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public final boolean equals(TimeInterval1<T> other,
                            @Nonnull
                            IEqualityComparer<T> dataComparer)

Indicates whether another instance of this type is exactly equal to this instance.

Parameters:

other - The instance to compare to this instance.

dataComparer - The object to use to compare the Data (get) properties of the two intervals.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

toString

public String toString()

Returns a string with interval in the format "[Start, Stop) - Data". Square brackets indicate that the end point of the interval is included in the intervals. Parenthesis indicate that the end point is not included.

Overrides:

toString in class Object

Returns:

The string.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

getHashCode

public final int getHashCode(@Nonnull
                             IEqualityComparer<T> dataComparer)

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Parameters:

dataComparer - The object to use to retrieve the hash code for the Data (get) property of the interval.

Returns:

A hash code for the current object.

equals

public static <T> boolean equals(TimeInterval1<T> left,
                                 TimeInterval1<T> right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static <T> boolean notEquals(TimeInterval1<T> left,
                                    TimeInterval1<T> right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

getAcceptLeft

@Nonnull
public static <T> MergeTimeIntervalDataCallback<T> getAcceptLeft()

Gets a MergeTimeIntervalDataCallback that simply accepts the data on the left-hand side.

getAcceptRight

@Nonnull
public static <T> MergeTimeIntervalDataCallback<T> getAcceptRight()

Gets a MergeTimeIntervalDataCallback that simply accepts the data on the right-hand side.

getEmpty

@Nonnull
public static <T> TimeInterval1<T> getEmpty()

Gets an empty interval.