ImmutableSortedSet (Guava: Google Core Libraries for Java 11.0.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: Serializable, Iterable<E>, Collection<E>, Set<E>, SortedSet<E>

Direct Known Subclasses:: ContiguousSet

@GwtCompatible(serializable=true, emulated=true) public abstract class ImmutableSortedSet<E>
extends ImmutableSet<E>
implements SortedSet<E>
extends ImmutableSet<E>
implements 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 the 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.

Since:: 2.0 (imported from Google Collections Library)
Author:: Jared Levy, Louis Wasserman
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.

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> ImmutableSortedSet<E>

copyOf(Collection<? extends E> elements)
Returns an immutable sorted set containing the given elements sorted by their natural ordering.

static



<E> ImmutableSortedSet<E>

copyOf(Comparator<? super E> comparator,
             Collection<? extends E> elements)

Returns an immutable sorted set containing the given elements sorted by the given Comparator.

static



<E> ImmutableSortedSet<E>

copyOf(Comparator<? super E> comparator,
             Iterable<? extends E> elements)

Returns an immutable sorted set containing the given elements sorted by the given Comparator.

static



<E> ImmutableSortedSet<E>

copyOf(Comparator<? super E> comparator,
             Iterator<? extends E> elements)

Returns an immutable sorted set containing the given elements sorted by the given Comparator.

static



<E extends Comparable<? super E>> 


ImmutableSortedSet<E>

copyOf(E[] elements)
Returns an immutable sorted set containing the given elements sorted by their natural ordering.

static



<E> ImmutableSortedSet<E>

copyOf(Iterable<? extends E> elements)
Returns an immutable sorted set containing the given elements sorted by their natural ordering.

static



<E> ImmutableSortedSet<E>

copyOf(Iterator<? extends E> elements)
Returns an immutable sorted set containing the given elements sorted by their natural ordering.

static



<E> ImmutableSortedSet<E>

copyOfSorted(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)

abstract UnmodifiableIterator<E> iterator()
Returns an unmodifiable iterator across the elements in this collection.

static



<E extends 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 Comparable<? super E>> 


ImmutableSortedSet<E>

of(E element)
Returns an immutable sorted set containing a single element.

static



<E extends Comparable<? super E>> 


ImmutableSortedSet<E>

of(E e1,
     E e2)