com.aimpulse.base

Class Interval<T extends Comparable<T>>

java.lang.Object

com.aimpulse.base.Interval<T>

Direct Known Subclasses:

Timespan

public class Interval<T extends Comparable<T>>
extends Object

An interval of comparable objects. The begin is included in the set of objects represented by an interval, the end is not.

Since:

1.0.0

Author:

Aimpulse

See Also:

Intervals

Constructor Summary

Constructors

Constructor and Description
Interval(T begin, T end) Instantiates this interval.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(Interval<T> other) Checks whether another interval is contained in the interval, i.e., whether all members of the other interval are also contained in the interval.
boolean	contains(T object) Checks whether an object is contained in the interval.
boolean	equals(Object object)
T	getBegin() Returns the begin of this interval.
T	getEnd() Returns the end of this interval.
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Interval

public Interval(T begin,
        T end)

Instantiates this interval.

Parameters:

begin - the begin

end - the end

Throws:

NullPointerException - if the begin is null

NullPointerException - if the end is null

IllegalArgumentException - if the begin does not precede the end

Method Detail

getBegin

public T getBegin()

Returns the begin of this interval.

Returns:

the begin of this interval

getEnd

public T getEnd()

Returns the end of this interval.

Returns:

the end of this interval

contains

public boolean contains(T object)

Checks whether an object is contained in the interval.

Parameters:

object - the object to be checked.

Returns:

true if the object is contained, false otherwise

contains

public boolean contains(Interval<T> other)

Checks whether another interval is contained in the interval, i.e., whether all members of the other interval are also contained in the interval.

Parameters:

other - the other interval to be checked

Returns:

true if the other interval is contained, false otherwise

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object