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

java.lang.Object
  extended by com.google.common.collect.ImmutableSet<E>
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>

public abstract class ImmutableSet<E>
extends java.lang.Object
implements java.util.Set<E>, java.io.Serializable

A high-performance, immutable, hash-based Set with reliable, user-specified iteration order. Does not permit null elements.

Unlike Collections.unmodifiableSet(java.util.Set), 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.

Author:
Kevin Bourrillion
See Also:
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
<E> ImmutableSet<E>
copyOf(java.lang.Iterable<? extends E> elements)
          Returns an immutable set containing the given elements, in order.
 int hashCode()
           
static
<E> ImmutableSet<E>
of()
          Returns the empty immutable set.
static
<E> ImmutableSet<E>
of(E... elements)
          Returns an immutable set containing the given elements, in order.
static
<E> ImmutableSet<E>
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

of

public static <E> ImmutableSet<E> of()
Returns the empty immutable set. This set behaves and performs comparably to Collections.emptySet(), and is preferable mainly for consistency and maintainability of your code.


of

public static <E> ImmutableSet<E> of(E element)
Returns an immutable set containing a single element. This set behaves and performs comparably to Collections.singleton(T), but will not accept a null element. It is preferable mainly for consistency and maintainability of your code.


of

public static <E> ImmutableSet<E> of(E... elements)
Returns an immutable set containing the given elements, in order. Repeated occurrences of an element (according to Object.equals(java.lang.Object)) after the first are ignored (but too many of these may result in the set being sized inappropriately).

Throws:
java.lang.NullPointerException - if any of elements are null

copyOf

public static <E> ImmutableSet<E> copyOf(java.lang.Iterable<? extends E> elements)
Returns an immutable set containing the given elements, in order. Repeated occurrences of an element (according to 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.

Throws:
java.lang.NullPointerException - if any of elements are null

contains

public abstract boolean contains(@Nullable
                                 java.lang.Object target)
Specified by:
contains in interface java.util.Collection<E>
Specified by:
contains in interface java.util.Set<E>

containsAll

public boolean containsAll(java.util.Collection<?> targets)
Specified by:
containsAll in interface java.util.Collection<E>
Specified by:
containsAll in interface java.util.Set<E>

add

public final boolean add(E newElement)
Not supported.

Specified by:
add in interface java.util.Collection<E>
Specified by:
add in interface java.util.Set<E>

remove

public final boolean remove(java.lang.Object oldElement)
Not supported.

Specified by:
remove in interface java.util.Collection<E>
Specified by:
remove in interface java.util.Set<E>

addAll

public final boolean addAll(java.util.Collection<? extends E> newElements)
Not supported.

Specified by:
addAll in interface java.util.Collection<E>
Specified by:
addAll in interface java.util.Set<E>

removeAll

public final boolean removeAll(java.util.Collection<?> oldElements)
Not supported.

Specified by:
removeAll in interface java.util.Collection<E>
Specified by:
removeAll in interface java.util.Set<E>

retainAll

public final boolean retainAll(java.util.Collection<?> elementsToKeep)
Not supported.

Specified by:
retainAll in interface java.util.Collection<E>
Specified by:
retainAll in interface java.util.Set<E>

clear

public final void clear()
Not supported.

Specified by:
clear in interface java.util.Collection<E>
Specified by:
clear in interface java.util.Set<E>

hashCode

public final int hashCode()
Specified by:
hashCode in interface java.util.Collection<E>
Specified by:
hashCode in interface java.util.Set<E>
Overrides:
hashCode in class java.lang.Object


Copyright © 2008 Google. All Rights Reserved.