Interface RangeMap<K extends Comparable,V>
- All Known Implementing Classes:
ImmutableRangeMap
,TreeRangeMap
In contrast to RangeSet
, no "coalescing" is done of connected ranges, even if they are mapped to the same value.
- Since:
- 14.0
- Author:
- Louis Wasserman
-
Method Summary
Modifier and TypeMethodDescriptionReturns a view of this range map as an unmodifiableMap<Range<K>, V>
.Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.void
clear()
Removes all associations from this range map (optional operation).boolean
Returns the value associated with the specified key, ornull
if there is no such value.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
Maps a range to a specified value (optional operation).void
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
Removes all associations from this range map in the specified range (optional operation).span()
Returns the minimal range enclosing the ranges in thisRangeMap
.subRangeMap
(Range<K> range) Returns a view of the part of this range map that intersects withrange
.toString()
Returns a readable string representation of this range map.
-
Method Details
-
get
-
getEntry
-
span
Returns the minimal range enclosing the ranges in thisRangeMap
.- Throws:
NoSuchElementException
- if this range map is empty
-
put
-
putCoalescing
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 fromasMapOfRanges()
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.- Since:
- 22.0
-
putAll
-
clear
void clear()Removes all associations from this range map (optional operation). -
remove
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
. -
asMapOfRanges
Map<Range<K>,V> asMapOfRanges()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
. -
asDescendingMapOfRanges
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
.- Since:
- 19.0
-
subRangeMap
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
. -
equals
-
hashCode
-
toString
-