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

  • All Implemented Interfaces:

    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.

    • Method Detail

      • 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.
      • 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.

        Specified by:
        get in interface RangeMap<K extends Comparable<?>,​V>
      • 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.
        Specified by:
        getEntry in interface RangeMap<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), if range.contains(k), then get(k) will return value.

        If range is empty, then this is a no-op.

        Specified by:
        put in interface RangeMap<K extends Comparable<?>,​V>
      • 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).
        Specified by:
        putAll in interface RangeMap<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 interface RangeMap<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 to remove(range). If range.contains(k), then after a call to remove(range), get(k) will return null.

        Specified by:
        remove in interface RangeMap<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 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.

        Specified by:
        asMapOfRanges in interface RangeMap<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 with range.

        For example, if rangeMap had the entries [1, 5] => "foo", (6, 8) => "bar", (10, ‥) => "baz" then rangeMap.subRangeMap(, 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.

        Specified by:
        subRangeMap in interface RangeMap<K extends Comparable<?>,​V>