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 class
private static class
static class
ImmutableRangeSet.Builder<C extends Comparable<?>>
A builder for immutable range sets.private final class
private static final class
ImmutableRangeSet.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) private
ImmutableRangeSet
(ImmutableList<Range<C>> ranges, ImmutableRangeSet<C> complement) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.Unsupported operation.void
Deprecated.Unsupported operation.void
Deprecated.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 anImmutableSortedSet
containing 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 anImmutableRangeSet
containing each of the specified disjoint ranges.difference
(RangeSet<C> other) Returns a new range set consisting of the difference of this range set andother
.boolean
Returnstrue
if 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 ofrange
with the ranges in this range set.boolean
intersects
(Range<C> otherRange) Returnstrue
if there exists a non-empty range enclosed by both a member range in this range set and the specified range.boolean
isEmpty()
Returnstrue
if this range set contains no ranges.(package private) boolean
Returnstrue
if 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
, ornull
if this range set does not containvalue
.private void
readObject
(ObjectInputStream stream) void
Deprecated.Unsupported operation.void
Deprecated.Unsupported operation.void
Deprecated.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 aCollector
that 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 anImmutableRangeSet
representing the union of the specified ranges.(package private) Object
Methods inherited from class com.google.common.collect.AbstractRangeSet
clear, contains, enclosesAll, equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods 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 aCollector
that 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 anImmutableRangeSet
containing 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 anImmutableRangeSet
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
Description copied from interface:RangeSet
Returnstrue
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 callingsubRangeSet(otherRange)
and testing whether the resulting range set is non-empty.- Specified by:
intersects
in interfaceRangeSet<C extends Comparable>
- Overrides:
intersects
in classAbstractRangeSet<C extends Comparable>
-
encloses
Description copied from interface:RangeSet
Returnstrue
if there exists a member range in this range set which encloses the specified range.- Specified by:
encloses
in interfaceRangeSet<C extends Comparable>
- Specified by:
encloses
in classAbstractRangeSet<C extends Comparable>
-
rangeContaining
Description copied from interface:RangeSet
Returns the unique range from this range set that containsvalue
, ornull
if this range set does not containvalue
.- Specified by:
rangeContaining
in interfaceRangeSet<C extends Comparable>
- Specified by:
rangeContaining
in classAbstractRangeSet<C extends Comparable>
-
span
Description copied from interface:RangeSet
Returns the minimal range which encloses all ranges in this range set.- Specified by:
span
in interfaceRangeSet<C extends Comparable>
-
isEmpty
public boolean isEmpty()Description copied from interface:RangeSet
Returnstrue
if this range set contains no ranges.- Specified by:
isEmpty
in interfaceRangeSet<C extends Comparable>
- Overrides:
isEmpty
in classAbstractRangeSet<C extends Comparable>
-
add
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
add
in interfaceRangeSet<C extends Comparable>
- Overrides:
add
in classAbstractRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
addAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
addAll
in interfaceRangeSet<C extends Comparable>
- Overrides:
addAll
in classAbstractRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
addAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
addAll
in interfaceRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
remove
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
remove
in interfaceRangeSet<C extends Comparable>
- Overrides:
remove
in classAbstractRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
removeAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
removeAll
in interfaceRangeSet<C extends Comparable>
- Overrides:
removeAll
in classAbstractRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
removeAll
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
removeAll
in interfaceRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
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 itsIterable.iterator()
method return the ranges in increasing order of lower bound (equivalently, of upper bound).- Specified by:
asRanges
in interfaceRangeSet<C extends Comparable>
-
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 itsIterable.iterator()
method return the ranges in decreasing order of lower bound (equivalently, of upper bound).- Specified by:
asDescendingSetOfRanges
in interfaceRangeSet<C extends Comparable>
-
complement
Description copied from interface:RangeSet
Returns a view of the complement of thisRangeSet
.The returned view supports the
RangeSet.add(com.google.common.collect.Range<C>)
operation if thisRangeSet
supportsRangeSet.remove(com.google.common.collect.Range<C>)
, and vice versa.- Specified by:
complement
in 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 ofrange
with the ranges in this range set. -
subRangeSet
Returns a view of the intersection of this range set with the given range.- Specified by:
subRangeSet
in interfaceRangeSet<C extends Comparable>
-
asSet
Returns anImmutableSortedSet
containing 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,a
andb
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 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()Returnstrue
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 whethercopyOf
implementations 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
-