ImmutableRangeMap

java.lang.Object
- com.google.common.collect.ImmutableRangeMap<K,V>

All Implemented Interfaces:

RangeMap<K,V>
```
@Beta
 @GwtIncompatible(value="NavigableMap")
public class ImmutableRangeMap<K extends Comparable<?>,V>
extends Object
implements RangeMap<K,V>
```
An immutable implementation of RangeMap, 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 and 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 and Description
`ImmutableMap<Range<K>,V>`	`asMapOfRanges()` Returns a view of this range map as an unmodifiable `Map<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)` Returns `true` if `obj` is another `RangeMap` that has an equivalent `RangeMap.asMapOfRanges()`.
`V`	`get(K key)` Returns the value associated with the specified key, or `null` 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, or `null` otherwise.
`int`	`hashCode()` Returns `asMapOfRanges().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 from `rangeMap` 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 this `RangeMap`.
`ImmutableRangeMap<K,V>`	`subRangeMap(Range<K> range)` Returns a view of the part of this range map that intersects with `range`.
`String`	`toString()` Returns a readable string representation of this range map.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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
```
public V get(K key)
```
    Description copied from interface: RangeMap
    
    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.
  - getEntry
```
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, or null otherwise.
  - span
```
public Range<K> span()
```
    Description copied from interface: RangeMap
    
    Returns the minimal range enclosing the ranges in this RangeMap.
  - 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), if range.contains(k), then get(k) will return value.
    
    If range is empty, then this is a no-op.
  - putAll
```
public void putAll(RangeMap<K,V> rangeMap)
```
    Description copied from interface: RangeMap
    
    Puts all the associations from rangeMap into this range map (optional operation).
  - clear
```
public void clear()
```
    Description copied from interface: RangeMap
    
    Removes all associations from this range map (optional operation).
  - 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 to remove(range). If range.contains(k), then after a call to remove(range), get(k) will return null.
  - asMapOfRanges
```
public ImmutableMap<Range<K>,V> asMapOfRanges()
```
    Description copied from interface: RangeMap
    
    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.
    It is guaranteed that no empty ranges will be in the returned Map.
  - 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 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.
  - hashCode
```
public int hashCode()
```
    Description copied from interface: RangeMap
    
    Returns asMapOfRanges().hashCode().
  - equals
```
public boolean equals(Object o)
```
    Description copied from interface: RangeMap
    
    Returns true if obj is another RangeMap that has an equivalent RangeMap.asMapOfRanges().
  - toString
```
public String toString()
```
    Description copied from interface: RangeMap
    
    Returns a readable string representation of this range map.

Class ImmutableRangeMap<K extends Comparable<?>,V>

Nested Class Summary

Nested Classes

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

copyOf

builder

get

getEntry

span

put

putAll

clear

remove

asMapOfRanges

subRangeMap

hashCode

equals

toString