Class ImmutableRangeSet<C extends java.lang.Comparable>

    • Method Detail

      • toImmutableRangeSet

        public static <E extends java.lang.Comparable<? super E>> java.util.stream.Collector<Range<E>,​?,​ImmutableRangeSet<E>> toImmutableRangeSet()
        Returns a Collector that accumulates the input elements into a new ImmutableRangeSet. As in ImmutableRangeSet.Builder, overlapping ranges are not permitted and adjacent ranges will be merged.
        Since:
        23.1
      • 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 short-hand 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>
      • equals

        public boolean equals​(@CheckForNull
                              java.lang.Object obj)
        Description copied from class: java.lang.Object
        Indicates whether some other object is "equal to" this one.

        The equals method implements an equivalence relation on non-null object references:

        • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
        • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
        • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
        • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
        • For any non-null reference value x, x.equals(null) should return false.

        The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

        Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

        Specified by:
        equals in interface RangeSet<C extends java.lang.Comparable>
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        Object.hashCode(), HashMap
      • hashCode

        public final int hashCode()
        Description copied from class: java.lang.Object
        Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

        The general contract of hashCode is:

        • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
        • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
        • It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

        As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

        Specified by:
        hashCode in interface RangeSet<C extends java.lang.Comparable>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for this object.
        See Also:
        Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
      • toString

        public final java.lang.String toString()
        Description copied from class: java.lang.Object
        Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

        The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

         getClass().getName() + '@' + Integer.toHexString(hashCode())
         
        Specified by:
        toString in interface RangeSet<C extends java.lang.Comparable>
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the object.