Interface RangeSet<C extends java.lang.Comparable>
-
- All Known Implementing Classes:
ImmutableRangeSet
,TreeRangeSet
@DoNotMock("Use ImmutableRangeSet or TreeRangeSet") @GwtIncompatible public interface RangeSet<C extends java.lang.Comparable>
A set comprising zero or more nonempty, disconnected ranges of typeC
.Implementations that choose to support the
add(Range)
operation are required to ignore empty ranges and coalesce connected ranges. For example:RangeSet<Integer> rangeSet = TreeRangeSet.create(); rangeSet.add(Range.closed(1, 10)); // {[1, 10]} rangeSet.add(Range.closedOpen(11, 15)); // disconnected range; {[1, 10], [11, 15)} rangeSet.add(Range.closedOpen(15, 20)); // connected range; {[1, 10], [11, 20)} rangeSet.add(Range.openClosed(0, 0)); // empty range; {[1, 10], [11, 20)} rangeSet.remove(Range.open(5, 10)); // splits [1, 10]; {[1, 5], [10, 10], [11, 20)}
Note that the behavior of
Range.isEmpty()
andRange.isConnected(Range)
may not be as expected on discrete ranges. See the Javadoc of those methods for details.For a
Set
whose contents are specified by aRange
, seeContiguousSet
.See the Guava User Guide article on RangeSets.
- Since:
- 14.0
- Author:
- Kevin Bourrillion, Louis Wasserman
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
add(Range<C> range)
Adds the specified range to thisRangeSet
(optional operation).void
addAll(RangeSet<C> other)
Adds all of the ranges from the specified range set to this range set (optional operation).void
addAll(java.lang.Iterable<Range<C>> ranges)
Adds all of the specified ranges to this range set (optional operation).java.util.Set<Range<C>>
asDescendingSetOfRanges()
Returns a descending view of the disconnected ranges that make up this range set.java.util.Set<Range<C>>
asRanges()
Returns a view of the disconnected ranges that make up this range set.void
clear()
Removes all ranges from thisRangeSet
(optional operation).RangeSet<C>
complement()
Returns a view of the complement of thisRangeSet
.boolean
contains(C value)
Determines whether any of this range set's member ranges containsvalue
.boolean
encloses(Range<C> otherRange)
Returnstrue
if there exists a member range in this range set which encloses the specified range.boolean
enclosesAll(RangeSet<C> other)
Returnstrue
if for each member range inother
there exists a member range in this range set which encloses it.boolean
enclosesAll(java.lang.Iterable<Range<C>> other)
Returnstrue
if for each range inother
there exists a member range in this range set which encloses it.boolean
equals(java.lang.Object obj)
Returnstrue
ifobj
is anotherRangeSet
that contains the same ranges according toRange.equals(Object)
.int
hashCode()
ReturnsasRanges().hashCode()
.boolean
intersects(Range<C> otherRange)
Returnstrue
if there exists a non-empty range enclosed by both a member range in this range set and the specified range.boolean
isEmpty()
Returnstrue
if this range set contains no ranges.Range<C>
rangeContaining(C value)
Returns the unique range from this range set that containsvalue
, ornull
if this range set does not containvalue
.void
remove(Range<C> range)
Removes the specified range from thisRangeSet
(optional operation).void
removeAll(RangeSet<C> other)
Removes all of the ranges from the specified range set from this range set (optional operation).void
removeAll(java.lang.Iterable<Range<C>> ranges)
Removes all of the specified ranges from this range set (optional operation).Range<C>
span()
Returns the minimal range which encloses all ranges in this range set.RangeSet<C>
subRangeSet(Range<C> view)
Returns a view of the intersection of thisRangeSet
with the specified range.java.lang.String
toString()
Returns a readable string representation of this range set.
-
-
-
Method Detail
-
contains
boolean contains(C value)
Determines whether any of this range set's member ranges containsvalue
.
-
rangeContaining
@CheckForNull Range<C> rangeContaining(C value)
Returns the unique range from this range set that containsvalue
, ornull
if this range set does not containvalue
.
-
intersects
boolean intersects(Range<C> otherRange)
Returnstrue
if there exists a non-empty range enclosed by both a member range in this range set and the specified range. This is equivalent to callingsubRangeSet(otherRange)
and testing whether the resulting range set is non-empty.- Since:
- 20.0
-
encloses
boolean encloses(Range<C> otherRange)
Returnstrue
if there exists a member range in this range set which encloses the specified range.
-
enclosesAll
boolean enclosesAll(RangeSet<C> other)
Returnstrue
if for each member range inother
there exists a member range in this range set which encloses it. It follows thatthis.contains(value)
wheneverother.contains(value)
. Returnstrue
ifother
is empty.This is equivalent to checking if this range set
encloses(com.google.common.collect.Range<C>)
each of the ranges inother
.
-
enclosesAll
boolean enclosesAll(java.lang.Iterable<Range<C>> other)
Returnstrue
if for each range inother
there exists a member range in this range set which encloses it. Returnstrue
ifother
is empty.This is equivalent to checking if this range set
encloses(com.google.common.collect.Range<C>)
each range inother
.- Since:
- 21.0
-
isEmpty
boolean isEmpty()
Returnstrue
if this range set contains no ranges.
-
span
Range<C> span()
Returns the minimal range which encloses all ranges in this range set.- Throws:
java.util.NoSuchElementException
- if this range set is empty
-
asRanges
java.util.Set<Range<C>> asRanges()
Returns a view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by itsIterable.iterator()
method return the ranges in increasing order of lower bound (equivalently, of upper bound).
-
asDescendingSetOfRanges
java.util.Set<Range<C>> asDescendingSetOfRanges()
Returns a descending view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by itsIterable.iterator()
method return the ranges in decreasing order of lower bound (equivalently, of upper bound).- Since:
- 19.0
-
complement
RangeSet<C> complement()
Returns a view of the complement of thisRangeSet
.The returned view supports the
add(com.google.common.collect.Range<C>)
operation if thisRangeSet
supportsremove(com.google.common.collect.Range<C>)
, and vice versa.
-
subRangeSet
RangeSet<C> subRangeSet(Range<C> view)
-
add
void add(Range<C> range)
Adds the specified range to thisRangeSet
(optional operation). That is, for equal range sets a and b, the result ofa.add(range)
is thata
will be the minimal range set for which botha.enclosesAll(b)
anda.encloses(range)
.Note that
range
will be coalesced with any ranges in the range set that are connected with it. Moreover, ifrange
is empty, this is a no-op.- Throws:
java.lang.UnsupportedOperationException
- if this range set does not support theadd
operation
-
remove
void remove(Range<C> range)
Removes the specified range from thisRangeSet
(optional operation). After this operation, ifrange.contains(c)
,this.contains(c)
will returnfalse
.If
range
is empty, this is a no-op.- Throws:
java.lang.UnsupportedOperationException
- if this range set does not support theremove
operation
-
clear
void clear()
Removes all ranges from thisRangeSet
(optional operation). After this operation,this.contains(c)
will return false for allc
.This is equivalent to
remove(Range.all())
.- Throws:
java.lang.UnsupportedOperationException
- if this range set does not support theclear
operation
-
addAll
void addAll(RangeSet<C> other)
Adds all of the ranges from the specified range set to this range set (optional operation). After this operation, this range set is the minimal range set that encloses both the original range set andother
.This is equivalent to calling
add(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.- Throws:
java.lang.UnsupportedOperationException
- if this range set does not support theaddAll
operation
-
addAll
void addAll(java.lang.Iterable<Range<C>> ranges)
Adds all of the specified ranges to this range set (optional operation). After this operation, this range set is the minimal range set that encloses both the original range set and each range inother
.This is equivalent to calling
add(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.- Throws:
java.lang.UnsupportedOperationException
- if this range set does not support theaddAll
operation- Since:
- 21.0
-
removeAll
void removeAll(RangeSet<C> other)
Removes all of the ranges from the specified range set from this range set (optional operation). After this operation, ifother.contains(c)
,this.contains(c)
will returnfalse
.This is equivalent to calling
remove(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.- Throws:
java.lang.UnsupportedOperationException
- if this range set does not support theremoveAll
operation
-
removeAll
void removeAll(java.lang.Iterable<Range<C>> ranges)
Removes all of the specified ranges from this range set (optional operation).This is equivalent to calling
remove(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.- Throws:
java.lang.UnsupportedOperationException
- if this range set does not support theremoveAll
operation- Since:
- 21.0
-
equals
boolean equals(@CheckForNull java.lang.Object obj)
Returnstrue
ifobj
is anotherRangeSet
that contains the same ranges according toRange.equals(Object)
.- Overrides:
equals
in classjava.lang.Object
-
hashCode
int hashCode()
ReturnsasRanges().hashCode()
.- Overrides:
hashCode
in classjava.lang.Object
-
toString
java.lang.String toString()
Returns a readable string representation of this range set. For example, if thisRangeSet
consisted ofRange.closed(1, 3)
andRange.greaterThan(4)
, this might return" [1..3](4..+∞)
"}.- Overrides:
toString
in classjava.lang.Object
-
-