Class ImmutableRangeSet<C extends java.lang.Comparable>
- java.lang.Object
-
- com.google.common.collect.ImmutableRangeSet<C>
-
- All Implemented Interfaces:
RangeSet<C>
,java.io.Serializable
@GwtIncompatible public final class ImmutableRangeSet<C extends java.lang.Comparable> extends java.lang.Object implements java.io.Serializable
ARangeSet
whose contents will never change, with many other important properties detailed atImmutableCollection
.- Since:
- 14.0
- Author:
- Louis Wasserman
- See Also:
- Serialized Form
-
-
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 anImmutableSortedSet
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 thisRangeSet
(optional operation).ImmutableRangeSet<C>
complement()
Returns a view of the complement of thisRangeSet
.boolean
contains(C value)
Determines whether any of this range set's member ranges containsvalue
.static <C extends java.lang.Comparable>
ImmutableRangeSet<C>copyOf(RangeSet<C> rangeSet)
Returns an immutable copy of the specifiedRangeSet
.static <C extends java.lang.Comparable<?>>
ImmutableRangeSet<C>copyOf(java.lang.Iterable<Range<C>> ranges)
Returns anImmutableRangeSet
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 andother
.boolean
encloses(Range<C> otherRange)
Returnstrue
if there exists a member range in this range set which encloses the specified range.boolean
enclosesAll(RangeSet<C> other)
Returnstrue
if for each member range inother
there exists a member range in this range set which encloses it.boolean
enclosesAll(java.lang.Iterable<Range<C>> ranges)
Returnstrue
if for each range inother
there exists a member range in this range set which encloses it.boolean
equals(java.lang.Object obj)
Returnstrue
ifobj
is anotherRangeSet
that contains the same ranges according toRange.equals(Object)
.int
hashCode()
ReturnsasRanges().hashCode()
.ImmutableRangeSet<C>
intersection(RangeSet<C> other)
Returns a new range set consisting of the intersection of this range set andother
.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.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 containsvalue
, ornull
if this range set does not containvalue
.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 andother
.static <C extends java.lang.Comparable<?>>
ImmutableRangeSet<C>unionOf(java.lang.Iterable<Range<C>> ranges)
Returns anImmutableRangeSet
representing the union of the specified ranges.
-
-
-
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. Ifrange.isEmpty()
, this is equivalent toof()
.
-
copyOf
public static <C extends java.lang.Comparable> ImmutableRangeSet<C> copyOf(RangeSet<C> rangeSet)
Returns an immutable copy of the specifiedRangeSet
.
-
copyOf
public static <C extends java.lang.Comparable<?>> ImmutableRangeSet<C> copyOf(java.lang.Iterable<Range<C>> ranges)
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:
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 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
public boolean intersects(Range<C> otherRange)
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 java.lang.Comparable>
-
encloses
public boolean encloses(Range<C> otherRange)
Description copied from interface:RangeSet
Returnstrue
if there exists a member range in this range set which encloses the specified range.
-
rangeContaining
@CheckForNull public Range<C> rangeContaining(C value)
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 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.
-
isEmpty
public boolean isEmpty()
Description copied from interface:RangeSet
Returnstrue
if this range set contains no ranges.
-
add
@Deprecated public void add(Range<C> range)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.
-
addAll
@Deprecated public void addAll(RangeSet<C> other)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.
-
addAll
@Deprecated public void addAll(java.lang.Iterable<Range<C>> other)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.
-
remove
@Deprecated public void remove(Range<C> range)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.
-
removeAll
@Deprecated public void removeAll(RangeSet<C> other)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.
-
removeAll
@Deprecated public void removeAll(java.lang.Iterable<Range<C>> other)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.
-
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 itsIterable.iterator()
method return the ranges in increasing order of lower bound (equivalently, of upper bound).
-
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 itsIterable.iterator()
method return the ranges in decreasing order of lower bound (equivalently, of upper bound).- Specified by:
asDescendingSetOfRanges
in interfaceRangeSet<C extends java.lang.Comparable>
-
complement
public ImmutableRangeSet<C> 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 java.lang.Comparable>
-
union
public ImmutableRangeSet<C> union(RangeSet<C> other)
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
public ImmutableRangeSet<C> intersection(RangeSet<C> other)
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
public ImmutableRangeSet<C> difference(RangeSet<C> other)
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
-
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 interfaceRangeSet<C extends java.lang.Comparable>
-
asSet
public ImmutableSortedSet<C> asSet(DiscreteDomain<C> domain)
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:
java.lang.IllegalArgumentException
- if neither this range nor the domain has a lower bound, or if neither has an upper bound
-
builder
public static <C extends java.lang.Comparable<?>> ImmutableRangeSet.Builder<C> builder()
Returns a new builder for an immutable range set.
-
contains
public boolean contains(C value)
Description copied from interface:RangeSet
Determines whether any of this range set's member ranges containsvalue
.
-
clear
public void clear()
Description copied from interface:RangeSet
Removes all ranges from thisRangeSet
(optional operation). After this operation,this.contains(c)
will return false for allc
.This is equivalent to
remove(Range.all())
.
-
enclosesAll
public boolean enclosesAll(RangeSet<C> other)
Description copied from interface:RangeSet
Returnstrue
if for each member range inother
there exists a member range in this range set which encloses it. It follows thatthis.contains(value)
wheneverother.contains(value)
. Returnstrue
ifother
is empty.This is equivalent to checking if this range set
RangeSet.encloses(com.google.common.collect.Range<C>)
each of the ranges inother
.- Specified by:
enclosesAll
in interfaceRangeSet<C extends java.lang.Comparable>
-
enclosesAll
public boolean enclosesAll(java.lang.Iterable<Range<C>> ranges)
Description copied from interface:RangeSet
Returnstrue
if for each range inother
there exists a member range in this range set which encloses it. Returnstrue
ifother
is empty.This is equivalent to checking if this range set
RangeSet.encloses(com.google.common.collect.Range<C>)
each range inother
.- Specified by:
enclosesAll
in interfaceRangeSet<C extends java.lang.Comparable>
-
equals
public boolean equals(@CheckForNull java.lang.Object obj)
Description copied from interface:RangeSet
Returnstrue
ifobj
is anotherRangeSet
that contains the same ranges according toRange.equals(Object)
.
-
hashCode
public final int hashCode()
Description copied from interface:RangeSet
ReturnsasRanges().hashCode()
.
-
toString
public final java.lang.String toString()
Description copied from interface:RangeSet
Returns a readable string representation of this range set. For example, if thisRangeSet
consisted ofRange.closed(1, 3)
andRange.greaterThan(4)
, this might return" [1..3](4..+∞)
"}.
-
-