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

java.lang.Object
- com.google.common.collect.TreeRangeMap<K,V>

All Implemented Interfaces:

RangeMap<K,V>
```
@Beta
 @GwtIncompatible
public final class TreeRangeMap<K extends Comparable,V>
extends Object
implements RangeMap<K,V>
```
An implementation of RangeMap based on a TreeMap, supporting all optional operations.
Like all RangeMap implementations, this supports neither null keys nor null values.

Since:

14.0

Author:

Louis Wasserman

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<Range<K>,V>`	`asDescendingMapOfRanges()` Returns a view of this range map as an unmodifiable `Map<Range<K>, V>`.
`Map<Range<K>,V>`	`asMapOfRanges()` Returns a view of this range map as an unmodifiable `Map<Range<K>, V>`.
`void`	`clear()` Removes all associations from this range map (optional operation).
`static <K extends Comparable,V> TreeRangeMap<K,V>`	`create()`
`boolean`	`equals(@Nullable Object o)` Indicates whether some other object is "equal to" this one.
`V`	`get(K key)` Returns the value associated with the specified key, or `null` if there is no such value.
`@Nullable Map.Entry<Range<K>,V>`	`getEntry(K key)` Returns the range containing this key and its associated value, if such a range is present in the range map, or `null` otherwise.
`int`	`hashCode()` Returns a hash code value for the object.
`void`	`put(Range<K> range, V value)` Maps a range to a specified value (optional operation).
`void`	`putAll(RangeMap<K,V> rangeMap)` Puts all the associations from `rangeMap` into this range map (optional operation).
`void`	`putCoalescing(Range<K> range, V value)` Maps a range to a specified value, coalescing this range with any existing ranges with the same value that are connected to this range.
`void`	`remove(Range<K> rangeToRemove)` Removes all associations from this range map in the specified range (optional operation).
`Range<K>`	`span()` Returns the minimal range enclosing the ranges in this `RangeMap`.
`RangeMap<K,V>`	`subRangeMap(Range<K> subRange)` Returns a view of the part of this range map that intersects with `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

- Method Detail
  - create
```
public static <K extends Comparable,V> TreeRangeMap<K,V> create()
```
  - get
```
public V get(K key)
```
    Description copied from interface: RangeMap
    
    Returns the value associated with the specified key, or null if there is no such value.
    Specifically, if any range in this range map contains the specified key, the value associated with that range is returned.
    
    Specified by:
    
    get in interface RangeMap<K extends Comparable,V>
  - getEntry
```
public @Nullable Map.Entry<Range<K>,V> getEntry(K key)
```
    Description copied from interface: RangeMap
    
    Returns the range containing this key and its associated value, if such a range is present in the range map, or null otherwise.
    
    Specified by:
    
    getEntry in interface RangeMap<K extends Comparable,V>
  - put
```
public void put(Range<K> range,
                V value)
```
    Description copied from interface: RangeMap
    
    Maps a range to a specified value (optional operation).
    Specifically, after a call to put(range, value), if range.contains(k), then get(k) will return value.
    If range is empty, then this is a no-op.
    
    Specified by:
    
    put in interface RangeMap<K extends Comparable,V>
  - putCoalescing
```
public void putCoalescing(Range<K> range,
                          V value)
```
    Description copied from interface: RangeMap
    
    Maps a range to a specified value, coalescing this range with any existing ranges with the same value that are connected to this range.
    The behavior of get(k) after calling this method is identical to the behavior described in put(range, value), however the ranges returned from RangeMap.asMapOfRanges() will be different if there were existing entries which connect to the given range and value.
    Even if the input range is empty, if it is connected on both sides by ranges mapped to the same value those two ranges will be coalesced.
    Note: coalescing requires calling .equals() on any connected values, which may be expensive depending on the value type. Using this method on range maps with large values such as Collection types is discouraged.
    
    Specified by:
    
    putCoalescing in interface RangeMap<K extends Comparable,V>
  - putAll
```
public void putAll(RangeMap<K,V> rangeMap)
```
    Description copied from interface: RangeMap
    
    Puts all the associations from rangeMap into this range map (optional operation).
    
    Specified by:
    
    putAll in interface RangeMap<K extends Comparable,V>
  - clear
```
public void clear()
```
    Description copied from interface: RangeMap
    
    Removes all associations from this range map (optional operation).
    
    Specified by:
    
    clear in interface RangeMap<K extends Comparable,V>
  - span
```
public Range<K> span()
```
    Description copied from interface: RangeMap
    
    Returns the minimal range enclosing the ranges in this RangeMap.
    
    Specified by:
    
    span in interface RangeMap<K extends Comparable,V>
  - remove
```
public void remove(Range<K> rangeToRemove)
```
    Description copied from interface: RangeMap
    
    Removes all associations from this range map in the specified range (optional operation).
    If !range.contains(k), get(k) will return the same result before and after a call to remove(range). If range.contains(k), then after a call to remove(range), get(k) will return null.
    
    Specified by:
    
    remove in interface RangeMap<K extends Comparable,V>
  - asMapOfRanges
```
public Map<Range<K>,V> asMapOfRanges()
```
    Description copied from interface: RangeMap
    
    Returns a view of this range map as an unmodifiable Map<Range<K>, V>. Modifications to this range map are guaranteed to read through to the returned Map.
    The returned Map iterates over entries in ascending order of the bounds of the Range entries.
    It is guaranteed that no empty ranges will be in the returned Map.
    
    Specified by:
    
    asMapOfRanges in interface RangeMap<K extends Comparable,V>
  - asDescendingMapOfRanges
```
public Map<Range<K>,V> asDescendingMapOfRanges()
```
    Description copied from interface: RangeMap
    
    Returns a view of this range map as an unmodifiable Map<Range<K>, V>. Modifications to this range map are guaranteed to read through to the returned Map.
    The returned Map iterates over entries in descending order of the bounds of the Range entries.
    It is guaranteed that no empty ranges will be in the returned Map.
    
    Specified by:
    
    asDescendingMapOfRanges in interface RangeMap<K extends Comparable,V>
  - subRangeMap
```
public RangeMap<K,V> subRangeMap(Range<K> subRange)
```
    Description copied from interface: RangeMap
    
    Returns a view of the part of this range map that intersects with range.
    For example, if rangeMap had the entries [1, 5] => "foo", (6, 8) => "bar", (10, ∞) => "baz" then rangeMap.subRangeMap(Range.open(3, 12)) would return a range map with the entries (3, 5] => "foo", (6, 8) => "bar", (10, 12) => "baz".
    The returned range map supports all optional operations that this range map supports, except for asMapOfRanges().iterator().remove().
    The returned range map will throw an IllegalArgumentException on an attempt to insert a range not enclosed by range.
    
    Specified by:
    
    subRangeMap in interface RangeMap<K extends Comparable,V>
  - equals
```
public boolean equals(@Nullable Object o)
```
    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 RangeMap<K extends Comparable,V>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - 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 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 RangeMap<K extends Comparable,V>
    
    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 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 RangeMap<K extends Comparable,V>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class TreeRangeMap<K extends Comparable,V>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

get

getEntry

put

putCoalescing

putAll

clear

span

remove

asMapOfRanges

asDescendingMapOfRanges

subRangeMap

equals

hashCode

toString