com.google.common.collect

Class ContiguousSet<C extends Comparable>

java.lang.Object

java.util.AbstractCollection<E>

com.google.common.collect.ImmutableCollection<E>

com.google.common.collect.ImmutableSet<E>

com.google.common.collect.ImmutableSortedSet<C>

com.google.common.collect.ContiguousSet<C>

All Implemented Interfaces:

Serializable, Iterable<C>, Collection<C>, NavigableSet<C>, Set<C>, SortedSet<C>

@GwtCompatible(emulated=true)
public abstract class ContiguousSet<C extends Comparable>
extends ImmutableSortedSet<C>

A sorted set of contiguous values in a given DiscreteDomain. Example:

 ContiguousSet.create(Range.closed(5, 42), DiscreteDomain.integers())
 

Note that because bounded ranges over int and long values are so common, this particular example can be written as just:

 ContiguousSet.closed(5, 42)
 

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 as Set.hashCode() or Collections.frequency(java.util.Collection<?>, java.lang.Object)) can cause major performance problems.

Since:

10.0

Author:

Gregory Kick

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.ImmutableSortedSet

ImmutableSortedSet.Builder<E>

Method Summary

Modifier and Type	Method and Description
static <E> ImmutableSortedSet.Builder<E>	builder() Deprecated. Use create(com.google.common.collect.Range<C>, com.google.common.collect.DiscreteDomain<C>).
static <E> ImmutableSortedSet.Builder<E>	builderWithExpectedSize(int expectedSize) Deprecated. Not supported by ImmutableSortedSet.
static ContiguousSet<Integer>	closed(int lower, int upper) Returns a nonempty contiguous set containing all int values from lower (inclusive) to upper (inclusive).
static ContiguousSet<Long>	closed(long lower, long upper) Returns a nonempty contiguous set containing all long values from lower (inclusive) to upper (inclusive).
static ContiguousSet<Integer>	closedOpen(int lower, int upper) Returns a contiguous set containing all int values from lower (inclusive) to upper (exclusive).
static ContiguousSet<Long>	closedOpen(long lower, long upper) Returns a contiguous set containing all long values from lower (inclusive) to upper (exclusive).
static <C extends Comparable> ContiguousSet<C>	create(Range<C> range, DiscreteDomain<C> domain) Returns a ContiguousSet containing the same values in the given domain contained by the range.
ContiguousSet<C>	headSet(C toElement)
ContiguousSet<C>	headSet(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)
ContiguousSet<C>	tailSet(C fromElement)
ContiguousSet<C>	tailSet(C fromElement, boolean inclusive)
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, copyOf, copyOf, copyOf, copyOf, copyOf, copyOf, copyOf, copyOfSorted, descendingIterator, descendingSet, first, floor, higher, iterator, last, lower, naturalOrder, of, of, of, of, of, of, of, orderedBy, pollFirst, pollLast, reverseOrder

Methods inherited from class com.google.common.collect.ImmutableSet

asList, equals, hashCode

Methods inherited from class com.google.common.collect.ImmutableCollection

add, addAll, clear, contains, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

create

public static <C extends Comparable> ContiguousSet<C> create(Range<C> range,
                                                             DiscreteDomain<C> domain)

Returns a ContiguousSet containing the same values in the given domain contained by the range.

Throws:

IllegalArgumentException - if neither range nor the domain has a lower bound, or if neither has an upper bound

Since:

13.0

closed

@Beta
public static ContiguousSet<Integer> closed(int lower,
                                                  int upper)

Returns a nonempty contiguous set containing all int values from lower (inclusive) to upper (inclusive). (These are the same values contained in Range.closed(lower, upper).)

Throws:

IllegalArgumentException - if lower is greater than upper

Since:

23.0

closed

@Beta
public static ContiguousSet<Long> closed(long lower,
                                               long upper)

Returns a nonempty contiguous set containing all long values from lower (inclusive) to upper (inclusive). (These are the same values contained in Range.closed(lower, upper).)

Throws:

IllegalArgumentException - if lower is greater than upper

Since:

23.0

closedOpen

@Beta
public static ContiguousSet<Integer> closedOpen(int lower,
                                                      int upper)

Returns a contiguous set containing all int values from lower (inclusive) to upper (exclusive). If the endpoints are equal, an empty set is returned. (These are the same values contained in Range.closedOpen(lower, upper).)

Throws:

IllegalArgumentException - if lower is greater than upper

Since:

23.0

closedOpen

@Beta
public static ContiguousSet<Long> closedOpen(long lower,
                                                   long upper)

Returns a contiguous set containing all long values from lower (inclusive) to upper (exclusive). If the endpoints are equal, an empty set is returned. (These are the same values contained in Range.closedOpen(lower, upper).)

Throws:

IllegalArgumentException - if lower is greater than upper

Since:

23.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 an IllegalArgumentException if passed a toElement greater than an earlier toElement. However, this method doesn't throw an exception in that situation, but instead keeps the original toElement.

Specified by:

headSet in interface NavigableSet<C extends Comparable>

Specified by:

headSet in interface SortedSet<C extends Comparable>

Overrides:

headSet in class ImmutableSortedSet<C extends Comparable>

headSet

@GwtIncompatible
public ContiguousSet<C> headSet(C toElement,
                                                 boolean inclusive)

Specified by:

headSet in interface NavigableSet<C extends Comparable>

Overrides:

headSet in class ImmutableSortedSet<C extends 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 an IllegalArgumentException if passed a fromElement smaller than an earlier fromElement. However, this method doesn't throw an exception in that situation, but instead keeps the original fromElement. Similarly, this method keeps the original toElement, instead of throwing an exception, if passed a toElement greater than an earlier toElement.

Specified by:

subSet in interface NavigableSet<C extends Comparable>

Specified by:

subSet in interface SortedSet<C extends Comparable>

Overrides:

subSet in class ImmutableSortedSet<C extends Comparable>

subSet

@GwtIncompatible
public ContiguousSet<C> subSet(C fromElement,
                                                boolean fromInclusive,
                                                C toElement,
                                                boolean toInclusive)

Specified by:

subSet in interface NavigableSet<C extends Comparable>

Overrides:

subSet in class ImmutableSortedSet<C extends 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 an IllegalArgumentException if passed a fromElement smaller than an earlier fromElement. However, this method doesn't throw an exception in that situation, but instead keeps the original fromElement.

Specified by:

tailSet in interface NavigableSet<C extends Comparable>

Specified by:

tailSet in interface SortedSet<C extends Comparable>

Overrides:

tailSet in class ImmutableSortedSet<C extends Comparable>

tailSet

@GwtIncompatible
public ContiguousSet<C> tailSet(C fromElement,
                                                 boolean inclusive)

Specified by:

tailSet in interface NavigableSet<C extends Comparable>

Overrides:

tailSet in class ImmutableSortedSet<C extends Comparable>

Since:

12.0

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<?>) for ContiguousSet 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 to range(CLOSED, CLOSED).

Throws:

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, if set was created from the range [1..Integer.MAX_VALUE] then set.range(CLOSED, OPEN) must return [1..∞).

Throws:

NoSuchElementException - if this set is empty

toString

public String toString()

Returns a short-hand representation of the contents such as "[1..100]".

Overrides:

toString in class AbstractCollection<C extends Comparable>

builder

@Deprecated
public static <E> ImmutableSortedSet.Builder<E> builder()

Deprecated. Use create(com.google.common.collect.Range<C>, com.google.common.collect.DiscreteDomain<C>).

Not supported. ContiguousSet instances are constructed with create(com.google.common.collect.Range<C>, com.google.common.collect.DiscreteDomain<C>). This method exists only to hide ImmutableSet.builder() from consumers of ContiguousSet.

Throws:

UnsupportedOperationException - always

builderWithExpectedSize

@Deprecated
public static <E> ImmutableSortedSet.Builder<E> builderWithExpectedSize(int expectedSize)

Deprecated. Not supported by ImmutableSortedSet.

Not supported. This method exists only to hide ImmutableSet.builderWithExpectedSize(int) from consumers of ImmutableSortedSet.

Throws:

UnsupportedOperationException - always