Package com.google.common.collect

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

java.lang.Object
com.google.common.collect.ImmutableRangeMap<K,V>
All Implemented Interfaces:
RangeMap<K,V>
@Beta @GwtIncompatible("NavigableMap") @Deprecated(since="2022-12-01") public class ImmutableRangeMap<K extends Comparable<?>,V> extends Object implements RangeMap<K,V>
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
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
    Description
    static final class 
    ImmutableRangeMap.Builder<K extends Comparable<?>,V>
    Deprecated.
    The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023

  • Method Summary

    Modifier and Type
    Method
    Description
    ImmutableMap<Range<K>,V>
    asMapOfRanges()
    Deprecated.
    Returns a view of this range map as an unmodifiable Map<Range<K>, V>.
    static <K extends Comparable<?>, V>
    ImmutableRangeMap.Builder<K,V>
    builder()
    Deprecated.
    Returns a new builder for an immutable range map.
    void
    clear()
    Deprecated.
    Removes all associations from this range map (optional operation).
    static <K extends Comparable<?>, V>
    ImmutableRangeMap<K,V>
    copyOf(RangeMap<K,? extends V> rangeMap)
    Deprecated.
     
    boolean
    equals(Object o)
    Deprecated.
    Returns true if obj is another RangeMap that has an equivalent RangeMap.asMapOfRanges().
    V
    get(K key)
    Deprecated.
    Returns the value associated with the specified key, or null if there is no such value.
    Map.Entry<Range<K>,V>
    getEntry(K key)
    Deprecated.
    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()
    Deprecated.
    Returns asMapOfRanges().hashCode().
    static <K extends Comparable<?>, V>
    ImmutableRangeMap<K,V>
    of()
    Deprecated.
    Returns an empty immutable range map.
    static <K extends Comparable<?>, V>
    ImmutableRangeMap<K,V>
    of(Range<K> range, V value)
    Deprecated.
    Returns an immutable range map mapping a single range to a single value.
    void
    put(Range<K> range, V value)
    Deprecated.
    Maps a range to a specified value (optional operation).
    void
    putAll(RangeMap<K,V> rangeMap)
    Deprecated.
    Puts all the associations from rangeMap into this range map (optional operation).
    void
    remove(Range<K> range)
    Deprecated.
    Removes all associations from this range map in the specified range (optional operation).
    Range<K>
    span()
    Deprecated.
    Returns the minimal range enclosing the ranges in this RangeMap.
    ImmutableRangeMap<K,V>
    subRangeMap(Range<K> range)
    Deprecated.
    Returns a view of the part of this range map that intersects with range.
    String
    toString()
    Deprecated.
    Returns a readable string representation of this range map.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • of

      public static <K extends Comparable<?>, V> ImmutableRangeMap<K,V> of()
      Deprecated.
      Returns an empty immutable range map.

    • of

      public static <K extends Comparable<?>, V> ImmutableRangeMap<K,V> of(Range<K> range, V value)
      Deprecated.
      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)
      Deprecated.

    • builder

      public static <K extends Comparable<?>, V> ImmutableRangeMap.Builder<K,V> builder()
      Deprecated.
      Returns a new builder for an immutable range map.

    • get

      @Nullable public V get(K key)
      Deprecated.
      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

      @Nullable public Map.Entry<Range<K>,V> getEntry(K key)
      Deprecated.
      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>

    • span

      public Range<K> span()
      Deprecated.
      Description copied from interface: RangeMap
      Returns the minimal range enclosing the ranges in this RangeMap.
      Specified by:
      span in interface RangeMap<K extends Comparable<?>,V>

    • put

      public void put(Range<K> range, V value)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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.

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

    • hashCode

      public int hashCode()
      Deprecated.
      Description copied from interface: RangeMap
      Returns asMapOfRanges().hashCode().
      Specified by:
      hashCode in interface RangeMap<K extends Comparable<?>,V>
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object o)
      Deprecated.
      Description copied from interface: RangeMap
      Returns true if obj is another RangeMap that has an equivalent RangeMap.asMapOfRanges().
      Specified by:
      equals in interface RangeMap<K extends Comparable<?>,V>
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Deprecated.
      Description copied from interface: RangeMap
      Returns a readable string representation of this range map.
      Specified by:
      toString in interface RangeMap<K extends Comparable<?>,V>
      Overrides:
      toString in class Object