TreeRangeSet (Guava: Google Core Libraries for Java 26.0-jre API)

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
```
An implementation of RangeSet backed by a TreeMap.

Since:

14.0

Author:

Louis Wasserman

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Range<C> rangeToAdd)` Adds the specified range to this `RangeSet` (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 this `RangeSet` (optional operation).
`RangeSet<C>`	`complement()` Returns a view of the complement of this `RangeSet`.
`boolean`	`contains(C value)` Determines whether any of this range set's member ranges contains `value`.
`static <C extends Comparable<?>> TreeRangeSet<C>`	`create()` Creates an empty `TreeRangeSet` instance.
`static <C extends Comparable<?>> TreeRangeSet<C>`	`create(Iterable<Range<C>> ranges)` Returns a `TreeRangeSet` representing the union of the specified ranges.
`static <C extends Comparable<?>> TreeRangeSet<C>`	`create(RangeSet<C> rangeSet)` Returns a `TreeRangeSet` initialized with the ranges in the specified range set.
`boolean`	`encloses(Range<C> range)` Returns `true` if there exists a member range in this range set which encloses the specified range.
`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.
`boolean`	`equals(@Nullable 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)` Returns `true` if there exists a non-empty range enclosed by both a member range in this range set and the specified range.
`boolean`	`isEmpty()` Returns `true` if this range set contains no ranges.
`@Nullable 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`.
`void`	`remove(Range<C> rangeToRemove)` Removes the specified range from this `RangeSet` (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 this `RangeSet` 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 empty TreeRangeSet instance.
  - create
```
public static <C extends Comparable<?>> TreeRangeSet<C> create(RangeSet<C> rangeSet)
```
    Returns a TreeRangeSet initialized with the ranges in the specified range set.
  - create
```
public static <C extends Comparable<?>> TreeRangeSet<C> create(Iterable<Range<C>> ranges)
```
    Returns a TreeRangeSet 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 this RangeSet if and only if it is contained in at least one Range in ranges.
    
    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 its Iterable.iterator() method return the ranges in increasing order of lower bound (equivalently, of upper bound).
    
    Specified by:
    
    asRanges in interface RangeSet<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 its Iterable.iterator() method return the ranges in decreasing order of lower bound (equivalently, of upper bound).
    
    Specified by:
    
    asDescendingSetOfRanges in interface RangeSet<C extends Comparable<?>>
  - rangeContaining
```
public @Nullable Range<C> rangeContaining(C value)
```
    Description copied from interface: RangeSet
    
    Returns the unique range from this range set that contains value, or null if this range set does not contain value.
    
    Specified by:
    
    rangeContaining in interface RangeSet<C extends Comparable<?>>
  - intersects
```
public boolean intersects(Range<C> range)
```
    Description copied from interface: RangeSet
    
    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.
    
    Specified by:
    
    intersects in interface RangeSet<C extends Comparable<?>>
  - encloses
```
public boolean encloses(Range<C> range)
```
    Description copied from interface: RangeSet
    
    Returns true if there exists a member range in this range set which encloses the specified range.
    
    Specified by:
    
    encloses in interface RangeSet<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 interface RangeSet<C extends Comparable<?>>
  - add
```
public void add(Range<C> rangeToAdd)
```
    Description copied from interface: RangeSet
    
    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.
    
    Specified by:
    
    add in interface RangeSet<C extends Comparable<?>>
  - remove
```
public void remove(Range<C> rangeToRemove)
```
    Description copied from interface: RangeSet
    
    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.
    
    Specified by:
    
    remove in interface RangeSet<C extends Comparable<?>>
  - complement
```
public RangeSet<C> complement()
```
    Description copied from interface: RangeSet
    
    Returns a view of the complement of this RangeSet.
    The returned view supports the RangeSet.add(com.google.common.collect.Range<C>) operation if this RangeSet supports RangeSet.remove(com.google.common.collect.Range<C>), and vice versa.
    
    Specified by:
    
    complement in interface RangeSet<C extends Comparable<?>>
  - subRangeSet
```
public RangeSet<C> subRangeSet(Range<C> view)
```
    Description copied from interface: RangeSet
    
    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.
    
    Specified by:
    
    subRangeSet in interface RangeSet<C extends Comparable<?>>
  - contains
```
public boolean contains(C value)
```
    Description copied from interface: RangeSet
    
    Determines whether any of this range set's member ranges contains value.
    
    Specified by:
    
    contains in interface RangeSet<C extends Comparable>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: RangeSet
    
    Returns true if this range set contains no ranges.
    
    Specified by:
    
    isEmpty in interface RangeSet<C extends Comparable>
  - clear
```
public void clear()
```
    Description copied from interface: RangeSet
    
    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()).
    
    Specified by:
    
    clear in interface RangeSet<C extends Comparable>
  - enclosesAll
```
public boolean enclosesAll(RangeSet<C> other)
```
    Description copied from interface: RangeSet
    
    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 RangeSet.encloses(com.google.common.collect.Range<C>) each of the ranges in other.
    
    Specified by:
    
    enclosesAll in interface RangeSet<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 and other.
    This is equivalent to calling RangeSet.add(com.google.common.collect.Range<C>) on each of the ranges in other in turn.
    
    Specified by:
    
    addAll in interface RangeSet<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, if other.contains(c), this.contains(c) will return false.
    This is equivalent to calling RangeSet.remove(com.google.common.collect.Range<C>) on each of the ranges in other in turn.
    
    Specified by:
    
    removeAll in interface RangeSet<C extends Comparable>
  - equals
```
public boolean equals(@Nullable 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 return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Specified by:
    
    equals in interface RangeSet<C extends Comparable>
    
    Overrides:
    
    equals in class Object
    
    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
  - 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 by HashMap.
    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 in equals 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 the hashCode 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 the hashCode 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. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    Specified by:
    
    hashCode in interface RangeSet<C extends Comparable>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - toString
```
public final String toString()
```
    Description copied from class: java.lang.Object
    Returns a string representation of the object. In general, the toString 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 class Object 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 interface RangeSet<C extends Comparable>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class TreeRangeSet<C extends Comparable<?>>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.common.collect.RangeSet

Method Detail

create

create

create

asRanges

asDescendingSetOfRanges

rangeContaining

intersects

encloses

span

add

remove

complement

subRangeSet

contains

isEmpty

clear

enclosesAll

addAll

removeAll

equals

hashCode

toString