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 classImmutableRangeMap.Builder<K extends Comparable<?>,V> A builder for immutable range maps.private static classImmutableRangeMap.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 longprivate 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 voidclear()Deprecated.Unsupported operation.static <K extends Comparable<?>,V>
ImmutableRangeMap<K,V> booleanReturns the value associated with the specified key, ornullif 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, ornullotherwise.inthashCode()ReturnsasMapOfRanges().hashCode().final voidDeprecated.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 voidDeprecated.Unsupported operation.final voidDeprecated.Unsupported operation.final voidputCoalescing(Range<K> range, V value) Deprecated.Unsupported operation.private voidreadObject(ObjectInputStream stream) final voidDeprecated.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 aCollectorthat 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 aCollectorthat 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:RangeMapReturns the value associated with the specified key, ornullif 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:
getin interfaceRangeMap<K extends Comparable<?>,V>
-
getEntry
Description copied from interface:RangeMapReturns the range containing this key and its associated value, if such a range is present in the range map, ornullotherwise.- Specified by:
getEntryin interfaceRangeMap<K extends Comparable<?>,V>
-
span
Description copied from interface:RangeMapReturns the minimal range enclosing the ranges in thisRangeMap.- Specified by:
spanin interfaceRangeMap<K extends Comparable<?>,V>
-
put
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMapunmodified.- Specified by:
putin interfaceRangeMap<K extends Comparable<?>,V> - Throws:
UnsupportedOperationException- always
-
putCoalescing
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMapunmodified.- Specified by:
putCoalescingin interfaceRangeMap<K extends Comparable<?>,V> - Throws:
UnsupportedOperationException- always
-
putAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMapunmodified.- Specified by:
putAllin interfaceRangeMap<K extends Comparable<?>,V> - Throws:
UnsupportedOperationException- always
-
clear
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMapunmodified.- Specified by:
clearin interfaceRangeMap<K extends Comparable<?>,V> - Throws:
UnsupportedOperationException- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMapunmodified.- Specified by:
removein 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 theRangeMapunmodified.- Specified by:
mergein interfaceRangeMap<K extends Comparable<?>,V> - Throws:
UnsupportedOperationException- always
-
asMapOfRanges
Description copied from interface:RangeMapReturns 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
Mapiterates over entries in ascending order of the bounds of theRangeentries.It is guaranteed that no empty ranges will be in the returned
Map.- Specified by:
asMapOfRangesin interfaceRangeMap<K extends Comparable<?>,V>
-
asDescendingMapOfRanges
Description copied from interface:RangeMapReturns 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
Mapiterates over entries in descending order of the bounds of theRangeentries.It is guaranteed that no empty ranges will be in the returned
Map.- Specified by:
asDescendingMapOfRangesin interfaceRangeMap<K extends Comparable<?>,V>
-
subRangeMap
Description copied from interface:RangeMapReturns a view of the part of this range map that intersects withrange.For example, if
rangeMaphad 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
IllegalArgumentExceptionon an attempt to insert a range not enclosed byrange.- Specified by:
subRangeMapin interfaceRangeMap<K extends Comparable<?>,V>
-
hashCode
public int hashCode()Description copied from interface:RangeMapReturnsasMapOfRanges().hashCode(). -
equals
Description copied from interface:RangeMap -
toString
Description copied from interface:RangeMapReturns a readable string representation of this range map. -
writeReplace
Object writeReplace() -
readObject
- Throws:
InvalidObjectException
-