Class ImmutableRangeSet<C extends Comparable>
- java.lang.Object
-
- com.google.common.collect.ImmutableRangeSet<C>
-
- All Implemented Interfaces:
RangeSet<C>
,Serializable
@Beta public final class ImmutableRangeSet<C extends Comparable> extends Object implements Serializable
An efficient immutable implementation of aRangeSet
.- Since:
- 14.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableRangeSet.Builder<C extends Comparable<?>>
A builder for immutable range sets.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(Range<C> range)
Adds the specified range to thisRangeSet
(optional operation).void
addAll(RangeSet<C> other)
Adds all of the ranges from the specified range set to this range set (optional operation).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 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 Comparable>
ImmutableRangeSet<C>copyOf(RangeSet<C> rangeSet)
Returns an immutable copy of the specifiedRangeSet
.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
equals(Object obj)
Returnstrue
ifobj
is anotherRangeSet
that contains the same ranges according toRange.equals(Object)
.int
hashCode()
ReturnsasRanges().hashCode()
.boolean
isEmpty()
Returnstrue
if this range set contains no ranges.static <C extends Comparable>
ImmutableRangeSet<C>of()
Returns an empty immutable range set.static <C extends 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)
Removes the specified range from thisRangeSet
(optional operation).void
removeAll(RangeSet<C> other)
Removes all of the ranges from the specified range set from this range set (optional 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.String
toString()
Returns a readable string representation of this range set.
-
-
-
Method Detail
-
of
public static <C extends Comparable> ImmutableRangeSet<C> of()
Returns an empty immutable range set.
-
of
public static <C extends 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 Comparable> ImmutableRangeSet<C> copyOf(RangeSet<C> rangeSet)
Returns an immutable copy of the specifiedRangeSet
.
-
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.- Specified by:
encloses
in interfaceRangeSet<C extends Comparable>
-
rangeContaining
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 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 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>
-
add
public void add(Range<C> range)
Description copied from interface:RangeSet
Adds the specified range to thisRangeSet
(optional operation). That is, for equal range sets a and b, the result ofa.add(range)
is thata
will be the minimal range set for which botha.enclosesAll(b)
anda.encloses(range)
.Note that
range
will be coalesced with any ranges in the range set that are connected with it. Moreover, ifrange
is empty, this is a no-op.- Specified by:
add
in interfaceRangeSet<C extends Comparable>
-
addAll
public void addAll(RangeSet<C> other)
Description copied from interface:RangeSet
Adds all of the ranges from the specified range set to this range set (optional operation). After this operation, this range set is the minimal range set that encloses both the original range set andother
.This is equivalent to calling
RangeSet.add(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.- Specified by:
addAll
in interfaceRangeSet<C extends Comparable>
-
remove
public void remove(Range<C> range)
Description copied from interface:RangeSet
Removes the specified range from thisRangeSet
(optional operation). After this operation, ifrange.contains(c)
,this.contains(c)
will returnfalse
.If
range
is empty, this is a no-op.- Specified by:
remove
in interfaceRangeSet<C extends Comparable>
-
removeAll
public void removeAll(RangeSet<C> other)
Description copied from interface:RangeSet
Removes all of the ranges from the specified range set from this range set (optional operation). After this operation, ifother.contains(c)
,this.contains(c)
will returnfalse
.This is equivalent to calling
RangeSet.remove(com.google.common.collect.Range<C>)
on each of the ranges inother
in turn.- Specified by:
removeAll
in interfaceRangeSet<C extends Comparable>
-
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).- Specified by:
asRanges
in interfaceRangeSet<C extends 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 Comparable>
-
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 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 short-hand 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
-
builder
public static <C extends 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
.- Specified by:
contains
in interfaceRangeSet<C extends Comparable>
-
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())
.- Specified by:
clear
in interfaceRangeSet<C extends Comparable>
-
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 Comparable>
-
equals
public boolean equals(@Nullable Object obj)
Description copied from interface:RangeSet
Returnstrue
ifobj
is anotherRangeSet
that contains the same ranges according toRange.equals(Object)
.- Specified by:
equals
in interfaceRangeSet<C extends Comparable>
- Overrides:
equals
in classObject
-
hashCode
public final int hashCode()
Description copied from interface:RangeSet
ReturnsasRanges().hashCode()
.- Specified by:
hashCode
in interfaceRangeSet<C extends Comparable>
- Overrides:
hashCode
in classObject
-
toString
public final 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‥+∞)
"}.- Specified by:
toString
in interfaceRangeSet<C extends Comparable>
- Overrides:
toString
in classObject
-
-