Class TreeRangeSet<C extends java.lang.Comparable<?>>
- java.lang.Object
-
- com.google.common.collect.TreeRangeSet<C>
-
- All Implemented Interfaces:
RangeSet<C>
,java.io.Serializable
@GwtIncompatible public class TreeRangeSet<C extends java.lang.Comparable<?>> extends java.lang.Object implements java.io.Serializable
An implementation ofRangeSet
backed by aTreeMap
.- Since:
- 14.0
- Author:
- Louis Wasserman
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(Range<C> rangeToAdd)
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).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
.static <C extends java.lang.Comparable<?>>
TreeRangeSet<C>create()
Creates an emptyTreeRangeSet
instance.static <C extends java.lang.Comparable<?>>
TreeRangeSet<C>create(RangeSet<C> rangeSet)
Returns aTreeRangeSet
initialized with the ranges in the specified range set.static <C extends java.lang.Comparable<?>>
TreeRangeSet<C>create(java.lang.Iterable<Range<C>> ranges)
Returns aTreeRangeSet
representing the union of the specified ranges.boolean
encloses(Range<C> range)
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
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> range)
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> rangeToRemove)
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).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.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.collect.RangeSet
addAll, enclosesAll, removeAll
-
-
-
-
Method Detail
-
create
public static <C extends java.lang.Comparable<?>> TreeRangeSet<C> create()
Creates an emptyTreeRangeSet
instance.
-
create
public static <C extends java.lang.Comparable<?>> TreeRangeSet<C> create(RangeSet<C> rangeSet)
Returns aTreeRangeSet
initialized with the ranges in the specified range set.
-
create
public static <C extends java.lang.Comparable<?>> TreeRangeSet<C> create(java.lang.Iterable<Range<C>> ranges)
Returns aTreeRangeSet
representing the union of the specified ranges.This is the smallest
RangeSet
which encloses each of the specified ranges. An element will be contained in thisRangeSet
if and only if it is contained in at least oneRange
inranges
.- Since:
- 21.0
-
asRanges
public java.util.Set<Range<C>> asRanges()
Description copied from interface:RangeSet
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
public java.util.Set<Range<C>> asDescendingSetOfRanges()
Description copied from interface:RangeSet
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).- Specified by:
asDescendingSetOfRanges
in interfaceRangeSet<C extends java.lang.Comparable<?>>
-
rangeContaining
@CheckForNull public Range<C> rangeContaining(C value)
Description copied from interface:RangeSet
Returns the unique range from this range set that containsvalue
, ornull
if this range set does not containvalue
.- Specified by:
rangeContaining
in interfaceRangeSet<C extends java.lang.Comparable<?>>
-
intersects
public boolean intersects(Range<C> range)
Description copied from interface:RangeSet
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.- Specified by:
intersects
in interfaceRangeSet<C extends java.lang.Comparable<?>>
-
encloses
public boolean encloses(Range<C> range)
Description copied from interface:RangeSet
Returnstrue
if there exists a member range in this range set which encloses the specified range.
-
span
public Range<C> span()
Description copied from interface:RangeSet
Returns the minimal range which encloses all ranges in this range set.
-
add
public void add(Range<C> rangeToAdd)
Description copied from interface:RangeSet
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.
-
remove
public void remove(Range<C> rangeToRemove)
Description copied from interface:RangeSet
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.
-
complement
public RangeSet<C> complement()
Description copied from interface:RangeSet
Returns a view of the complement of thisRangeSet
.The returned view supports the
RangeSet.add(com.google.common.collect.Range<C>)
operation if thisRangeSet
supportsRangeSet.remove(com.google.common.collect.Range<C>)
, and vice versa.- Specified by:
complement
in interfaceRangeSet<C extends java.lang.Comparable<?>>
-
subRangeSet
public RangeSet<C> subRangeSet(Range<C> view)
Description copied from interface:RangeSet
Returns a view of the intersection of thisRangeSet
with the specified range.The returned view supports all optional operations supported by this
RangeSet
, with the caveat that anIllegalArgumentException
is thrown on an attempt to add any range not enclosed byview
.- Specified by:
subRangeSet
in interfaceRangeSet<C extends java.lang.Comparable<?>>
-
contains
public boolean contains(C value)
Description copied from interface:RangeSet
Determines whether any of this range set's member ranges containsvalue
.
-
isEmpty
public boolean isEmpty()
Description copied from interface:RangeSet
Returnstrue
if this range set contains no ranges.
-
clear
public void clear()
Description copied from interface:RangeSet
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())
.
-
enclosesAll
public boolean enclosesAll(RangeSet<C> other)
Description copied from interface:RangeSet
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
RangeSet.encloses(com.google.common.collect.Range<C>)
each of the ranges inother
.- Specified by:
enclosesAll
in interfaceRangeSet<C extends java.lang.Comparable>
-
addAll
public void addAll(RangeSet<C> other)
Description copied from interface:RangeSet
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
RangeSet.add(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.
-
removeAll
public void removeAll(RangeSet<C> other)
Description copied from interface:RangeSet
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
RangeSet.remove(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.
-
equals
public boolean equals(@CheckForNull java.lang.Object obj)
Description copied from interface:RangeSet
Returnstrue
ifobj
is anotherRangeSet
that contains the same ranges according toRange.equals(Object)
.
-
hashCode
public final int hashCode()
Description copied from interface:RangeSet
ReturnsasRanges().hashCode()
.
-
toString
public final java.lang.String toString()
Description copied from interface:RangeSet
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..+∞)
"}.
-
-