com.lodborg.intervaltree

Class DateInterval

java.lang.Object

com.lodborg.intervaltree.Interval<Date>

com.lodborg.intervaltree.DateInterval

public class DateInterval
extends Interval<Date>

A class representing an interval with Dates as start and end points.

Nested Class Summary

Nested classes/interfaces inherited from class com.lodborg.intervaltree.Interval

Interval.Bounded, Interval.Builder, Interval.Unbounded

Field Summary

Fields inherited from class com.lodborg.intervaltree.Interval

sweepLeftToRight, sweepRightToLeft

Constructor Summary

Constructors

Constructor and Description
DateInterval() Instantiates an interval extending from positive infinity to negative infinity and thus containing all Dates.
DateInterval(Date start, Date end, Interval.Bounded type) Instantiates a new bounded interval.
DateInterval(Date value, Interval.Unbounded type) Instantiates a new unbounded interval - an interval that extends to positive or negative infinity.

Method Summary

Modifier and Type	Method and Description
protected Interval<Date>	create() Used to create new instances of a specific Interval subclass.
Date	getMidpoint() Determines the center of the interval.

Methods inherited from class com.lodborg.intervaltree.Interval

builder, compareSpecialization, contains, contains, create, equals, getEnd, getIntersection, getStart, hashCode, intersects, isEmpty, isEndInclusive, isLeftOf, isLeftOf, isLeftOf, isPoint, isRightOf, isRightOf, isRightOf, isStartInclusive

Methods inherited from class java.lang.Object

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

Constructor Detail

DateInterval

public DateInterval()

Instantiates an interval extending from positive infinity to negative infinity and thus containing all Dates.

DateInterval

public DateInterval(Date start,
                    Date end,
                    Interval.Bounded type)

Instantiates a new bounded interval.

Parameters:

start - The start date of the interval

end - The end date of the interval.

type - Description of whether the interval is open/closed at one or both of its ends. See the documentation of the Bounded enum for more information on the different possibilities.

DateInterval

public DateInterval(Date value,
                    Interval.Unbounded type)

Instantiates a new unbounded interval - an interval that extends to positive or negative infinity. The interval will be bounded by either the start point or the end point and unbounded in the other point.

Parameters:

value - The bounding date for either the start or the end point.

type - Describes whether the interval extends to positive or negative infinity, as well as if it is open or closed at the bounding point. See the Unbounded enum for description of the different possibilities.

Method Detail

create

protected Interval<Date> create()

Description copied from class: Interval

Used to create new instances of a specific Interval subclass.

The Interval class aims to avoid reflexion. On several occasions, however, the class needs to create new instances of the Interval class. To be able to guarantee that they will have the desired runtime type, the Interval.create() method of a specific reference object is called.

Generally, the only thing you need to do in your implementation of this abstract method is to call the default constructor of your subclass and return the new interval.

Specified by:

create in class Interval<Date>

Returns:

A new instance of the particular Interval class.

getMidpoint

public Date getMidpoint()

Determines the center of the interval.

Similarly to the class IntegerInterval, it assumes that unbounded intervals are bounded by Dates with timestamps Long.MIN_VALUE and/or Long.MAX_VALUE. The center of an unbounded interval is computed accordingly.

Specified by:

getMidpoint in class Interval<Date>

Returns:

The center of the interval.