Top Description Methods
com.google.common.collect

public Interface RangeSet<C extends Comparable<T>>

Known Direct Implementers
com.google.common.collect.AbstractRangeSet
Annotations
@SuppressWarnings:rawtypes
@DoNotMock:Use ImmutableRangeSet or TreeRangeSet
@GwtIncompatible
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtIncompatible, com.google.errorprone.annotations.DoNotMock, java.util.NoSuchElementException, .Set, javax.annotation.CheckForNull
A set comprising zero or more nonempty, disconnected ranges of type C.

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() and Range#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 a Range, see ContiguousSet.

See the Guava User Guide article on RangeSets.

Authors
Kevin Bourrillion, Louis Wasserman
Since
14.0

Method Summary

Modifier and TypeMethod and Description
public void
add(Range<C> range)

Adds the specified range to this RangeSet (optional operation).

public void
addAll(RangeSet<C> other)

Adds all of the ranges from the specified range set to this range set (optional operation).

public default void
addAll(Iterable<Range<C>> ranges)

Adds all of the specified ranges to this range set (optional operation).

public Set<Range<C>>
asDescendingSetOfRanges()

Returns a descending view of the disconnected ranges that make up this range set.

public Set<Range<C>>
asRanges()

Returns a view of the disconnected ranges that make up this range set.

public void
clear()

Removes all ranges from this RangeSet (optional operation).

public RangeSet<C>
complement()

Returns a view of the complement of this RangeSet.

public boolean
contains(C value)

Determines whether any of this range set's member ranges contains value.

public boolean
encloses(Range<C> otherRange)

Returns true if there exists a member range in this range set which encloses the specified range.

public boolean
enclosesAll(RangeSet<C> other)

Returns true if for each member range in other there exists a member range in this range set which encloses it.

public default boolean
enclosesAll(Iterable<Range<C>> other)

Returns true if for each range in other there exists a member range in this range set which encloses it.

public boolean
equals(Object obj)

Returns true if obj is another RangeSet that contains the same ranges according to Range#equals(Object).

public int
hashCode()

Returns asRanges().hashCode().

public boolean
intersects(Range<C> otherRange)

Returns true if there exists a non-empty range enclosed by both a member range in this range set and the specified range.

public boolean
isEmpty()

Returns true if this range set contains no ranges.

public Range<C>
rangeContaining(C value)

Returns the unique range from this range set that contains value, or null if this range set does not contain value.

public void
remove(Range<C> range)

Removes the specified range from this RangeSet (optional operation).

public void
removeAll(RangeSet<C> other)

Removes all of the ranges from the specified range set from this range set (optional operation).

public default void
removeAll(Iterable<Range<C>> ranges)

Removes all of the specified ranges from this range set (optional operation).

public Range<C>
span()

Returns the minimal range which encloses all ranges in this range set.

public RangeSet<C>
subRangeSet(Range<C> view)

Returns a view of the intersection of this RangeSet with the specified range.

public String
toString()

Returns a readable string representation of this range set.

Method Detail

addback to summary
public void add(Range<C> range)

Adds the specified range to this RangeSet (optional operation). That is, for equal range sets a and b, the result of a.add(range) is that a will be the minimal range set for which both a.enclosesAll(b) and a.encloses(range).

Note that range will be coalesced with any ranges in the range set that are connected with it. Moreover, if range is empty, this is a no-op.

Exceptions
UnsupportedOperationException:
if this range set does not support the add operation
addAllback to summary
public 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 and other.

This is equivalent to calling add on each of the ranges in other in turn.

Exceptions
UnsupportedOperationException:
if this range set does not support the addAll operation
addAllback to summary
public default void addAll(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 in other.

This is equivalent to calling add on each of the ranges in other in turn.

Exceptions
UnsupportedOperationException:
if this range set does not support the addAll operation
Since
21.0
asDescendingSetOfRangesback to summary
public 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 its Iterable#iterator method return the ranges in decreasing order of lower bound (equivalently, of upper bound).

Since
19.0
asRangesback to summary
public 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 its Iterable#iterator method return the ranges in increasing order of lower bound (equivalently, of upper bound).

clearback to summary
public void clear()

Removes all ranges from this RangeSet (optional operation). After this operation, this.contains(c) will return false for all c.

This is equivalent to remove(Range.all()).

Exceptions
UnsupportedOperationException:
if this range set does not support the clear operation
complementback to summary
public RangeSet<C> complement()

Returns a view of the complement of this RangeSet.

The returned view supports the add operation if this RangeSet supports remove, and vice versa.

containsback to summary
public boolean contains(C value)

Determines whether any of this range set's member ranges contains value.

enclosesback to summary
public boolean encloses(Range<C> otherRange)

Returns true if there exists a member range in this range set which encloses the specified range.

enclosesAllback to summary
public boolean enclosesAll(RangeSet<C> other)

Returns true if for each member range in other there exists a member range in this range set which encloses it. It follows that this.contains(value) whenever other.contains(value). Returns true if other is empty.

This is equivalent to checking if this range set encloses each of the ranges in other.

enclosesAllback to summary
public default boolean enclosesAll(Iterable<Range<C>> other)

Returns true if for each range in other there exists a member range in this range set which encloses it. Returns true if other is empty.

This is equivalent to checking if this range set encloses each range in other.

Since
21.0
equalsback to summary
public boolean equals(Object obj)

Returns true if obj is another RangeSet that contains the same ranges according to Range#equals(Object).

Annotations
@Override
hashCodeback to summary
public int hashCode()

Returns asRanges().hashCode().

Annotations
@Override
intersectsback to summary
public boolean intersects(Range<C> otherRange)

Returns true 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 calling subRangeSet(otherRange) and testing whether the resulting range set is non-empty.

Since
20.0
isEmptyback to summary
public boolean isEmpty()

Returns true if this range set contains no ranges.

rangeContainingback to summary
public Range<C> rangeContaining(C value)

Returns the unique range from this range set that contains value, or null if this range set does not contain value.

Annotations
@CheckForNull
removeback to summary
public void remove(Range<C> range)

Removes the specified range from this RangeSet (optional operation). After this operation, if range.contains(c), this.contains(c) will return false.

If range is empty, this is a no-op.

Exceptions
UnsupportedOperationException:
if this range set does not support the remove operation
removeAllback to summary
public void removeAll(RangeSet<C> other)

Removes all of the ranges from the specified range set from this range set (optional operation). After this operation, if other.contains(c), this.contains(c) will return false.

This is equivalent to calling remove on each of the ranges in other in turn.

Exceptions
UnsupportedOperationException:
if this range set does not support the removeAll operation
removeAllback to summary
public default void removeAll(Iterable<Range<C>> ranges)

Removes all of the specified ranges from this range set (optional operation).

This is equivalent to calling remove on each of the ranges in other in turn.

Exceptions
UnsupportedOperationException:
if this range set does not support the removeAll operation
Since
21.0
spanback to summary
public Range<C> span()

Returns the minimal range which encloses all ranges in this range set.

Exceptions
NoSuchElementException:
if this range set is empty
subRangeSetback to summary
public RangeSet<C> subRangeSet(Range<C> view)

Returns a view of the intersection of this RangeSet with the specified range.

The returned view supports all optional operations supported by this RangeSet, with the caveat that an IllegalArgumentException is thrown on an attempt to add any range not enclosed by view.

toStringback to summary
public String toString()

Returns a readable string representation of this range set. For example, if this RangeSet consisted of Range.closed(1, 3) and Range.greaterThan(4), this might return " [1..3](4..+∞)"}.

Annotations
@Override