Class ImmutableRangeSet<C extends Comparable>
- All Implemented Interfaces:
RangeSet<C>,Serializable
RangeSet whose contents will never change, with many other important properties
detailed at ImmutableCollection.- Since:
- 14.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate final classprivate static classstatic classImmutableRangeSet.Builder<C extends Comparable<?>>A builder for immutable range sets.private final classprivate static final classImmutableRangeSet.SerializedForm<C extends Comparable> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ImmutableRangeSet<Comparable<?>>private ImmutableRangeSet<C>private static final ImmutableRangeSet<Comparable<?>>private final ImmutableList<Range<C>> -
Constructor Summary
ConstructorsModifierConstructorDescription(package private)ImmutableRangeSet(ImmutableList<Range<C>> ranges) privateImmutableRangeSet(ImmutableList<Range<C>> ranges, ImmutableRangeSet<C> complement) -
Method Summary
Modifier and TypeMethodDescriptionvoidDeprecated.Unsupported operation.voidDeprecated.Unsupported operation.voidDeprecated.Unsupported operation.(package private) static <C extends Comparable>
ImmutableRangeSet<C>all()Returns an immutable range set containing the single rangeRange.all().Returns a descending view of the disconnected ranges that make up this range set.asRanges()Returns a view of the disconnected ranges that make up this range set.asSet(DiscreteDomain<C> domain) Returns anImmutableSortedSetcontaining the same values in the given domain contained by this range set.static <C extends Comparable<?>>
ImmutableRangeSet.Builder<C>builder()Returns a new builder for an immutable range set.Returns a view of the complement of thisRangeSet.static <C extends Comparable>
ImmutableRangeSet<C>Returns an immutable copy of the specifiedRangeSet.static <C extends Comparable<?>>
ImmutableRangeSet<C>Returns anImmutableRangeSetcontaining each of the specified disjoint ranges.difference(RangeSet<C> other) Returns a new range set consisting of the difference of this range set andother.booleanReturnstrueif there exists a member range in this range set which encloses the specified range.intersection(RangeSet<C> other) Returns a new range set consisting of the intersection of this range set andother.private ImmutableList<Range<C>>intersectRanges(Range<C> range) Returns a list containing the nonempty intersections ofrangewith the ranges in this range set.booleanintersects(Range<C> otherRange) Returnstrueif there exists a non-empty range enclosed by both a member range in this range set and the specified range.booleanisEmpty()Returnstrueif this range set contains no ranges.(package private) booleanReturnstrueif this immutable range set's implementation contains references to user-created objects that aren't accessible via this range set's methods.static <C extends Comparable>
ImmutableRangeSet<C>of()Returns an empty immutable range set.static <C extends Comparable>
ImmutableRangeSet<C>Returns an immutable range set containing the specified single range.rangeContaining(C value) Returns the unique range from this range set that containsvalue, ornullif this range set does not containvalue.private voidreadObject(ObjectInputStream stream) voidDeprecated.Unsupported operation.voidDeprecated.Unsupported operation.voidDeprecated.Unsupported operation.span()Returns the minimal range which encloses all ranges in this range set.subRangeSet(Range<C> range) Returns a view of the intersection of this range set with the given range.static <E extends Comparable<? super E>>
Collector<Range<E>,?, ImmutableRangeSet<E>> Returns aCollectorthat accumulates the input elements into a newImmutableRangeSet.Returns a new range set consisting of the union of this range set andother.static <C extends Comparable<?>>
ImmutableRangeSet<C>Returns anImmutableRangeSetrepresenting the union of the specified ranges.(package private) ObjectMethods inherited from class com.google.common.collect.AbstractRangeSet
clear, contains, enclosesAll, equals, hashCode, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.common.collect.RangeSet
enclosesAll
-
Field Details
-
EMPTY
-
ALL
-
ranges
-
complement
-
-
Constructor Details
-
ImmutableRangeSet
ImmutableRangeSet(ImmutableList<Range<C>> ranges) -
ImmutableRangeSet
-
-
Method Details
-
toImmutableRangeSet
public static <E extends Comparable<? super E>> Collector<Range<E>,?, toImmutableRangeSet()ImmutableRangeSet<E>> Returns aCollectorthat accumulates the input elements into a newImmutableRangeSet. As inImmutableRangeSet.Builder, overlapping ranges are not permitted and adjacent ranges will be merged.- Since:
- 23.1
-
of
Returns an empty immutable range set.Performance note: the instance returned is a singleton.
-
of
Returns an immutable range set containing the specified single range. Ifrange.isEmpty(), this is equivalent toof(). -
all
Returns an immutable range set containing the single rangeRange.all(). -
copyOf
Returns an immutable copy of the specifiedRangeSet. -
copyOf
Returns anImmutableRangeSetcontaining each of the specified disjoint ranges. Overlapping ranges and empty ranges are forbidden, though adjacent ranges are permitted and will be merged.- Throws:
IllegalArgumentException- if any ranges overlap or are empty- Since:
- 21.0
-
unionOf
Returns anImmutableRangeSetrepresenting the union of the specified ranges.This is the smallest
RangeSetwhich encloses each of the specified ranges. Duplicate or connected ranges are permitted, and will be coalesced in the result.- Since:
- 21.0
-
intersects
Description copied from interface:RangeSetReturnstrueif there exists a non-empty range enclosed by both a member range in this range set and the specified range. This is equivalent to callingsubRangeSet(otherRange)and testing whether the resulting range set is non-empty.- Specified by:
intersectsin interfaceRangeSet<C extends Comparable>- Overrides:
intersectsin classAbstractRangeSet<C extends Comparable>
-
encloses
Description copied from interface:RangeSetReturnstrueif there exists a member range in this range set which encloses the specified range.- Specified by:
enclosesin interfaceRangeSet<C extends Comparable>- Specified by:
enclosesin classAbstractRangeSet<C extends Comparable>
-
rangeContaining
Description copied from interface:RangeSetReturns the unique range from this range set that containsvalue, ornullif this range set does not containvalue.- Specified by:
rangeContainingin interfaceRangeSet<C extends Comparable>- Specified by:
rangeContainingin classAbstractRangeSet<C extends Comparable>
-
span
Description copied from interface:RangeSetReturns the minimal range which encloses all ranges in this range set.- Specified by:
spanin interfaceRangeSet<C extends Comparable>
-
isEmpty
public boolean isEmpty()Description copied from interface:RangeSetReturnstrueif this range set contains no ranges.- Specified by:
isEmptyin interfaceRangeSet<C extends Comparable>- Overrides:
isEmptyin classAbstractRangeSet<C extends Comparable>
-
add
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSetunmodified.- Specified by:
addin interfaceRangeSet<C extends Comparable>- Overrides:
addin classAbstractRangeSet<C extends Comparable>- Throws:
UnsupportedOperationException- always
-
addAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSetunmodified.- Specified by:
addAllin interfaceRangeSet<C extends Comparable>- Overrides:
addAllin classAbstractRangeSet<C extends Comparable>- Throws:
UnsupportedOperationException- always
-
addAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSetunmodified.- Specified by:
addAllin interfaceRangeSet<C extends Comparable>- Throws:
UnsupportedOperationException- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSetunmodified.- Specified by:
removein interfaceRangeSet<C extends Comparable>- Overrides:
removein classAbstractRangeSet<C extends Comparable>- Throws:
UnsupportedOperationException- always
-
removeAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSetunmodified.- Specified by:
removeAllin interfaceRangeSet<C extends Comparable>- Overrides:
removeAllin classAbstractRangeSet<C extends Comparable>- Throws:
UnsupportedOperationException- always
-
removeAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSetunmodified.- Specified by:
removeAllin interfaceRangeSet<C extends Comparable>- Throws:
UnsupportedOperationException- always
-
asRanges
Description copied from interface:RangeSetReturns a view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by itsIterable.iterator()method return the ranges in increasing order of lower bound (equivalently, of upper bound).- Specified by:
asRangesin interfaceRangeSet<C extends Comparable>
-
asDescendingSetOfRanges
Description copied from interface:RangeSetReturns a descending view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by itsIterable.iterator()method return the ranges in decreasing order of lower bound (equivalently, of upper bound).- Specified by:
asDescendingSetOfRangesin interfaceRangeSet<C extends Comparable>
-
complement
Description copied from interface:RangeSetReturns a view of the complement of thisRangeSet.The returned view supports the
RangeSet.add(com.google.common.collect.Range<C>)operation if thisRangeSetsupportsRangeSet.remove(com.google.common.collect.Range<C>), and vice versa.- Specified by:
complementin interfaceRangeSet<C extends Comparable>
-
union
Returns a new range set consisting of the union of this range set andother.This is essentially the same as
TreeRangeSet.create(this).addAll(other)except it returns anImmutableRangeSet.- Since:
- 21.0
-
intersection
Returns a new range set consisting of the intersection of this range set andother.This is essentially the same as
TreeRangeSet.create(this).removeAll(other.complement())except it returns anImmutableRangeSet.- Since:
- 21.0
-
difference
Returns a new range set consisting of the difference of this range set andother.This is essentially the same as
TreeRangeSet.create(this).removeAll(other)except it returns anImmutableRangeSet.- Since:
- 21.0
-
intersectRanges
Returns a list containing the nonempty intersections ofrangewith the ranges in this range set. -
subRangeSet
Returns a view of the intersection of this range set with the given range.- Specified by:
subRangeSetin interfaceRangeSet<C extends Comparable>
-
asSet
Returns anImmutableSortedSetcontaining the same values in the given domain contained by this range set.Note:
a.asSet(d).equals(b.asSet(d))does not implya.equals(b)! For example,aandbcould be[2..4]and(1..5), or the empty ranges[3..3)and[4..4).Warning: Be extremely careful what you do with the
asSetview of a large range set (such asImmutableRangeSet.of(Range.greaterThan(0))). Certain operations on such a set can be performed efficiently, but others (such asSet.hashCode()orCollections.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:
IllegalArgumentException- if neither this range nor the domain has a lower bound, or if neither has an upper bound
-
isPartialView
boolean isPartialView()Returnstrueif 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 whethercopyOfimplementations should make an explicit copy to avoid memory leaks. -
builder
Returns a new builder for an immutable range set. -
writeReplace
Object writeReplace() -
readObject
- Throws:
InvalidObjectException
-