com.bol.ipresource.ip

Interface Interval<K>

Type Parameters:

K - the interval type

All Known Implementing Classes:

IpInterval, Ipv4Interval, Ipv6Interval

public interface Interval<K>

An interval with a lower-bound and upper-bound. Both bounds are considered to be inclusive.

Implementations of this interface must be immutable and must correctly override Object.equals(Object) and Object.hashCode() based on the bounds.

Method Summary

Modifier and Type	Method and Description
int	compareUpperBound(K that) Compare two intervals based on their upper-bounds.
boolean	contains(K that) Tests if this interval contains that.
boolean	intersects(K that) Tests if these two intervals intersect.
K	singletonIntervalAtLowerBound() Copies this interval into a new interval that has both its lower and upper-bound set to the original's lower-bound.

Method Detail

contains

boolean contains(K that)

Tests if this interval contains that. Note that if two intervals are equal, they also contain each other (and vice versa). An interval always contains itself.

Parameters:

that - the interval to test for containment

Returns:

true if this contains that interval

intersects

boolean intersects(K that)

Tests if these two intervals intersect. Two intervals intersect if there exists a point which is contained within both intervals. An interval always intersects itself.

Parameters:

that - the other interval to test for intersection

Returns:

true if this interval intersects that interval

singletonIntervalAtLowerBound

K singletonIntervalAtLowerBound()

Copies this interval into a new interval that has both its lower and upper-bound set to the original's lower-bound. This is used to be able to compare an interval's lower-bound with another interval's upper-bound.

   Interval a = ...
   Interval b = ...
   if (a.singletonIntervalAtLowerBound().compareUpperBoundTo(b) < 0) ...
 

Returns:

a new interval that has both its lower- and upper-bound set to this interval's lower-bound

compareUpperBound

int compareUpperBound(K that)

Compare two intervals based on their upper-bounds. This is used by the NestedIntervalMap implementation to quickly find two potentially intersecting intervals by ordering intervals on the upper-bound and searching based on the lower-bound.

Parameters:

that - the interval to compare the upper-bound with

Returns:

<0 if this upper-bound is less than that upper-bound,
=0 if this upper-bound equals that upper-bound,
>0 if this upper-bound is greater than that upper-bound