|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableSet<E>
public abstract class ImmutableSet<E>
A high-performance, immutable, hash-based Set with reliable,
user-specified iteration order. Does not permit null elements.
Unlike Collections.unmodifiableSet(java.util.Set extends T>), which is a view of a
separate collection that can still change, an instance of ImmutableSet contains its own private data and will never change.
ImmutableSet 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.
Warning: Like most sets, an ImmutableSet 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.
This class has been observed to perform significantly better than HashSet for objects with very fast Object.hashCode() implementations
(as a well-behaved immutable object should).
Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, the immutability guarantee can be trusted.
ImmutableList,
Serialized Form| Method Summary | ||
|---|---|---|
boolean |
add(E newElement)
Not supported. |
|
boolean |
addAll(java.util.Collection<? extends E> newElements)
Not supported. |
|
void |
clear()
Not supported. |
|
abstract boolean |
contains(java.lang.Object target)
|
|
boolean |
containsAll(java.util.Collection<?> targets)
|
|
static
|
copyOf(java.lang.Iterable<? extends E> elements)
Returns an immutable set containing the given elements, in order. |
|
int |
hashCode()
|
|
static
|
of()
Returns the empty immutable set. |
|
static
|
of(E... elements)
Returns an immutable set containing the given elements, in order. |
|
static
|
of(E element)
Returns an immutable set containing a single element. |
|
boolean |
remove(java.lang.Object oldElement)
Not supported. |
|
boolean |
removeAll(java.util.Collection<?> oldElements)
Not supported. |
|
boolean |
retainAll(java.util.Collection<?> elementsToKeep)
Not supported. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface java.util.Set |
|---|
equals, isEmpty, iterator, size, toArray, toArray |
| Method Detail |
|---|
public static <E> ImmutableSet<E> of()
Collections.emptySet(), and is preferable mainly for consistency
and maintainability of your code.
public static <E> ImmutableSet<E> of(E element)
Collections.singleton(T), but will not accept
a null element. It is preferable mainly for consistency and
maintainability of your code.
public static <E> ImmutableSet<E> of(E... elements)
Object.equals(java.lang.Object)) after the
first are ignored (but too many of these may result in the set being
sized inappropriately).
java.lang.NullPointerException - if any of elements are nullpublic static <E> ImmutableSet<E> copyOf(java.lang.Iterable<? extends E> elements)
Object.equals(java.lang.Object)) after the
first are ignored (but too many of these may result in the set being
sized inappropriately).
Note that if s is a Set<String>, then ImmutableSet.copyOf(s) returns a ImmutableSet<String> containing
each of the strings in s, while ImmutableSet.of(s)} returns a
ImmutableSet<Set<String>> containing one element (the given set
itself).
Note: Despite what the method name suggests, if elements
is an ImmutableSet, no copy will actually be performed, and the
given set itself will be returned.
java.lang.NullPointerException - if any of elements are null
public abstract boolean contains(@Nullable
java.lang.Object target)
contains in interface java.util.Collection<E>contains in interface java.util.Set<E>public boolean containsAll(java.util.Collection<?> targets)
containsAll in interface java.util.Collection<E>containsAll in interface java.util.Set<E>public final boolean add(E newElement)
add in interface java.util.Collection<E>add in interface java.util.Set<E>public final boolean remove(java.lang.Object oldElement)
remove in interface java.util.Collection<E>remove in interface java.util.Set<E>public final boolean addAll(java.util.Collection<? extends E> newElements)
addAll in interface java.util.Collection<E>addAll in interface java.util.Set<E>public final boolean removeAll(java.util.Collection<?> oldElements)
removeAll in interface java.util.Collection<E>removeAll in interface java.util.Set<E>public final boolean retainAll(java.util.Collection<?> elementsToKeep)
retainAll in interface java.util.Collection<E>retainAll in interface java.util.Set<E>public final void clear()
clear in interface java.util.Collection<E>clear in interface java.util.Set<E>public final int hashCode()
hashCode in interface java.util.Collection<E>hashCode in interface java.util.Set<E>hashCode in class java.lang.Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||