Class ImmutableRangeSet<C extends java.lang.Comparable>

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ImmutableRangeSet.Builder<C extends java.lang.Comparable<?>>
      A builder for immutable range sets.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void add​(Range<C> range)
      Deprecated.
      Unsupported operation.
      void addAll​(RangeSet<C> other)
      Deprecated.
      Unsupported operation.
      void addAll​(java.lang.Iterable<Range<C>> other)
      Deprecated.
      Unsupported operation.
      ImmutableSet<Range<C>> asDescendingSetOfRanges()
      Returns a descending view of the disconnected ranges that make up this range set.
      ImmutableSet<Range<C>> asRanges()
      Returns a view of the disconnected ranges that make up this range set.
      ImmutableSortedSet<C> asSet​(DiscreteDomain<C> domain)
      Returns an ImmutableSortedSet containing the same values in the given domain contained by this range set.
      static <C extends java.lang.Comparable<?>>
      ImmutableRangeSet.Builder<C>
      builder()
      Returns a new builder for an immutable range set.
      void clear()
      Removes all ranges from this RangeSet (optional operation).
      ImmutableRangeSet<C> complement()
      Returns a view of the complement of this RangeSet.
      boolean contains​(C value)
      Determines whether any of this range set's member ranges contains value.
      static <C extends java.lang.Comparable>
      ImmutableRangeSet<C>
      copyOf​(RangeSet<C> rangeSet)
      Returns an immutable copy of the specified RangeSet.
      static <C extends java.lang.Comparable<?>>
      ImmutableRangeSet<C>
      copyOf​(java.lang.Iterable<Range<C>> ranges)
      Returns an ImmutableRangeSet containing each of the specified disjoint ranges.
      ImmutableRangeSet<C> difference​(RangeSet<C> other)
      Returns a new range set consisting of the difference of this range set and other.
      boolean encloses​(Range<C> otherRange)
      Returns true if there exists a member range in this range set which encloses the specified range.
      boolean enclosesAll​(RangeSet<C> other)
      Returns true if for each member range in other there exists a member range in this range set which encloses it.
      boolean enclosesAll​(java.lang.Iterable<Range<C>> ranges)
      Returns true if for each range in other there exists a member range in this range set which encloses it.
      boolean equals​(java.lang.Object obj)
      Returns true if obj is another RangeSet that contains the same ranges according to Range.equals(Object).
      int hashCode()
      Returns asRanges().hashCode().
      ImmutableRangeSet<C> intersection​(RangeSet<C> other)
      Returns a new range set consisting of the intersection of this range set and other.
      boolean intersects​(Range<C> otherRange)
      Returns true if there exists a non-empty range enclosed by both a member range in this range set and the specified range.
      boolean isEmpty()
      Returns true if this range set contains no ranges.
      static <C extends java.lang.Comparable>
      ImmutableRangeSet<C>
      of()
      Returns an empty immutable range set.
      static <C extends java.lang.Comparable>
      ImmutableRangeSet<C>
      of​(Range<C> range)
      Returns an immutable range set containing the specified single range.
      Range<C> rangeContaining​(C value)
      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.
      Unsupported operation.
      void removeAll​(RangeSet<C> other)
      Deprecated.
      Unsupported operation.
      void removeAll​(java.lang.Iterable<Range<C>> other)
      Deprecated.
      Unsupported operation.
      Range<C> span()
      Returns the minimal range which encloses all ranges in this range set.
      ImmutableRangeSet<C> subRangeSet​(Range<C> range)
      Returns a view of the intersection of this range set with the given range.
      java.lang.String toString()
      Returns a readable string representation of this range set.
      ImmutableRangeSet<C> union​(RangeSet<C> other)
      Returns a new range set consisting of the union of this range set and other.
      static <C extends java.lang.Comparable<?>>
      ImmutableRangeSet<C>
      unionOf​(java.lang.Iterable<Range<C>> ranges)
      Returns an ImmutableRangeSet representing the union of the specified ranges.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • of

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

        Performance note: the instance returned is a singleton.

      • of

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

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

        public static <C extends java.lang.Comparable<?>> ImmutableRangeSet<C> copyOf​(java.lang.Iterable<Range<C>> ranges)
        Returns an ImmutableRangeSet containing each of the specified disjoint ranges. Overlapping ranges and empty ranges are forbidden, though adjacent ranges are permitted and will be merged.
        Throws:
        java.lang.IllegalArgumentException - if any ranges overlap or are empty
        Since:
        21.0
      • unionOf

        public static <C extends java.lang.Comparable<?>> ImmutableRangeSet<C> unionOf​(java.lang.Iterable<Range<C>> ranges)
        Returns an ImmutableRangeSet representing the union of the specified ranges.

        This is the smallest RangeSet which encloses each of the specified ranges. Duplicate or connected ranges are permitted, and will be coalesced in the result.

        Since:
        21.0
      • intersects

        public boolean intersects​(Range<C> otherRange)
        Description copied from interface: RangeSet
        Returns true if there exists a non-empty range enclosed by both a member range in this range set and the specified range. This is equivalent to calling subRangeSet(otherRange) and testing whether the resulting range set is non-empty.
        Specified by:
        intersects in interface RangeSet<C extends java.lang.Comparable>
      • encloses

        public boolean encloses​(Range<C> otherRange)
        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 java.lang.Comparable>
      • span

        public Range<Cspan()
        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 java.lang.Comparable>
      • isEmpty

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

        @Deprecated
        public void add​(Range<C> range)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the RangeSet unmodified.
        Specified by:
        add in interface RangeSet<C extends java.lang.Comparable>
        Throws:
        java.lang.UnsupportedOperationException - always
      • addAll

        @Deprecated
        public void addAll​(RangeSet<C> other)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the RangeSet unmodified.
        Specified by:
        addAll in interface RangeSet<C extends java.lang.Comparable>
        Throws:
        java.lang.UnsupportedOperationException - always
      • addAll

        @Deprecated
        public void addAll​(java.lang.Iterable<Range<C>> other)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the RangeSet unmodified.
        Specified by:
        addAll in interface RangeSet<C extends java.lang.Comparable>
        Throws:
        java.lang.UnsupportedOperationException - always
      • remove

        @Deprecated
        public void remove​(Range<C> range)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the RangeSet unmodified.
        Specified by:
        remove in interface RangeSet<C extends java.lang.Comparable>
        Throws:
        java.lang.UnsupportedOperationException - always
      • removeAll

        @Deprecated
        public void removeAll​(RangeSet<C> other)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the RangeSet unmodified.
        Specified by:
        removeAll in interface RangeSet<C extends java.lang.Comparable>
        Throws:
        java.lang.UnsupportedOperationException - always
      • removeAll

        @Deprecated
        public void removeAll​(java.lang.Iterable<Range<C>> other)
        Deprecated.
        Unsupported operation.
        Guaranteed to throw an exception and leave the RangeSet unmodified.
        Specified by:
        removeAll in interface RangeSet<C extends java.lang.Comparable>
        Throws:
        java.lang.UnsupportedOperationException - always
      • asRanges

        public ImmutableSet<Range<C>> asRanges()
        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 java.lang.Comparable>
      • asDescendingSetOfRanges

        public ImmutableSet<Range<C>> asDescendingSetOfRanges()
        Description copied from interface: RangeSet
        Returns a descending 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 decreasing order of lower bound (equivalently, of upper bound).
        Specified by:
        asDescendingSetOfRanges in interface RangeSet<C extends java.lang.Comparable>
      • union

        public ImmutableRangeSet<Cunion​(RangeSet<C> other)
        Returns a new range set consisting of the union of this range set and other.

        This is essentially the same as TreeRangeSet.create(this).addAll(other) except it returns an ImmutableRangeSet.

        Since:
        21.0
      • intersection

        public ImmutableRangeSet<Cintersection​(RangeSet<C> other)
        Returns a new range set consisting of the intersection of this range set and other.

        This is essentially the same as TreeRangeSet.create(this).removeAll(other.complement()) except it returns an ImmutableRangeSet.

        Since:
        21.0
      • difference

        public ImmutableRangeSet<Cdifference​(RangeSet<C> other)
        Returns a new range set consisting of the difference of this range set and other.

        This is essentially the same as TreeRangeSet.create(this).removeAll(other) except it returns an ImmutableRangeSet.

        Since:
        21.0
      • asSet

        public ImmutableSortedSet<CasSet​(DiscreteDomain<C> domain)
        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 shorthand form of the set's contents, such as "[1..100]"}.

        Throws:
        java.lang.IllegalArgumentException - if neither this range nor the domain has a lower bound, or if neither has an upper bound
      • contains

        public boolean contains​(C value)
        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 java.lang.Comparable>
      • clear

        public void clear()
        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 java.lang.Comparable>
      • enclosesAll

        public boolean enclosesAll​(RangeSet<C> other)
        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 java.lang.Comparable>
      • enclosesAll

        public boolean enclosesAll​(java.lang.Iterable<Range<C>> ranges)
        Description copied from interface: RangeSet
        Returns true if for each range in other there exists a member range in this range set which encloses it. Returns true if other is empty.

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

        Specified by:
        enclosesAll in interface RangeSet<C extends java.lang.Comparable>
      • equals

        public boolean equals​(@CheckForNull
                              java.lang.Object obj)
        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 java.lang.Comparable>
        Overrides:
        equals in class java.lang.Object
      • hashCode

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

        public final java.lang.String toString()
        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 java.lang.Comparable>
        Overrides:
        toString in class java.lang.Object