fr.cnes.sirius.patrius.time

Class AbsoluteDateIntervalsList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.TreeSet<AbsoluteDateInterval>

fr.cnes.sirius.patrius.time.AbsoluteDateIntervalsList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AbsoluteDateInterval>, Collection<AbsoluteDateInterval>, NavigableSet<AbsoluteDateInterval>, Set<AbsoluteDateInterval>, SortedSet<AbsoluteDateInterval>

public class AbsoluteDateIntervalsList
extends TreeSet<AbsoluteDateInterval>

This class represents a list of objects AbsoluteDateInterval.
It extends a TreeSet of AbsoluteDateInterval instances ; as the AbsoluteDateInterval objects implement the ComparableInterval class, the list is an ordered collection of time intervals.

Since:

1.1

Version:

$Id: AbsoluteDateIntervalsList.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Tiziana Sabatini

See Also:

AbsoluteDateInterval, TreeSet, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

thread safety is not required for this class. And, TreeSet is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
AbsoluteDateIntervalsList()

Method Summary

Modifier and Type	Method and Description
AbsoluteDateIntervalsList	getComplementaryIntervals() Gets the list of complementary intervals of the given list of intervals.
AbsoluteDateInterval	getInclusiveInterval() Gets the shortest interval containing all the intervals belonging to the list.
AbsoluteDateIntervalsList	getIntersectionWith(AbsoluteDateInterval interval) Returns the intersection between an interval and all the intervals of the list.
AbsoluteDateIntervalsList	getIntervalsContainingDate(AbsoluteDate date) Gets the AbsoluteDateIntervalsList containing the specified date.
AbsoluteDateIntervalsList	getMergedIntervals() Merges the intervals of the list that overlap and returns the list of merged intervals.
boolean	includes(AbsoluteDateInterval interval) Returns true if the provided interval is included in one of the intervals of the list.
boolean	overlaps(AbsoluteDateInterval interval) Returns true if the provided interval overlaps one of the intervals of the list.

Methods inherited from class java.util.TreeSet

add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbsoluteDateIntervalsList

public AbsoluteDateIntervalsList()

Method Detail

getIntervalsContainingDate

public AbsoluteDateIntervalsList getIntervalsContainingDate(AbsoluteDate date)

Gets the AbsoluteDateIntervalsList containing the specified date. The list can contain zero, one or more AbsoluteDateInterval.

Parameters:

date - the date included in the time intervals

Returns:

a list of time intervals containing the input date.

getInclusiveInterval

public AbsoluteDateInterval getInclusiveInterval()

Gets the shortest interval containing all the intervals belonging to the list.
While a date included in at least one of the listed intervals must be contained in this global interval, the opposite is not guaranteed (the inclusive interval can contain dates that do not belong to any listed interval).

Returns:

an AbsoluteDateInterval including all the intervals of the list

getMergedIntervals

public AbsoluteDateIntervalsList getMergedIntervals()

Merges the intervals of the list that overlap and returns the list of merged intervals.

The list returned should not contain any overlapping intervals.

Returns:

the list of merged intervals

getIntersectionWith

public AbsoluteDateIntervalsList getIntersectionWith(AbsoluteDateInterval interval)

Returns the intersection between an interval and all the intervals of the list.

The list returned can be empty if the provided interval does not intersects any interval of the list.

Parameters:

interval - the interval

Returns:

the intersection between the interval and the list of intervals

getComplementaryIntervals

public AbsoluteDateIntervalsList getComplementaryIntervals()

Gets the list of complementary intervals of the given list of intervals.

Returns:

an AbsoluteDateIntervalsList including all the complementary intervals

overlaps

public boolean overlaps(AbsoluteDateInterval interval)

Returns true if the provided interval overlaps one of the intervals of the list.

Parameters:

interval - the interval

Returns:

true if the interval overlaps one of the interval of the list

includes

public boolean includes(AbsoluteDateInterval interval)

Returns true if the provided interval is included in one of the intervals of the list.

Parameters:

interval - the interval

Returns:

true if the interval is included in one of the intervals of the list