Class ImmutableRangeMap<K extends Comparable<?>,V>
- java.lang.Object
-
- com.google.common.collect.ImmutableRangeMap<K,V>
-
- All Implemented Interfaces:
RangeMap<K,V>
@Beta @GwtIncompatible("NavigableMap") public class ImmutableRangeMap<K extends Comparable<?>,V> extends Object implements RangeMap<K,V>
An immutable implementation ofRangeMap
, supporting all query operations efficiently.Like all
RangeMap
implementations, this supports neither null keys nor null values.- Since:
- 14.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableRangeMap.Builder<K extends Comparable<?>,V>
A builder for immutable range maps.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ImmutableMap<Range<K>,V>
asMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.static <K extends Comparable<?>,V>
ImmutableRangeMap.Builder<K,V>builder()
Returns a new builder for an immutable range map.void
clear()
Removes all associations from this range map (optional operation).static <K extends Comparable<?>,V>
ImmutableRangeMap<K,V>copyOf(RangeMap<K,? extends V> rangeMap)
boolean
equals(Object o)
V
get(K key)
Returns the value associated with the specified key, ornull
if there is no such value.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()
.static <K extends Comparable<?>,V>
ImmutableRangeMap<K,V>of()
Returns an empty immutable range map.static <K extends Comparable<?>,V>
ImmutableRangeMap<K,V>of(Range<K> range, V value)
Returns an immutable range map mapping a single range to a single value.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
remove(Range<K> range)
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
.ImmutableRangeMap<K,V>
subRangeMap(Range<K> range)
Returns a view of the part of this range map that intersects withrange
.String
toString()
Returns a readable string representation of this range map.
-
-
-
Method Detail
-
of
public static <K extends Comparable<?>,V> ImmutableRangeMap<K,V> of()
Returns an empty immutable range map.
-
of
public static <K extends Comparable<?>,V> ImmutableRangeMap<K,V> of(Range<K> range, V value)
Returns an immutable range map mapping a single range to a single value.
-
copyOf
public static <K extends Comparable<?>,V> ImmutableRangeMap<K,V> copyOf(RangeMap<K,? extends V> rangeMap)
-
builder
public static <K extends Comparable<?>,V> ImmutableRangeMap.Builder<K,V> builder()
Returns a new builder for an immutable range map.
-
get
@Nullable 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.
- Specified by:
get
in interfaceRangeMap<K extends Comparable<?>,V>
-
getEntry
@Nullable public 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>
-
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>
-
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>
-
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>
-
remove
public void remove(Range<K> range)
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>
-
asMapOfRanges
public ImmutableMap<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
.It is guaranteed that no empty ranges will be in the returned
Map
.- Specified by:
asMapOfRanges
in interfaceRangeMap<K extends Comparable<?>,V>
-
subRangeMap
public ImmutableRangeMap<K,V> subRangeMap(Range<K> range)
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>
-
hashCode
public int hashCode()
Description copied from interface:RangeMap
ReturnsasMapOfRanges().hashCode()
.
-
-