Class ImmutableRangeMap<K extends Comparable<?>,V>
- All Implemented Interfaces:
RangeMap<K,
,V> Serializable
RangeMap
whose contents will never change, with many other important properties
detailed at ImmutableCollection
.- Since:
- 14.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
ImmutableRangeMap.Builder<K extends Comparable<?>,
V> A builder for immutable range maps.private static class
ImmutableRangeMap.SerializedForm<K extends Comparable<?>,
V> This class is used to serialize ImmutableRangeMap instances. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ImmutableRangeMap
<Comparable<?>, Object> private final ImmutableList
<Range<K>> private static final long
private final ImmutableList
<V> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionImmutableMap
<Range<K>, V> Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.ImmutableMap
<Range<K>, V> 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.final void
clear()
Deprecated.Unsupported operation.static <K extends Comparable<?>,
V>
ImmutableRangeMap<K, V> 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()
.final void
Deprecated.Unsupported operation.static <K extends Comparable<?>,
V>
ImmutableRangeMap<K, V> of()
Returns an empty immutable range map.static <K extends Comparable<?>,
V>
ImmutableRangeMap<K, V> Returns an immutable range map mapping a single range to a single value.final void
Deprecated.Unsupported operation.final void
Deprecated.Unsupported operation.final void
putCoalescing
(Range<K> range, V value) Deprecated.Unsupported operation.private void
readObject
(ObjectInputStream stream) final void
Deprecated.Unsupported 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
.static <T,
K extends Comparable<? super K>, V>
Collector<T, ?, ImmutableRangeMap<K, V>> toImmutableRangeMap
(Function<? super T, Range<K>> keyFunction, Function<? super T, ? extends V> valueFunction) Returns aCollector
that accumulates the input elements into a newImmutableRangeMap
.toString()
Returns a readable string representation of this range map.(package private) Object
-
Field Details
-
EMPTY
-
ranges
-
values
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
ImmutableRangeMap
ImmutableRangeMap(ImmutableList<Range<K>> ranges, ImmutableList<V> values)
-
-
Method Details
-
toImmutableRangeMap
public static <T,K extends Comparable<? super K>, Collector<T,V> ?, toImmutableRangeMapImmutableRangeMap<K, V>> (Function<? super T, Range<K>> keyFunction, Function<? super T, ? extends V> valueFunction) Returns aCollector
that accumulates the input elements into a newImmutableRangeMap
. As inImmutableRangeMap.Builder
, overlapping ranges are not permitted.- Since:
- 23.1
-
of
Returns an empty immutable range map.Performance note: the instance returned is a singleton.
-
of
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
Returns a new builder for an immutable range map. -
get
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
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
Description copied from interface:RangeMap
Returns the minimal range enclosing the ranges in thisRangeMap
.- Specified by:
span
in interfaceRangeMap<K extends Comparable<?>,
V>
-
put
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
put
in interfaceRangeMap<K extends Comparable<?>,
V> - Throws:
UnsupportedOperationException
- always
-
putCoalescing
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
putCoalescing
in interfaceRangeMap<K extends Comparable<?>,
V> - Throws:
UnsupportedOperationException
- always
-
putAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
putAll
in interfaceRangeMap<K extends Comparable<?>,
V> - Throws:
UnsupportedOperationException
- always
-
clear
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
clear
in interfaceRangeMap<K extends Comparable<?>,
V> - Throws:
UnsupportedOperationException
- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
remove
in interfaceRangeMap<K extends Comparable<?>,
V> - Throws:
UnsupportedOperationException
- always
-
merge
@Deprecated public final void merge(Range<K> range, @CheckForNull V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction) Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
merge
in interfaceRangeMap<K extends Comparable<?>,
V> - Throws:
UnsupportedOperationException
- always- Since:
- 28.1
-
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 Comparable<?>,
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 Comparable<?>,
V>
-
subRangeMap
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()
. -
equals
Description copied from interface:RangeMap
-
toString
Description copied from interface:RangeMap
Returns a readable string representation of this range map. -
writeReplace
Object writeReplace() -
readObject
- Throws:
InvalidObjectException
-