Package com.google.common.collect

Class ImmutableRangeSet<C extends java.lang.Comparable>

  • All Implemented Interfaces:
    RangeSet<C>, java.io.Serializable
    public final class ImmutableRangeSet<C extends java.lang.Comparable>
extends AbstractRangeSet<C>
implements java.io.Serializable
    A RangeSet whose contents will never change, with many other important properties detailed at ImmutableCollection.
    Since:
    14.0
    See Also:
    Serialized Form

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

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

      • all

        static <C extends java.lang.Comparable> ImmutableRangeSet<C> all()
        Returns an immutable range set containing the single range Range.all().

      • 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>
        Overrides:
        intersects in class AbstractRangeSet<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>
        Specified by:
        encloses in class AbstractRangeSet<C extends java.lang.Comparable>

      • rangeContaining

        public Range<C> rangeContaining​(C value)
        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 java.lang.Comparable>
        Specified by:
        rangeContaining in class AbstractRangeSet<C extends java.lang.Comparable>

      • span

        public Range<C> span()
        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>
        Overrides:
        isEmpty in class AbstractRangeSet<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>
        Overrides:
        add in class AbstractRangeSet<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>
        Overrides:
        addAll in class AbstractRangeSet<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>
        Overrides:
        remove in class AbstractRangeSet<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>
        Overrides:
        removeAll in class AbstractRangeSet<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<C> union​(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<C> intersection​(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<C> difference​(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

      • intersectRanges

        private ImmutableList<Range<C>> intersectRanges​(Range<C> range)
        Returns a list containing the nonempty intersections of range with the ranges in this range set.

      • subRangeSet

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

      • asSet

        public ImmutableSortedSet<C> asSet​(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

      • isPartialView

        boolean isPartialView()
        Returns true if this immutable range set's implementation contains references to user-created objects that aren't accessible via this range set's methods. This is generally used to determine whether copyOf implementations should make an explicit copy to avoid memory leaks.

      • builder

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

      • writeReplace

        java.lang.Object writeReplace()