Class TreeRangeSet<C extends Comparable<?>>
- java.lang.Object
-
- com.google.common.collect.TreeRangeSet<C>
-
- All Implemented Interfaces:
RangeSet<C>
,Serializable
@Beta @GwtIncompatible public class TreeRangeSet<C extends Comparable<?>> extends Object implements Serializable
- 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).Set<Range<C>>
asDescendingSetOfRanges()
Returns a descending view of the disconnected ranges that make up this range set.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 Comparable<?>>
TreeRangeSet<C>create()
Creates an emptyTreeRangeSet
instance.static <C extends Comparable<?>>
TreeRangeSet<C>create(RangeSet<C> rangeSet)
Returns aTreeRangeSet
initialized with the ranges in the specified range set.static <C extends Comparable<?>>
TreeRangeSet<C>create(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(Object obj)
Indicates whether some other object is "equal to" this one.int
hashCode()
Returns a hash code value for the object.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.String
toString()
Returns a string representation of the object.-
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 Comparable<?>> TreeRangeSet<C> create()
Creates an emptyTreeRangeSet
instance.
-
create
public static <C extends Comparable<?>> TreeRangeSet<C> create(RangeSet<C> rangeSet)
Returns aTreeRangeSet
initialized with the ranges in the specified range set.
-
create
public static <C extends Comparable<?>> TreeRangeSet<C> create(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 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).- Specified by:
asRanges
in interfaceRangeSet<C extends Comparable<?>>
-
asDescendingSetOfRanges
public 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 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 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 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.- Specified by:
encloses
in interfaceRangeSet<C extends Comparable<?>>
-
span
public Range<C> span()
Description copied from interface:RangeSet
Returns the minimal range which encloses all ranges in this range set.- Specified by:
span
in interfaceRangeSet<C extends Comparable<?>>
-
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.- Specified by:
add
in interfaceRangeSet<C extends Comparable<?>>
-
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.- Specified by:
remove
in interfaceRangeSet<C extends Comparable<?>>
-
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 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 Comparable<?>>
-
contains
public boolean contains(C value)
Description copied from interface:RangeSet
Determines whether any of this range set's member ranges containsvalue
.- Specified by:
contains
in interfaceRangeSet<C extends Comparable>
-
isEmpty
public boolean isEmpty()
Description copied from interface:RangeSet
Returnstrue
if this range set contains no ranges.- Specified by:
isEmpty
in interfaceRangeSet<C extends Comparable>
-
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())
.- Specified by:
clear
in interfaceRangeSet<C extends Comparable>
-
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 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.- Specified by:
addAll
in interfaceRangeSet<C extends Comparable>
-
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.- Specified by:
removeAll
in interfaceRangeSet<C extends Comparable>
-
equals
public boolean equals(@CheckForNull Object obj)
Description copied from class:java.lang.Object
Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Specified by:
equals
in interfaceRangeSet<C extends Comparable>
- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
- It is reflexive: for any non-null reference value
-
hashCode
public final int hashCode()
Description copied from class:java.lang.Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
Object.equals(java.lang.Object)
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Specified by:
hashCode
in interfaceRangeSet<C extends Comparable>
- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
toString
public final String toString()
Description copied from class:java.lang.Object
Returns a string representation of the object. In general, thetoString
method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.The
toString
method for classObject
returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:getClass().getName() + '@' + Integer.toHexString(hashCode())
- Specified by:
toString
in interfaceRangeSet<C extends Comparable>
- Overrides:
toString
in classObject
- Returns:
- a string representation of the object.
-
-