Class TreeRangeMap<K extends java.lang.Comparable,V>
- java.lang.Object
-
- com.google.common.collect.TreeRangeMap<K,V>
-
- All Implemented Interfaces:
RangeMap<K,V>
@GwtIncompatible public final class TreeRangeMap<K extends java.lang.Comparable,V> extends java.lang.Object implements RangeMap<K,V>
An implementation ofRangeMap
based on aTreeMap
, 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 Description java.util.Map<Range<K>,V>
asDescendingMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.java.util.Map<Range<K>,V>
asMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.void
clear()
Removes all associations from this range map (optional operation).static <K extends java.lang.Comparable<?>,V>
TreeRangeMap<K,V>copyOf(RangeMap<K,? extends V> rangeMap)
static <K extends java.lang.Comparable,V>
TreeRangeMap<K,V>create()
boolean
equals(java.lang.Object o)
V
get(K key)
Returns the value associated with the specified key, ornull
if there is no such value.java.util.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, ornull
otherwise.int
hashCode()
ReturnsasMapOfRanges().hashCode()
.void
merge(Range<K> range, V value, java.util.function.BiFunction<? super V,? super @Nullable V,? extends @Nullable V> remappingFunction)
Merges a value into a part of the map by applying a remapping function.void
put(Range<K> range, V value)
Maps a range to a specified value (optional operation).void
putAll(RangeMap<K,? extends V> rangeMap)
Puts all the associations fromrangeMap
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 thisRangeMap
.RangeMap<K,V>
subRangeMap(Range<K> subRange)
Returns a view of the part of this range map that intersects withrange
.java.lang.String
toString()
Returns a readable string representation of this range map.
-
-
-
Method Detail
-
create
public static <K extends java.lang.Comparable,V> TreeRangeMap<K,V> create()
-
copyOf
public static <K extends java.lang.Comparable<?>,V> TreeRangeMap<K,V> copyOf(RangeMap<K,? extends V> rangeMap)
-
get
@CheckForNull public V get(K key)
Description copied from interface:RangeMap
Returns the value associated with the specified key, ornull
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.
-
getEntry
@CheckForNull public java.util.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, ornull
otherwise.
-
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)
, ifrange.contains(k)
, thenget(k)
will returnvalue
.If
range
is empty, then this is a no-op.
-
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 input(range, value)
, however the ranges returned fromRangeMap.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 asCollection
types is discouraged.- Specified by:
putCoalescing
in interfaceRangeMap<K extends java.lang.Comparable,V>
-
putAll
public void putAll(RangeMap<K,? extends V> rangeMap)
Description copied from interface:RangeMap
Puts all the associations fromrangeMap
into this range map (optional operation).
-
clear
public void clear()
Description copied from interface:RangeMap
Removes all associations from this range map (optional operation).
-
span
public Range<K> span()
Description copied from interface:RangeMap
Returns the minimal range enclosing the ranges in thisRangeMap
.
-
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 toremove(range)
. Ifrange.contains(k)
, then after a call toremove(range)
,get(k)
will returnnull
.
-
merge
public void merge(Range<K> range, @CheckForNull V value, java.util.function.BiFunction<? super V,? super @Nullable V,? extends @Nullable V> remappingFunction)
Description copied from interface:RangeMap
Merges a value into a part of the map by applying a remapping function.If any parts of the range are already present in this map, those parts are mapped to new values by applying the remapping function. The remapping function accepts the map's existing value for that part of the range and the given value. It returns the value to be associated with that part of the map, or it returns
null
to clear that part of the map.Any parts of the range not already present in this map are mapped to the specified value, unless the value is
null
.Any existing entry spanning either range boundary may be split at the boundary, even if the merge does not affect its value. For example, if
rangeMap
had one entry[1, 5] => 3
thenrangeMap.merge(Range.closed(0,2), 3, Math::max)
could yield a map with the entries[0, 1) => 3, [1, 2] => 3, (2, 5] => 3
.
-
asMapOfRanges
public java.util.Map<Range<K>,V> asMapOfRanges()
Description copied from interface:RangeMap
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
. Modifications to this range map are guaranteed to read through to the returnedMap
.The returned
Map
iterates over entries in ascending order of the bounds of theRange
entries.It is guaranteed that no empty ranges will be in the returned
Map
.- Specified by:
asMapOfRanges
in interfaceRangeMap<K extends java.lang.Comparable,V>
-
asDescendingMapOfRanges
public java.util.Map<Range<K>,V> asDescendingMapOfRanges()
Description copied from interface:RangeMap
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
. Modifications to this range map are guaranteed to read through to the returnedMap
.The returned
Map
iterates over entries in descending order of the bounds of theRange
entries.It is guaranteed that no empty ranges will be in the returned
Map
.- Specified by:
asDescendingMapOfRanges
in interfaceRangeMap<K extends java.lang.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 withrange
.For example, if
rangeMap
had the entries[1, 5] => "foo", (6, 8) => "bar", (10, ∞) => "baz"
thenrangeMap.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 byrange
.- Specified by:
subRangeMap
in interfaceRangeMap<K extends java.lang.Comparable,V>
-
equals
public boolean equals(@CheckForNull java.lang.Object o)
Description copied from interface:RangeMap
-
hashCode
public int hashCode()
Description copied from interface:RangeMap
ReturnsasMapOfRanges().hashCode()
.
-
-