Class ImmutableRangeSet<C extends Comparable>
- java.lang.Object
-
- com.google.common.collect.ImmutableRangeSet<C>
-
- All Implemented Interfaces:
RangeSet<C>
,Serializable
@Beta @GwtIncompatible public final class ImmutableRangeSet<C extends Comparable> extends Object implements 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 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(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 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
.static <C extends Comparable<?>>
ImmutableRangeSet<C>copyOf(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(Iterable<Range<C>> ranges)
Returnstrue
if for each range inother
there exists a member range in this range set which encloses it.boolean
equals(Object obj)
Indicates whether some other object is "equal to" this one.int
hashCode()
Returns a hash code value for the object.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 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)
Deprecated.Unsupported operation.void
removeAll(RangeSet<C> other)
Deprecated.Unsupported operation.void
removeAll(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.String
toString()
Returns a string representation of the object.ImmutableRangeSet<C>
union(RangeSet<C> other)
Returns a new range set consisting of the union of this range set andother
.static <C extends Comparable<?>>
ImmutableRangeSet<C>unionOf(Iterable<Range<C>> ranges)
Returns anImmutableRangeSet
representing the union of the specified ranges.
-
-
-
Method Detail
-
of
public static <C extends Comparable> ImmutableRangeSet<C> of()
Returns an empty immutable range set.Performance note: the instance returned is a singleton.
-
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
.
-
copyOf
public static <C extends Comparable<?>> ImmutableRangeSet<C> copyOf(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:
IllegalArgumentException
- if any ranges overlap or are empty- Since:
- 21.0
-
unionOf
public static <C extends Comparable<?>> ImmutableRangeSet<C> unionOf(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 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.- Specified by:
encloses
in interfaceRangeSet<C extends Comparable>
-
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 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
@Deprecated public void add(Range<C> range)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
add
in interfaceRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
addAll
@Deprecated public void addAll(RangeSet<C> other)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
addAll
in interfaceRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
addAll
@Deprecated public void addAll(Iterable<Range<C>> other)
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 public void remove(Range<C> range)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
remove
in interfaceRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
removeAll
@Deprecated public void removeAll(RangeSet<C> other)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
removeAll
in interfaceRangeSet<C extends Comparable>
- Throws:
UnsupportedOperationException
- always
-
removeAll
@Deprecated public void removeAll(Iterable<Range<C>> other)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeSet
unmodified.- Specified by:
removeAll
in interfaceRangeSet<C extends Comparable>
- Throws:
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 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
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 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>
-
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 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>
-
enclosesAll
public boolean enclosesAll(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 Comparable>
-
equals
public boolean equals(@CheckForNull Object obj)
Description copied from class:java.lang.Object
Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Specified by:
equals
in interfaceRangeSet<C extends Comparable>
- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
- It is reflexive: for any non-null reference value
-
hashCode
public final int hashCode()
Description copied from class:java.lang.Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
Object.equals(java.lang.Object)
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Specified by:
hashCode
in interfaceRangeSet<C extends Comparable>
- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
toString
public final String toString()
Description copied from class:java.lang.Object
Returns a string representation of the object. In general, thetoString
method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.The
toString
method for classObject
returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:getClass().getName() + '@' + Integer.toHexString(hashCode())
- Specified by:
toString
in interfaceRangeSet<C extends Comparable>
- Overrides:
toString
in classObject
- Returns:
- a string representation of the object.
-
-