Package com.google.common.collect

Class ImmutableRangeSet<C extends Comparable>

java.lang.Object
com.google.common.collect.ImmutableRangeSet<C>
All Implemented Interfaces:
RangeSet<C>, Serializable
@Beta @Deprecated(since="2022-12-01") public final class ImmutableRangeSet<C extends Comparable> extends Object implements Serializable
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
An efficient immutable implementation of a RangeSet.
Since:
14.0
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ImmutableRangeSet.Builder<C extends Comparable<?>>
    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
    void
    add(Range<C> range)
    Deprecated.
    Adds the specified range to this RangeSet (optional operation).
    void
    addAll(RangeSet<C> other)
    Deprecated.
    Adds all of the ranges from the specified range set to this range set (optional operation).
    ImmutableSet<Range<C>>
    asRanges()
    Deprecated.
    Returns a view of the disconnected ranges that make up this range set.
    ImmutableSortedSet<C>
    asSet(DiscreteDomain<C> domain)
    Deprecated.
    Returns an ImmutableSortedSet containing the same values in the given domain contained by this range set.
    static <C extends Comparable<?>>
    ImmutableRangeSet.Builder<C>
    builder()
    Deprecated.
    Returns a new builder for an immutable range set.
    void
    clear()
    Deprecated.
    Removes all ranges from this RangeSet (optional operation).
    ImmutableRangeSet<C>
    complement()
    Deprecated.
    Returns a view of the complement of this RangeSet.
    boolean
    contains(C value)
    Deprecated.
    Determines whether any of this range set's member ranges contains value.
    static <C extends Comparable>
    ImmutableRangeSet<C>
    copyOf(RangeSet<C> rangeSet)
    Deprecated.
    Returns an immutable copy of the specified RangeSet.
    boolean
    encloses(Range<C> otherRange)
    Deprecated.
    Returns true if there exists a member range in this range set which encloses the specified range.
    boolean
    enclosesAll(RangeSet<C> other)
    Deprecated.
    Returns true if for each member range in other there exists a member range in this range set which encloses it.
    boolean
    equals(Object obj)
    Deprecated.
    Returns true if obj is another RangeSet that contains the same ranges according to Range.equals(Object).
    final int
    hashCode()
    Deprecated.
    Returns asRanges().hashCode().
    boolean
    isEmpty()
    Deprecated.
    Returns true if this range set contains no ranges.
    static <C extends Comparable>
    ImmutableRangeSet<C>
    of()
    Deprecated.
    Returns an empty immutable range set.
    static <C extends Comparable>
    ImmutableRangeSet<C>
    of(Range<C> range)
    Deprecated.
    Returns an immutable range set containing the specified single range.
    Range<C>
    rangeContaining(C value)
    Deprecated.
    Returns the unique range from this range set that contains value, or null if this range set does not contain value.
    void
    remove(Range<C> range)
    Deprecated.
    Removes the specified range from this RangeSet (optional operation).
    void
    removeAll(RangeSet<C> other)
    Deprecated.
    Removes all of the ranges from the specified range set from this range set (optional operation).
    Range<C>
    span()
    Deprecated.
    Returns the minimal range which encloses all ranges in this range set.
    ImmutableRangeSet<C>
    subRangeSet(Range<C> range)
    Deprecated.
    Returns a view of the intersection of this range set with the given range.
    final String
    toString()
    Deprecated.
    Returns a readable string representation of this range set.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • of

      public static <C extends Comparable> ImmutableRangeSet<C> of()
      Deprecated.
      Returns an empty immutable range set.

    • of

      public static <C extends Comparable> ImmutableRangeSet<C> of(Range<C> range)
      Deprecated.
      Returns an immutable range set containing the specified single range. If range.isEmpty(), this is equivalent to of().

    • copyOf

      public static <C extends Comparable> ImmutableRangeSet<C> copyOf(RangeSet<C> rangeSet)
      Deprecated.
      Returns an immutable copy of the specified RangeSet.

    • encloses

      public boolean encloses(Range<C> otherRange)
      Deprecated.
      Description copied from interface: RangeSet
      Returns true if there exists a member range in this range set which encloses the specified range.
      Specified by:
      encloses in interface RangeSet<C extends Comparable>

    • rangeContaining

      public Range<C> rangeContaining(C value)
      Deprecated.
      Description copied from interface: RangeSet
      Returns the unique range from this range set that contains value, or null if this range set does not contain value.
      Specified by:
      rangeContaining in interface RangeSet<C extends Comparable>

    • span

      public Range<C> span()
      Deprecated.
      Description copied from interface: RangeSet
      Returns the minimal range which encloses all ranges in this range set.
      Specified by:
      span in interface RangeSet<C extends Comparable>

    • isEmpty

      public boolean isEmpty()
      Deprecated.
      Description copied from interface: RangeSet
      Returns true if this range set contains no ranges.
      Specified by:
      isEmpty in interface RangeSet<C extends Comparable>

    • add

      public void add(Range<C> range)
      Deprecated.
      Description copied from interface: RangeSet
      Adds the specified range to this RangeSet (optional operation). That is, for equal range sets a and b, the result of a.add(range) is that a will be the minimal range set for which both a.enclosesAll(b) and a.encloses(range).

      Note that range will be coalesced with any ranges in the range set that are connected with it. Moreover, if range is empty, this is a no-op.

      Specified by:
      add in interface RangeSet<C extends Comparable>

    • addAll

      public void addAll(RangeSet<C> other)
      Deprecated.
      Description copied from interface: RangeSet
      Adds all of the ranges from the specified range set to this range set (optional operation). After this operation, this range set is the minimal range set that encloses both the original range set and other.

      This is equivalent to calling RangeSet.add(com.google.common.collect.Range<C>) on each of the ranges in other in turn.

      Specified by:
      addAll in interface RangeSet<C extends Comparable>

    • remove

      public void remove(Range<C> range)
      Deprecated.
      Description copied from interface: RangeSet
      Removes the specified range from this RangeSet (optional operation). After this operation, if range.contains(c), this.contains(c) will return false.

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

      Specified by:
      remove in interface RangeSet<C extends Comparable>

    • removeAll

      public void removeAll(RangeSet<C> other)
      Deprecated.
      Description copied from interface: RangeSet
      Removes all of the ranges from the specified range set from this range set (optional operation). After this operation, if other.contains(c), this.contains(c) will return false.

      This is equivalent to calling RangeSet.remove(com.google.common.collect.Range<C>) on each of the ranges in other in turn.

      Specified by:
      removeAll in interface RangeSet<C extends Comparable>

    • asRanges

      public ImmutableSet<Range<C>> asRanges()
      Deprecated.
      Description copied from interface: RangeSet
      Returns a view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by its Iterable.iterator() method return the ranges in increasing order of lower bound (equivalently, of upper bound).
      Specified by:
      asRanges in interface RangeSet<C extends Comparable>

    • complement

      public ImmutableRangeSet<C> complement()
      Deprecated.
      Description copied from interface: RangeSet
      Returns a view of the complement of this RangeSet.

      The returned view supports the RangeSet.add(com.google.common.collect.Range<C>) operation if this RangeSet supports RangeSet.remove(com.google.common.collect.Range<C>), and vice versa.

      Specified by:
      complement in interface RangeSet<C extends Comparable>

    • subRangeSet

      public ImmutableRangeSet<C> subRangeSet(Range<C> range)
      Deprecated.
      Returns a view of the intersection of this range set with the given range.
      Specified by:
      subRangeSet in interface RangeSet<C extends Comparable>

    • asSet

      public ImmutableSortedSet<C> asSet(DiscreteDomain<C> domain)
      Deprecated.
      Returns an ImmutableSortedSet containing the same values in the given domain contained by this range set.

      Note: a.asSet(d).equals(b.asSet(d)) does not imply a.equals(b)! For example, a and b could be [2..4] and (1..5), or the empty ranges [3..3) and [4..4).

      Warning: Be extremely careful what you do with the asSet view of a large range set (such as ImmutableRangeSet.of(Range.greaterThan(0))). Certain operations on such a set can be performed efficiently, but others (such as Set.hashCode() or Collections.frequency(java.util.Collection<?>, java.lang.Object)) can cause major performance problems.

      The returned set's Object.toString() method returns a short-hand form of the set's contents, such as "[1..100]"}.

      Throws:
      IllegalArgumentException - if neither this range nor the domain has a lower bound, or if neither has an upper bound

    • builder

      public static <C extends Comparable<?>> ImmutableRangeSet.Builder<C> builder()
      Deprecated.
      Returns a new builder for an immutable range set.

    • contains

      public boolean contains(C value)
      Deprecated.
      Description copied from interface: RangeSet
      Determines whether any of this range set's member ranges contains value.
      Specified by:
      contains in interface RangeSet<C extends Comparable>

    • clear

      public void clear()
      Deprecated.
      Description copied from interface: RangeSet
      Removes all ranges from this RangeSet (optional operation). After this operation, this.contains(c) will return false for all c.

      This is equivalent to remove(Range.all()).

      Specified by:
      clear in interface RangeSet<C extends Comparable>

    • enclosesAll

      public boolean enclosesAll(RangeSet<C> other)
      Deprecated.
      Description copied from interface: RangeSet
      Returns true if for each member range in other there exists a member range in this range set which encloses it. It follows that this.contains(value) whenever other.contains(value). Returns true if other is empty.

      This is equivalent to checking if this range set RangeSet.encloses(com.google.common.collect.Range<C>) each of the ranges in other.

      Specified by:
      enclosesAll in interface RangeSet<C extends Comparable>

    • equals

      public boolean equals(@Nullable Object obj)
      Deprecated.
      Description copied from interface: RangeSet
      Returns true if obj is another RangeSet that contains the same ranges according to Range.equals(Object).
      Specified by:
      equals in interface RangeSet<C extends Comparable>
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Deprecated.
      Description copied from interface: RangeSet
      Returns asRanges().hashCode().
      Specified by:
      hashCode in interface RangeSet<C extends Comparable>
      Overrides:
      hashCode in class Object

    • toString

      public final String toString()
      Deprecated.
      Description copied from interface: RangeSet
      Returns a readable string representation of this range set. For example, if this RangeSet consisted of Range.closed(1, 3) and Range.greaterThan(4), this might return " [1‥3](4‥+∞)"}.
      Specified by:
      toString in interface RangeSet<C extends Comparable>
      Overrides:
      toString in class Object