Class ImmutableRangeMap<K extends java.lang.Comparable<?>,V>
- java.lang.Object
-
- com.google.common.collect.ImmutableRangeMap<K,V>
-
- All Implemented Interfaces:
RangeMap<K,V>
,java.io.Serializable
@GwtIncompatible public class ImmutableRangeMap<K extends java.lang.Comparable<?>,V> extends java.lang.Object implements RangeMap<K,V>, java.io.Serializable
ARangeMap
whose contents will never change, with many other important properties detailed atImmutableCollection
.- Since:
- 14.0
- Author:
- Louis Wasserman
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableRangeMap.Builder<K extends java.lang.Comparable<?>,V>
A builder for immutable range maps.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ImmutableMap<Range<K>,V>
asDescendingMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.ImmutableMap<Range<K>,V>
asMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.static <K extends java.lang.Comparable<?>,V>
ImmutableRangeMap.Builder<K,V>builder()
Returns a new builder for an immutable range map.void
clear()
Deprecated.Unsupported operation.static <K extends java.lang.Comparable<?>,V>
ImmutableRangeMap<K,V>copyOf(RangeMap<K,? extends V> rangeMap)
boolean
equals(java.lang.Object o)
V
get(K key)
Returns the value associated with the specified key, ornull
if there is no such value.java.util.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 java.lang.Comparable<?>,V>
ImmutableRangeMap<K,V>of()
Returns an empty immutable range map.static <K extends java.lang.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)
Deprecated.Unsupported operation.void
putAll(RangeMap<K,? extends V> rangeMap)
Deprecated.Unsupported operation.void
putCoalescing(Range<K> range, V value)
Deprecated.Unsupported operation.void
remove(Range<K> range)
Deprecated.Unsupported 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
.java.lang.String
toString()
Returns a readable string representation of this range map.
-
-
-
Method Detail
-
of
public static <K extends java.lang.Comparable<?>,V> ImmutableRangeMap<K,V> of()
Returns an empty immutable range map.Performance note: the instance returned is a singleton.
-
of
public static <K extends java.lang.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 java.lang.Comparable<?>,V> ImmutableRangeMap<K,V> copyOf(RangeMap<K,? extends V> rangeMap)
-
builder
public static <K extends java.lang.Comparable<?>,V> ImmutableRangeMap.Builder<K,V> builder()
Returns a new builder for an immutable range map.
-
get
@CheckForNull 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.
-
getEntry
@CheckForNull public java.util.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.
-
span
public Range<K> span()
Description copied from interface:RangeMap
Returns the minimal range enclosing the ranges in thisRangeMap
.
-
put
@Deprecated public final void put(Range<K> range, V value)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.
-
putCoalescing
@Deprecated public final void putCoalescing(Range<K> range, V value)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
putCoalescing
in interfaceRangeMap<K extends java.lang.Comparable<?>,V>
- Throws:
java.lang.UnsupportedOperationException
- always
-
putAll
@Deprecated public final void putAll(RangeMap<K,? extends V> rangeMap)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.
-
clear
@Deprecated public final void clear()
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.
-
remove
@Deprecated public final void remove(Range<K> range)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.
-
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
.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 java.lang.Comparable<?>,V>
-
asDescendingMapOfRanges
public ImmutableMap<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 java.lang.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 java.lang.Comparable<?>,V>
-
hashCode
public int hashCode()
Description copied from interface:RangeMap
ReturnsasMapOfRanges().hashCode()
.
-
equals
public boolean equals(@CheckForNull java.lang.Object o)
Description copied from interface:RangeMap
-
-