Class TreeRangeMap<K extends Comparable,V>
- 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 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 Map<Range<K>,V>
asDescendingMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.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 Comparable,V>
TreeRangeMap<K,V>create()
boolean
equals(@Nullable Object o)
Indicates whether some other object is "equal to" this one.@Nullable V
get(K key)
Returns the value associated with the specified key, ornull
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, ornull
otherwise.int
hashCode()
Returns a hash code value for the object.void
merge(Range<K> range, @Nullable V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
Merges a value into the map over a range 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,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
.String
toString()
Returns a string representation of the object.
-
-
-
Method Detail
-
create
public static <K extends Comparable,V> TreeRangeMap<K,V> create()
-
get
public @Nullable 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.
- Specified by:
get
in interfaceRangeMap<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, ornull
otherwise.- Specified by:
getEntry
in interfaceRangeMap<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)
, ifrange.contains(k)
, thenget(k)
will returnvalue
.If
range
is empty, then this is a no-op.- Specified by:
put
in interfaceRangeMap<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 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 Comparable,V>
-
putAll
public void putAll(RangeMap<K,V> rangeMap)
Description copied from interface:RangeMap
Puts all the associations fromrangeMap
into this range map (optional operation).- Specified by:
putAll
in interfaceRangeMap<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 interfaceRangeMap<K extends Comparable,V>
-
span
public Range<K> span()
Description copied from interface:RangeMap
Returns the minimal range enclosing the ranges in thisRangeMap
.- Specified by:
span
in interfaceRangeMap<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 toremove(range)
. Ifrange.contains(k)
, then after a call toremove(range)
,get(k)
will returnnull
.- Specified by:
remove
in interfaceRangeMap<K extends Comparable,V>
-
merge
public void merge(Range<K> range, @Nullable V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
Description copied from interface:RangeMap
Merges a value into the map over a range by applying a remapping function.If any parts of the range are already present in this range map, those parts are mapped to new values by applying the remapping function. Any parts of the range not already present in this range map are mapped to the specified value, unless the value is
null
.Any existing map 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 range map with the entries[0, 1) => 3, [1, 2] => 3, (2, 5] => 3
.- Specified by:
merge
in interfaceRangeMap<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 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 Comparable,V>
-
asDescendingMapOfRanges
public 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 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 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 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 interfaceRangeMap<K extends Comparable,V>
- Overrides:
equals
in classObject
- 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
- It is reflexive: for any non-null reference value
-
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 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 interfaceRangeMap<K extends Comparable,V>
- 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 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())
-
-