Class ContiguousSet<C extends java.lang.Comparable>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- com.google.common.collect.ImmutableCollection<E>
-
- com.google.common.collect.ImmutableSet<E>
-
- com.google.common.collect.ImmutableSortedSetFauxverideShim<E>
-
- com.google.common.collect.ImmutableSortedSet<C>
-
- com.google.common.collect.ContiguousSet<C>
-
- All Implemented Interfaces:
SortedIterable<C>
,java.io.Serializable
,java.lang.Iterable<C>
,java.util.Collection<C>
,java.util.NavigableSet<C>
,java.util.Set<C>
,java.util.SortedSet<C>
- Direct Known Subclasses:
EmptyContiguousSet
,RegularContiguousSet
@GwtCompatible(emulated=true) public abstract class ContiguousSet<C extends java.lang.Comparable> extends ImmutableSortedSet<C>
A sorted set of contiguous values in a givenDiscreteDomain
.Warning: Be extremely careful what you do with conceptually large instances (such as
ContiguousSet.create(Range.greaterThan(0), DiscreteDomain.integers()
). 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.- Since:
- 10.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.common.collect.ImmutableSortedSet
ImmutableSortedSet.Builder<E>
-
Nested classes/interfaces inherited from class com.google.common.collect.ImmutableSet
ImmutableSet.Indexed<E>
-
Nested classes/interfaces inherited from class com.google.common.collect.ImmutableCollection
ImmutableCollection.ArrayBasedBuilder<E>
-
-
Field Summary
Fields Modifier and Type Field Description (package private) DiscreteDomain<C>
domain
-
Fields inherited from class com.google.common.collect.ImmutableSortedSet
comparator, descendingSet
-
Fields inherited from class com.google.common.collect.ImmutableSet
MAX_TABLE_SIZE
-
-
Constructor Summary
Constructors Constructor Description ContiguousSet(DiscreteDomain<C> domain)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <E> ImmutableSortedSet.Builder<E>
builder()
static <C extends java.lang.Comparable>
ContiguousSet<C>create(Range<C> range, DiscreteDomain<C> domain)
Returns aContiguousSet
containing the same values in the given domain contained by the range.ContiguousSet<C>
headSet(C toElement)
ContiguousSet<C>
headSet(C toElement, boolean inclusive)
(package private) abstract ContiguousSet<C>
headSetImpl(C toElement, boolean inclusive)
abstract ContiguousSet<C>
intersection(ContiguousSet<C> other)
Returns the set of values that are contained in both this set and the other.abstract Range<C>
range()
Returns a range, closed on both ends, whose endpoints are the minimum and maximum values contained in this set.abstract Range<C>
range(BoundType lowerBoundType, BoundType upperBoundType)
Returns the minimal range with the given boundary types for which all values in this set are contained within the range.ContiguousSet<C>
subSet(C fromElement, boolean fromInclusive, C toElement, boolean toInclusive)
ContiguousSet<C>
subSet(C fromElement, C toElement)
(package private) abstract ContiguousSet<C>
subSetImpl(C fromElement, boolean fromInclusive, C toElement, boolean toInclusive)
ContiguousSet<C>
tailSet(C fromElement)
ContiguousSet<C>
tailSet(C fromElement, boolean inclusive)
(package private) abstract ContiguousSet<C>
tailSetImpl(C fromElement, boolean inclusive)
java.lang.String
toString()
Returns a short-hand representation of the contents such as"[1..100]"
.-
Methods inherited from class com.google.common.collect.ImmutableSortedSet
ceiling, comparator, construct, copyOf, copyOf, copyOf, copyOf, copyOf, copyOf, copyOf, copyOfSorted, createDescendingSet, descendingIterator, descendingSet, emptySet, first, floor, higher, indexOf, iterator, last, lower, naturalOrder, of, of, of, of, of, of, of, orderedBy, pollFirst, pollLast, reverseOrder, unsafeCompare, unsafeCompare, writeReplace
-
Methods inherited from class com.google.common.collect.ImmutableSortedSetFauxverideShim
copyOf, of, of, of, of, of, of
-
Methods inherited from class com.google.common.collect.ImmutableSet
asList, chooseTableSize, createAsList, equals, hashCode, isHashCodeFast
-
Methods inherited from class com.google.common.collect.ImmutableCollection
add, addAll, clear, contains, copyIntoArray, isPartialView, remove, removeAll, retainAll, toArray, toArray
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
domain
final DiscreteDomain<C extends java.lang.Comparable> domain
-
-
Constructor Detail
-
ContiguousSet
ContiguousSet(DiscreteDomain<C> domain)
-
-
Method Detail
-
create
public static <C extends java.lang.Comparable> ContiguousSet<C> create(Range<C> range, DiscreteDomain<C> domain)
Returns aContiguousSet
containing the same values in the given domain contained by the range.- Throws:
java.lang.IllegalArgumentException
- if neither range nor the domain has a lower bound, or if neither has an upper bound- Since:
- 13.0
-
headSet
public ContiguousSet<C> headSet(C toElement)
Description copied from class:ImmutableSortedSet
This method returns a serializable
ImmutableSortedSet
.The
SortedSet.headSet(E)
documentation states that a subset of a subset throws anIllegalArgumentException
if passed atoElement
greater than an earliertoElement
. However, this method doesn't throw an exception in that situation, but instead keeps the originaltoElement
.- Specified by:
headSet
in interfacejava.util.NavigableSet<C extends java.lang.Comparable>
- Specified by:
headSet
in interfacejava.util.SortedSet<C extends java.lang.Comparable>
- Overrides:
headSet
in classImmutableSortedSet<C extends java.lang.Comparable>
-
headSet
@GwtIncompatible public ContiguousSet<C> headSet(C toElement, boolean inclusive)
- Specified by:
headSet
in interfacejava.util.NavigableSet<C extends java.lang.Comparable>
- Overrides:
headSet
in classImmutableSortedSet<C extends java.lang.Comparable>
- Since:
- 12.0
-
subSet
public ContiguousSet<C> subSet(C fromElement, C toElement)
Description copied from class:ImmutableSortedSet
This method returns a serializable
ImmutableSortedSet
.The
SortedSet.subSet(E, E)
documentation states that a subset of a subset throws anIllegalArgumentException
if passed afromElement
smaller than an earlierfromElement
. However, this method doesn't throw an exception in that situation, but instead keeps the originalfromElement
. Similarly, this method keeps the originaltoElement
, instead of throwing an exception, if passed atoElement
greater than an earliertoElement
.- Specified by:
subSet
in interfacejava.util.NavigableSet<C extends java.lang.Comparable>
- Specified by:
subSet
in interfacejava.util.SortedSet<C extends java.lang.Comparable>
- Overrides:
subSet
in classImmutableSortedSet<C extends java.lang.Comparable>
-
subSet
@GwtIncompatible public ContiguousSet<C> subSet(C fromElement, boolean fromInclusive, C toElement, boolean toInclusive)
- Specified by:
subSet
in interfacejava.util.NavigableSet<C extends java.lang.Comparable>
- Overrides:
subSet
in classImmutableSortedSet<C extends java.lang.Comparable>
- Since:
- 12.0
-
tailSet
public ContiguousSet<C> tailSet(C fromElement)
Description copied from class:ImmutableSortedSet
This method returns a serializable
ImmutableSortedSet
.The
SortedSet.tailSet(E)
documentation states that a subset of a subset throws anIllegalArgumentException
if passed afromElement
smaller than an earlierfromElement
. However, this method doesn't throw an exception in that situation, but instead keeps the originalfromElement
.- Specified by:
tailSet
in interfacejava.util.NavigableSet<C extends java.lang.Comparable>
- Specified by:
tailSet
in interfacejava.util.SortedSet<C extends java.lang.Comparable>
- Overrides:
tailSet
in classImmutableSortedSet<C extends java.lang.Comparable>
-
tailSet
@GwtIncompatible public ContiguousSet<C> tailSet(C fromElement, boolean inclusive)
- Specified by:
tailSet
in interfacejava.util.NavigableSet<C extends java.lang.Comparable>
- Overrides:
tailSet
in classImmutableSortedSet<C extends java.lang.Comparable>
- Since:
- 12.0
-
headSetImpl
abstract ContiguousSet<C> headSetImpl(C toElement, boolean inclusive)
- Specified by:
headSetImpl
in classImmutableSortedSet<C extends java.lang.Comparable>
-
subSetImpl
abstract ContiguousSet<C> subSetImpl(C fromElement, boolean fromInclusive, C toElement, boolean toInclusive)
- Specified by:
subSetImpl
in classImmutableSortedSet<C extends java.lang.Comparable>
-
tailSetImpl
abstract ContiguousSet<C> tailSetImpl(C fromElement, boolean inclusive)
- Specified by:
tailSetImpl
in classImmutableSortedSet<C extends java.lang.Comparable>
-
intersection
public abstract ContiguousSet<C> intersection(ContiguousSet<C> other)
Returns the set of values that are contained in both this set and the other.This method should always be used instead of
Sets.intersection(java.util.Set<E>, java.util.Set<?>)
forContiguousSet
instances.
-
range
public abstract Range<C> range()
Returns a range, closed on both ends, whose endpoints are the minimum and maximum values contained in this set. This is equivalent torange(CLOSED, CLOSED)
.- Throws:
java.util.NoSuchElementException
- if this set is empty
-
range
public abstract Range<C> range(BoundType lowerBoundType, BoundType upperBoundType)
Returns the minimal range with the given boundary types for which all values in this set are contained within the range.Note that this method will return ranges with unbounded endpoints if
BoundType.OPEN
is requested for a domain minimum or maximum. For example, ifset
was created from the range[1..Integer.MAX_VALUE]
thenset.range(CLOSED, OPEN)
must return[1..∞)
.- Throws:
java.util.NoSuchElementException
- if this set is empty
-
toString
public java.lang.String toString()
Returns a short-hand representation of the contents such as"[1..100]"
.- Overrides:
toString
in classjava.util.AbstractCollection<C extends java.lang.Comparable>
-
builder
@Deprecated public static <E> ImmutableSortedSet.Builder<E> builder()
Deprecated.Not supported.ContiguousSet
instances are constructed withcreate(com.google.common.collect.Range<C>, com.google.common.collect.DiscreteDomain<C>)
. This method exists only to hideImmutableSet.builder()
from consumers ofContiguousSet
.- Throws:
java.lang.UnsupportedOperationException
- always
-
-