Class ImmutableSet<E>
- All Implemented Interfaces:
Serializable
,Iterable<E>
,Collection<E>
,Set<E>
- Direct Known Subclasses:
ImmutableSortedSet
Set
whose contents will never change, with many other important properties detailed at
ImmutableCollection
.- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A builder for creatingImmutableSet
instances. -
Method Summary
Modifier and TypeMethodDescriptionasList()
Returns anImmutableList
containing the same elements, in the same order, as this collection.static <E> ImmutableSet.Builder
<E> builder()
Returns a new builder.static <E> ImmutableSet
<E> copyOf
(E[] elements) Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source array.static <E> ImmutableSet
<E> Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source iterable.static <E> ImmutableSet
<E> copyOf
(Collection<? extends E> elements) Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source collection.static <E> ImmutableSet
<E> Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source iterator.boolean
int
hashCode()
abstract UnmodifiableIterator
<E> iterator()
Returns an unmodifiable iterator across the elements in this collection.static <E> ImmutableSet
<E> of()
Returns the empty immutable set.static <E> ImmutableSet
<E> of
(E element) Returns an immutable set containingelement
.static <E> ImmutableSet
<E> of
(E e1, E e2) Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified.static <E> ImmutableSet
<E> of
(E e1, E e2, E e3) Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified.static <E> ImmutableSet
<E> of
(E e1, E e2, E e3, E e4) Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified.static <E> ImmutableSet
<E> of
(E e1, E e2, E e3, E e4, E e5) Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified.static <E> ImmutableSet
<E> of
(E e1, E e2, E e3, E e4, E e5, E e6, E... others) Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified.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, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
-
Method Details
-
of
Returns the empty immutable set. Preferred overCollections.emptySet()
for code consistency, and because the return type conveys the immutability guarantee. -
of
Returns an immutable set containingelement
. Preferred overCollections.singleton(T)
for code consistency,null
rejection, and because the return type conveys the immutability guarantee. -
of
Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified. That is, if multiple elements are equal, all except the first are ignored. -
of
Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified. That is, if multiple elements are equal, all except the first are ignored. -
of
Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified. That is, if multiple elements are equal, all except the first are ignored. -
of
Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified. That is, if multiple elements are equal, all except the first are ignored. -
of
Returns an immutable set containing the given elements, minus duplicates, in the order each was first specified. That is, if multiple elements are equal, all except the first are ignored.- Since:
- 3.0 (source-compatible since 2.0)
-
copyOf
Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source collection.Performance note: This method will sometimes recognize that the actual copy operation is unnecessary; for example,
copyOf(copyOf(anArrayList))
will copy the data only once. This reduces the expense of habitually making defensive copies at API boundaries. However, the precise conditions for skipping the copy operation are undefined.- Throws:
NullPointerException
- if any ofelements
is null- Since:
- 7.0 (source-compatible since 2.0)
-
copyOf
Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source iterable. This method iterates overelements
only once.Performance note: This method will sometimes recognize that the actual copy operation is unnecessary; for example,
copyOf(copyOf(anArrayList))
should copy the data only once. This reduces the expense of habitually making defensive copies at API boundaries. However, the precise conditions for skipping the copy operation are undefined.- Throws:
NullPointerException
- if any ofelements
is null
-
copyOf
Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source iterator.- Throws:
NullPointerException
- if any ofelements
is null
-
copyOf
Returns an immutable set containing each ofelements
, minus duplicates, in the order each appears first in the source array.- Throws:
NullPointerException
- if any ofelements
is null- Since:
- 3.0
-
equals
-
hashCode
public int hashCode() -
iterator
Description copied from class:ImmutableCollection
Returns an unmodifiable iterator across the elements in this collection. -
asList
Description copied from class:ImmutableCollection
Returns anImmutableList
containing the same elements, in the same order, as this collection.Performance note: in most cases this method can return quickly without actually copying anything. The exact circumstances under which the copy is performed are undefined and subject to change.
- Overrides:
asList
in classImmutableCollection<E>
-
builder
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableSet.Builder
constructor.
-