com.google.common.collect
Class ImmutableSortedSet<E>

java.lang.Object
  com.google.common.collect.ImmutableCollection<E>
      com.google.common.collect.ImmutableSet<E>
          com.google.common.collect.ImmutableSortedSet<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>, java.util.SortedSet<E>

@GwtCompatible
public abstract class ImmutableSortedSet<E>
extends ImmutableSet<E>
implements java.util.SortedSet<E>

An immutable SortedSet that stores its elements in a sorted array. Some instances are ordered by an explicit comparator, while others follow the natural sort ordering of their elements. Either way, null elements are not supported.

Unlike Collections.unmodifiableSortedSet(java.util.SortedSet), which is a view of a separate collection that can still change, an instance of ImmutableSortedSet contains its own private data and will never change. This class is convenient for public static final sets ("constant sets") and also lets you easily make a "defensive copy" of a set provided to your class by a caller.

The sets returned by headSet(E), tailSet(E), and subSet(E, E) methods share the same array as the original set, preventing that array from being garbage collected. If this is a concern, the data may be copied into a correctly-sized array by calling copyOfSorted(java.util.SortedSet).

Note on element equivalence: The ImmutableCollection.contains(Object), ImmutableCollection.containsAll(Collection), and ImmutableSet.equals(Object) implementations must check whether a provided object is equivalent to an element in the collection. Unlike most collections, an ImmutableSortedSet doesn't use Object.equals(java.lang.Object) to determine if two elements are equivalent. Instead, with an explicit comparator, the following relation determines whether elements x and y are equivalent:

   {(x, y) | comparator.compare(x, y) == 0}

With natural ordering of elements, the following relation determines whether two elements are equivalent:

   {(x, y) | x.compareTo(y) == 0}

Warning: Like most sets, an ImmutableSortedSet will not function correctly if an element is modified after being placed in the set. For this reason, and to avoid general confusion, it is strongly recommended to place only immutable objects into this collection.

Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this type are guaranteed to be immutable.

Author:

Jared Levy

See Also:

ImmutableSet, Serialized Form

Nested Class Summary

static class

ImmutableSortedSet.Builder<E> A builder for creating immutable sorted set instances, especially public static final sets ("constant sets"), with a given comparator.

Method Summary

static <E> ImmutableSortedSet.Builder<E>	builder() Deprecated. Use naturalOrder(), which offers better type-safety.
java.util.Comparator<? super E>	comparator() Returns the comparator that orders the elements, which is Ordering.natural() when the natural ordering of the elements is used.
static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E>	copyOf(java.lang.Iterable<? extends E> elements) Returns an immutable sorted set containing the given elements sorted by their natural ordering.
static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E>	copyOf(java.util.Iterator<? extends E> elements) Returns an immutable sorted set containing the given elements sorted by their natural ordering.
static <E> ImmutableSortedSet<E>	copyOfSorted(java.util.SortedSet<E> sortedSet) Returns an immutable sorted set containing the elements of a sorted set, sorted by the same Comparator.
ImmutableSortedSet<E>	headSet(E toElement)
static <E extends java.lang.Comparable<E>> ImmutableSortedSet.Builder<E>	naturalOrder() Returns a builder that creates immutable sorted sets whose elements are ordered by their natural ordering.
static <E> ImmutableSortedSet<E>	of() Returns the empty immutable sorted set.
static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E>	of(E... elements) Returns an immutable sorted set containing the given elements sorted by their natural ordering.
static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E>	of(E element) Returns an immutable sorted set containing a single element.
static <E> ImmutableSortedSet.Builder<E>	orderedBy(java.util.Comparator<E> comparator) Returns a builder that creates immutable sorted sets with an explicit comparator.
static <E extends java.lang.Comparable<E>> ImmutableSortedSet.Builder<E>	reverseOrder() Returns a builder that creates immutable sorted sets whose elements are ordered by the reverse of their natural ordering.
ImmutableSortedSet<E>	subSet(E fromElement, E toElement)
ImmutableSortedSet<E>	tailSet(E fromElement)

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

equals, hashCode, iterator

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

add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.SortedSet

first, last

Methods inherited from interface java.util.Set

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

Method Detail

of

public static <E> ImmutableSortedSet<E> of()

Returns the empty immutable sorted set.

of

public static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E> of(E element)

Returns an immutable sorted set containing a single element.

of

public static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E> of(E... elements)

Returns an immutable sorted set containing the given elements sorted by their natural ordering. When multiple elements are equivalent according to Comparable.compareTo(T), only the first one specified is included.

Throws:

java.lang.NullPointerException - if any of elements is null

copyOf

public static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E> copyOf(java.lang.Iterable<? extends E> elements)

Returns an immutable sorted set containing the given elements sorted by their natural ordering. When multiple elements are equivalent according to compareTo(), only the first one specified is included. To create a copy of a SortedSet that preserves the comparator, call copyOfSorted(java.util.SortedSet) instead. This method iterates over elements at most once.

Note that if s is a Set<String>, then ImmutableSortedSet.copyOf(s) returns a ImmutableSortedSet<String> containing each of the strings in s, while ImmutableSortedSet.of(s) returns a ImmutableSortedSet<Set<String>> containing one element (the given set itself).

Note: Despite what the method name suggests, if elements is an ImmutableSortedSet, it may be returned instead of a copy.

Throws:

java.lang.NullPointerException - if any of elements is null

copyOf

public static <E extends java.lang.Comparable<? super E>> ImmutableSortedSet<E> copyOf(java.util.Iterator<? extends E> elements)

Returns an immutable sorted set containing the given elements sorted by their natural ordering. When multiple elements are equivalent according to compareTo(), only the first one specified is included.

Throws:

java.lang.NullPointerException - if any of elements is null

copyOfSorted

public static <E> ImmutableSortedSet<E> copyOfSorted(java.util.SortedSet<E> sortedSet)

Returns an immutable sorted set containing the elements of a sorted set, sorted by the same Comparator. That behavior differs from copyOf(Iterable), which always uses the natural ordering of the elements.

Note: Despite what the method name suggests, if sortedSet is an ImmutableSortedSet, it may be returned instead of a copy.

Throws:

java.lang.NullPointerException - if any of elements is null

orderedBy

public static <E> ImmutableSortedSet.Builder<E> orderedBy(java.util.Comparator<E> comparator)

Returns a builder that creates immutable sorted sets with an explicit comparator. If the comparator has a more general type than the set being generated, such as creating a SortedSet<Integer> with a Comparator<Number>, use the ImmutableSortedSet.Builder constructor instead.

Throws:

java.lang.NullPointerException - if comparator is null

reverseOrder

public static <E extends java.lang.Comparable<E>> ImmutableSortedSet.Builder<E> reverseOrder()

Returns a builder that creates immutable sorted sets whose elements are ordered by the reverse of their natural ordering.

Note: the type parameter E extends Comparable<E> rather than Comparable<? super E> as a workaround for javac bug 6468354.

naturalOrder

public static <E extends java.lang.Comparable<E>> ImmutableSortedSet.Builder<E> naturalOrder()

Returns a builder that creates immutable sorted sets whose elements are ordered by their natural ordering. The sorted sets use Ordering.natural() as the comparator. This method provides more type-safety than builder(), as it can be called only for classes that implement Comparable.

Note: the type parameter E extends Comparable<E> rather than Comparable<? super E> as a workaround for javac bug 6468354.

builder

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

Deprecated. Use naturalOrder(), which offers better type-safety.

Not supported. Use naturalOrder(), which offers better type-safety, instead. This method exists only to hide ImmutableSet.builder() from consumers of ImmutableSortedSet.

Throws:

java.lang.UnsupportedOperationException - always

comparator

public java.util.Comparator<? super E> comparator()

Returns the comparator that orders the elements, which is Ordering.natural() when the natural ordering of the elements is used. Note that its behavior is not consistent with SortedSet.comparator(), which returns null to indicate natural ordering.

Specified by:

comparator in interface java.util.SortedSet<E>

headSet

public ImmutableSortedSet<E> headSet(E toElement)

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 java.util.SortedSet<E>

subSet

public ImmutableSortedSet<E> subSet(E fromElement,
                                    E toElement)

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 toElement. 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 java.util.SortedSet<E>

tailSet

public ImmutableSortedSet<E> tailSet(E fromElement)

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 java.util.SortedSet<E>