agi.foundation.time

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

Class TimeInterval

java.lang.Object

agi.foundation.time.TimeInterval

All Implemented Interfaces:

IEquatable<TimeInterval>, IEquatableEpsilon<TimeInterval>

public final class TimeInterval
extends Object
implements IEquatable<TimeInterval>, IEquatableEpsilon<TimeInterval>

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

Constructor Summary

Constructors

Constructor and Description
TimeInterval(JulianDate start, JulianDate stop) Initializes a new interval with the specified start date and stop date.
TimeInterval(JulianDate start, JulianDate stop, 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
TimeIntervalCollection	add(TimeInterval other) Adds two intervals together, producing an interval list that includes both intervals.
TimeIntervalCollection	add(TimeIntervalCollection intervalList) Adds an interval list to this interval, producing a new interval list that includes this interval plus all intervals in the input list.
<T> TimeInterval1<T>	addData(T data) Creates a TimeInterval1 that is equivalent to this time interval, but with the specified Data (get) value.
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.
static boolean	equals(TimeInterval left, TimeInterval right) Returns true if the two instances are exactly equal.
boolean	equalsEpsilon(TimeInterval 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	equalsType(TimeInterval other) Indicates whether another instance of this type is exactly equal to this instance.
static TimeInterval	getEmpty() Gets an empty interval.
static TimeInterval	getInfinite() Gets an interval that represents the maximum possible span of time.
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.
TimeInterval	intersect(TimeInterval other) Computes an interval which is the intersection of this interval with another.
static boolean	notEquals(TimeInterval left, TimeInterval right) Returns true if the two instances are not exactly equal.
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)".
TimeInterval	toTimeStandard(TimeStandard timeStandard) Returns a TimeInterval 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

Constructor Detail

TimeInterval

public TimeInterval(@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.

TimeInterval

public TimeInterval(@Nonnull
                    JulianDate start,
                    @Nonnull
                    JulianDate stop,
                    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.

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.

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 TimeInterval.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 TimeInterval toTimeStandard(TimeStandard timeStandard)

Returns a TimeInterval 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 TimeInterval intersect(@Nullable
                                              TimeInterval other)

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

Parameters:

other - The interval to intersect with this interval.

Returns:

The intersection of the two intervals.

add

@Nonnull
public final TimeIntervalCollection add(@Nullable
                                                  TimeInterval 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 TimeIntervalCollection add(@Nullable
                                                  TimeIntervalCollection 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.

addData

@Nonnull
public final <T> TimeInterval1<T> addData(T data)

Creates a TimeInterval1 that is equivalent to this time interval, but with the specified Data (get) value.

Type Parameters:

T - The type of the data.

Parameters:

data - The data value.

Returns:

An equivalent interval with the specified data.

equalsEpsilon

public final boolean equalsEpsilon(@Nullable
                                   TimeInterval 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<TimeInterval>

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.

equalsType

public final boolean equalsType(TimeInterval other)

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

Specified by:

equalsType in interface IEquatable<TimeInterval>

Parameters:

other - The instance to compare to this instance.

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)". 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)

equals

public static boolean equals(TimeInterval left,
                             TimeInterval 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 boolean notEquals(TimeInterval left,
                                TimeInterval 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.

getEmpty

@Nonnull
public static TimeInterval getEmpty()

Gets an empty interval.

getInfinite

@Nonnull
public static TimeInterval getInfinite()

Gets an interval that represents the maximum possible span of time.