Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.collect.RangeMap

Method Summary

Modifier and Type	Method and Description
public Map<Range<K>, V>	asDescendingMapOfRanges() Returns a view of this range map as an unmodifiable `Map<Range<K>, V>`.
public Map<Range<K>, V>	asMapOfRanges() Returns a view of this range map as an unmodifiable `Map<Range<K>, V>`.
public void	clear() Removes all associations from this range map (optional operation).
public boolean	equals(Object o) Returns `true` if `obj` is another `RangeMap` that has an equivalent `asMapOfRanges()`.
public V	get(K key) Returns the value associated with the specified key, or `null` if there is no such value.
public 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.
public int	hashCode() Returns `asMapOfRanges().hashCode()`.
public void	merge(Range<K> range, V value, BiFunction<? super V, ? super @Nullable V, ? extends @Nullable V> remappingFunction) Merges a value into a part of the map by applying a remapping function.
public void	put(Range<K> range, V value) Maps a range to a specified value (optional operation).
public void	putAll(RangeMap<K, ? extends V> rangeMap) Puts all the associations from `rangeMap` into this range map (optional operation).
public 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.
public void	remove(Range<K> range) Removes all associations from this range map in the specified range (optional operation).
public Range<K>	span() Returns the minimal range enclosing the ranges in this `RangeMap`.
public RangeMap<K, V>	subRangeMap(Range<K> range) Returns a view of the part of this range map that intersects with `range`.
public String	toString() Returns a readable string representation of this range map.

Method Detail

asDescendingMapOfRanges back to summary

asDescendingMapOfRanges	back to summary
public Map<Range<K>, V> asDescendingMapOfRanges() 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`. Since 19.0

public Map<Range<K>, V> asDescendingMapOfRanges()

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.

Since: 19.0

asMapOfRanges back to summary

asMapOfRanges	back to summary
public Map<Range<K>, V> asMapOfRanges() 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`.

public Map<Range<K>, V> asMapOfRanges()

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.

clear	back to summary
public void clear() Removes all associations from this range map (optional operation).

equals back to summary

equals	back to summary
public boolean equals(Object o) Returns `true` if `obj` is another `RangeMap` that has an equivalent `asMapOfRanges()`. Annotations @Override

public boolean equals(Object o)

Returns true if obj is another RangeMap that has an equivalent asMapOfRanges().

Annotations

@Override

get back to summary

get	back to summary
public V get(K key) 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. Annotations @CheckForNull

public V get(K key)

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.

Annotations

@CheckForNull

getEntry back to summary

getEntry	back to summary
public 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. Annotations @CheckForNull

public 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.

Annotations

@CheckForNull

hashCode back to summary

hashCode	back to summary
public int hashCode() Returns `asMapOfRanges().hashCode()`. Annotations @Override

public int hashCode()

Returns asMapOfRanges().hashCode().

Annotations

@Override

merge back to summary

merge	back to summary
public void merge(Range<K> range, V value, BiFunction<? super V, ? super @Nullable V, ? extends @Nullable V> remappingFunction) 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` then `rangeMap.merge(Range.closed(0,2), 3, Math::max)` could yield a map with the entries `[0, 1) => 3, [1, 2] => 3, (2, 5] => 3`. Since 28.1

public void merge(Range<K> range, V value, BiFunction<? super V, ? super @Nullable V, ? extends @Nullable V> remappingFunction)

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 then rangeMap.merge(Range.closed(0,2), 3, Math::max) could yield a map with the entries [0, 1) => 3, [1, 2] => 3, (2, 5] => 3.

Since: 28.1

put back to summary

put	back to summary
public void put(Range<K> range, V value) 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.

public void put(Range<K> range, V value)

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.

putAll	back to summary
public void putAll(RangeMap<K, ? extends V> rangeMap) Puts all the associations from `rangeMap` into this range map (optional operation).

putCoalescing back to summary

putCoalescing	back to summary
public 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. The behavior of `get(k)` after calling this method is identical to the behavior described in `put(range, value)`, however the ranges returned from `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. Since 22.0

public 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.

The behavior of get(k) after calling this method is identical to the behavior described in put(range, value), however the ranges returned from 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.

Since: 22.0

remove back to summary

remove	back to summary
public void remove(Range<K> range) 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`.

public void remove(Range<K> range)

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.

span back to summary

span	back to summary
public Range<K> span() Returns the minimal range enclosing the ranges in this `RangeMap`. Exceptions NoSuchElementException: if this range map is empty

public Range<K> span()

Returns the minimal range enclosing the ranges in this RangeMap.

Exceptions

NoSuchElementException:: if this range map is empty

subRangeMap back to summary

subRangeMap	back to summary
public RangeMap<K, V> subRangeMap(Range<K> range) 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`.

public RangeMap<K, V> subRangeMap(Range<K> range)

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.

toString	back to summary
public String toString() Returns a readable string representation of this range map. Annotations @Override

toString

back to summary

public String toString()

Returns a readable string representation of this range map.

Annotations

@Override

public Interface RangeMap<K extends Comparable<T>, V>

Method Summary

Method Detail