java.util.concurrent
Class CopyOnWriteArraySet<E>

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
      extended by java.util.AbstractSet sample code for java.util.AbstractSet definition code for java.util.AbstractSet <E>
          extended by java.util.concurrent.CopyOnWriteArraySet<E>
Type Parameters:
E - the type of elements held in this collection
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Iterable sample code for java.lang.Iterable definition code for java.lang.Iterable <E>, Collection sample code for java.util.Collection definition code for java.util.Collection <E>, Set sample code for java.util.Set definition code for java.util.Set <E>

public class CopyOnWriteArraySet<E>
extends AbstractSet sample code for java.util.AbstractSet definition code for java.util.AbstractSet <E>
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable

A Set sample code for java.util.Set definition code for java.util.Set that uses CopyOnWriteArrayList sample code for java.util.concurrent.CopyOnWriteArrayList definition code for java.util.concurrent.CopyOnWriteArrayList for all of its operations. Thus, it shares the same basic properties:

Sample Usage. The following code sketch uses a copy-on-write set to maintain a set of Handler objects that perform some action upon state updates.

 class Handler { void handle(); ... }

 class X {
    private final CopyOnWriteArraySet<Handler> handlers = new CopyOnWriteArraySet<Handler>();
    public void addHandler(Handler h) { handlers.add(h); }

    private long internalState;
    private synchronized void changeState() { internalState = ...; }

    public void update() {
       changeState();
       for (Handler handler : handlers)
           handler.handle();
    }
 }
 

This class is a member of the Java Collections Framework.

Since:
1.5
See Also:
CopyOnWriteArrayList sample code for java.util.concurrent.CopyOnWriteArrayList definition code for java.util.concurrent.CopyOnWriteArrayList , Serialized Form

Constructor Summary
CopyOnWriteArraySet sample code for java.util.concurrent.CopyOnWriteArraySet.CopyOnWriteArraySet() definition code for java.util.concurrent.CopyOnWriteArraySet.CopyOnWriteArraySet() ()
          Creates an empty set.
CopyOnWriteArraySet sample code for java.util.concurrent.CopyOnWriteArraySet.CopyOnWriteArraySet(java.util.Collection) definition code for java.util.concurrent.CopyOnWriteArraySet.CopyOnWriteArraySet(java.util.Collection) (Collection sample code for java.util.Collection definition code for java.util.Collection <? extends E> c)
          Creates a set containing all of the elements of the specified Collection.
 
Method Summary
 boolean add sample code for java.util.concurrent.CopyOnWriteArraySet.add(E) definition code for java.util.concurrent.CopyOnWriteArraySet.add(E) (E o)
          Ensures that this collection contains the specified element (optional operation).
 boolean addAll sample code for java.util.concurrent.CopyOnWriteArraySet.addAll(java.util.Collection) definition code for java.util.concurrent.CopyOnWriteArraySet.addAll(java.util.Collection) (Collection sample code for java.util.Collection definition code for java.util.Collection <? extends E> c)
          Adds all of the elements in the specified collection to this collection (optional operation).
 void clear sample code for java.util.concurrent.CopyOnWriteArraySet.clear() definition code for java.util.concurrent.CopyOnWriteArraySet.clear() ()
          Removes all of the elements from this collection (optional operation).
 boolean contains sample code for java.util.concurrent.CopyOnWriteArraySet.contains(java.lang.Object) definition code for java.util.concurrent.CopyOnWriteArraySet.contains(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  o)
          Returns true if this collection contains the specified element.
 boolean containsAll sample code for java.util.concurrent.CopyOnWriteArraySet.containsAll(java.util.Collection) definition code for java.util.concurrent.CopyOnWriteArraySet.containsAll(java.util.Collection) (Collection sample code for java.util.Collection definition code for java.util.Collection <?> c)
          Returns true if this collection contains all of the elements in the specified collection.
 boolean isEmpty sample code for java.util.concurrent.CopyOnWriteArraySet.isEmpty() definition code for java.util.concurrent.CopyOnWriteArraySet.isEmpty() ()
          Returns true if this collection contains no elements.
 Iterator sample code for java.util.Iterator definition code for java.util.Iterator <E> iterator sample code for java.util.concurrent.CopyOnWriteArraySet.iterator() definition code for java.util.concurrent.CopyOnWriteArraySet.iterator() ()
          Returns an iterator over the elements contained in this collection.
 boolean remove sample code for java.util.concurrent.CopyOnWriteArraySet.remove(java.lang.Object) definition code for java.util.concurrent.CopyOnWriteArraySet.remove(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  o)
          Removes a single instance of the specified element from this collection, if it is present (optional operation).
 boolean removeAll sample code for java.util.concurrent.CopyOnWriteArraySet.removeAll(java.util.Collection) definition code for java.util.concurrent.CopyOnWriteArraySet.removeAll(java.util.Collection) (Collection sample code for java.util.Collection definition code for java.util.Collection <?> c)
          Removes from this set all of its elements that are contained in the specified collection (optional operation).
 boolean retainAll sample code for java.util.concurrent.CopyOnWriteArraySet.retainAll(java.util.Collection) definition code for java.util.concurrent.CopyOnWriteArraySet.retainAll(java.util.Collection) (Collection sample code for java.util.Collection definition code for java.util.Collection <?> c)
          Retains only the elements in this collection that are contained in the specified collection (optional operation).
 int size sample code for java.util.concurrent.CopyOnWriteArraySet.size() definition code for java.util.concurrent.CopyOnWriteArraySet.size() ()
          Returns the number of elements in this collection.
 Object sample code for java.lang.Object definition code for java.lang.Object [] toArray sample code for java.util.concurrent.CopyOnWriteArraySet.toArray() definition code for java.util.concurrent.CopyOnWriteArraySet.toArray() ()
          Returns an array containing all of the elements in this collection.
<T> T[]
toArray sample code for java.util.concurrent.CopyOnWriteArraySet.toArray(T[]) definition code for java.util.concurrent.CopyOnWriteArraySet.toArray(T[]) (T[] a)
          Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
 
Methods inherited from class java.util.AbstractSet sample code for java.util.AbstractSet definition code for java.util.AbstractSet
equals sample code for java.util.AbstractSet.equals(java.lang.Object) definition code for java.util.AbstractSet.equals(java.lang.Object) , hashCode sample code for java.util.AbstractSet.hashCode() definition code for java.util.AbstractSet.hashCode()
 
Methods inherited from class java.util.AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection
toString sample code for java.util.AbstractCollection.toString() definition code for java.util.AbstractCollection.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CopyOnWriteArraySet sample code for java.util.concurrent.CopyOnWriteArraySet() definition code for java.util.concurrent.CopyOnWriteArraySet()

public CopyOnWriteArraySet()
Creates an empty set.


CopyOnWriteArraySet sample code for java.util.concurrent.CopyOnWriteArraySet(java.util.Collection<? extends E>) definition code for java.util.concurrent.CopyOnWriteArraySet(java.util.Collection<? extends E>)

public CopyOnWriteArraySet(Collection sample code for java.util.Collection definition code for java.util.Collection <? extends E> c)
Creates a set containing all of the elements of the specified Collection.

Parameters:
c - the collection
Method Detail

size sample code for java.util.concurrent.CopyOnWriteArraySet.size() definition code for java.util.concurrent.CopyOnWriteArraySet.size()

public int size()
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.size() definition code for java.util.AbstractCollection.size()
Returns the number of elements in this collection. If the collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:
size sample code for java.util.Collection.size() definition code for java.util.Collection.size() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
size sample code for java.util.Set.size() definition code for java.util.Set.size() in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Specified by:
size sample code for java.util.AbstractCollection.size() definition code for java.util.AbstractCollection.size() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
the number of elements in this collection.

isEmpty sample code for java.util.concurrent.CopyOnWriteArraySet.isEmpty() definition code for java.util.concurrent.CopyOnWriteArraySet.isEmpty()

public boolean isEmpty()
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.isEmpty() definition code for java.util.AbstractCollection.isEmpty()
Returns true if this collection contains no elements.

This implementation returns size() == 0.

Specified by:
isEmpty sample code for java.util.Collection.isEmpty() definition code for java.util.Collection.isEmpty() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
isEmpty sample code for java.util.Set.isEmpty() definition code for java.util.Set.isEmpty() in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
isEmpty sample code for java.util.AbstractCollection.isEmpty() definition code for java.util.AbstractCollection.isEmpty() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
true if this collection contains no elements.

contains sample code for java.util.concurrent.CopyOnWriteArraySet.contains(java.lang.Object) definition code for java.util.concurrent.CopyOnWriteArraySet.contains(java.lang.Object)

public boolean contains(Object sample code for java.lang.Object definition code for java.lang.Object  o)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object)
Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.

Specified by:
contains sample code for java.util.Collection.contains(java.lang.Object) definition code for java.util.Collection.contains(java.lang.Object) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
contains sample code for java.util.Set.contains(java.lang.Object) definition code for java.util.Set.contains(java.lang.Object) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
contains sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
o - object to be checked for containment in this collection.
Returns:
true if this collection contains the specified element.

toArray sample code for java.util.concurrent.CopyOnWriteArraySet.toArray() definition code for java.util.concurrent.CopyOnWriteArraySet.toArray()

public Object sample code for java.lang.Object definition code for java.lang.Object [] toArray()
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.toArray() definition code for java.util.AbstractCollection.toArray()
Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array will be "safe" in that no references to it are maintained by the collection. (In other words, this method must allocate a new array even if the collection is backed by an Array). The caller is thus free to modify the returned array.

This implementation allocates the array to be returned, and iterates over the elements in the collection, storing each object reference in the next consecutive element of the array, starting with element 0.

Specified by:
toArray sample code for java.util.Collection.toArray() definition code for java.util.Collection.toArray() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
toArray sample code for java.util.Set.toArray() definition code for java.util.Set.toArray() in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
toArray sample code for java.util.AbstractCollection.toArray() definition code for java.util.AbstractCollection.toArray() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
an array containing all of the elements in this collection.

toArray sample code for java.util.concurrent.CopyOnWriteArraySet.<T>toArray(T[]) definition code for java.util.concurrent.CopyOnWriteArraySet.<T>toArray(T[])

public <T> T[] toArray(T[] a)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.toArray(T[]) definition code for java.util.AbstractCollection.toArray(T[])
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If the collection fits in the specified array with room to spare (i.e., the array has more elements than the collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of the collection only if the caller knows that the collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

This implementation checks if the array is large enough to contain the collection; if not, it allocates a new array of the correct size and type (using reflection). Then, it iterates over the collection, storing each object reference in the next consecutive element of the array, starting with element 0. If the array is larger than the collection, a null is stored in the first location after the end of the collection.

Specified by:
toArray sample code for java.util.Collection.toArray(T[]) definition code for java.util.Collection.toArray(T[]) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
toArray sample code for java.util.Set.toArray(T[]) definition code for java.util.Set.toArray(T[]) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
toArray sample code for java.util.AbstractCollection.toArray(T[]) definition code for java.util.AbstractCollection.toArray(T[]) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
a - the array into which the elements of the collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
Returns:
an array containing the elements of the collection.

clear sample code for java.util.concurrent.CopyOnWriteArraySet.clear() definition code for java.util.concurrent.CopyOnWriteArraySet.clear()

public void clear()
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.clear() definition code for java.util.AbstractCollection.clear()
Removes all of the elements from this collection (optional operation). The collection will be empty after this call returns (unless it throws an exception).

This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.

Specified by:
clear sample code for java.util.Collection.clear() definition code for java.util.Collection.clear() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
clear sample code for java.util.Set.clear() definition code for java.util.Set.clear() in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
clear sample code for java.util.AbstractCollection.clear() definition code for java.util.AbstractCollection.clear() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>

iterator sample code for java.util.concurrent.CopyOnWriteArraySet.iterator() definition code for java.util.concurrent.CopyOnWriteArraySet.iterator()

public Iterator sample code for java.util.Iterator definition code for java.util.Iterator <E> iterator()
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.iterator() definition code for java.util.AbstractCollection.iterator()
Returns an iterator over the elements contained in this collection.

Specified by:
iterator sample code for java.lang.Iterable.iterator() definition code for java.lang.Iterable.iterator() in interface Iterable sample code for java.lang.Iterable definition code for java.lang.Iterable <E>
Specified by:
iterator sample code for java.util.Collection.iterator() definition code for java.util.Collection.iterator() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
iterator sample code for java.util.Set.iterator() definition code for java.util.Set.iterator() in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Specified by:
iterator sample code for java.util.AbstractCollection.iterator() definition code for java.util.AbstractCollection.iterator() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
an iterator over the elements contained in this collection.

remove sample code for java.util.concurrent.CopyOnWriteArraySet.remove(java.lang.Object) definition code for java.util.concurrent.CopyOnWriteArraySet.remove(java.lang.Object)

public boolean remove(Object sample code for java.lang.Object definition code for java.lang.Object  o)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.remove(java.lang.Object) definition code for java.util.AbstractCollection.remove(java.lang.Object)
Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the collection contains one or more such elements. Returns true if the collection contained the specified element (or equivalently, if the collection changed as a result of the call).

This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.

Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.

Specified by:
remove sample code for java.util.Collection.remove(java.lang.Object) definition code for java.util.Collection.remove(java.lang.Object) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
remove sample code for java.util.Set.remove(java.lang.Object) definition code for java.util.Set.remove(java.lang.Object) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
remove sample code for java.util.AbstractCollection.remove(java.lang.Object) definition code for java.util.AbstractCollection.remove(java.lang.Object) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
o - element to be removed from this collection, if present.
Returns:
true if the collection contained the specified element.

add sample code for java.util.concurrent.CopyOnWriteArraySet.add(E) definition code for java.util.concurrent.CopyOnWriteArraySet.add(E)

public boolean add(E o)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.add(E) definition code for java.util.AbstractCollection.add(E)
Ensures that this collection contains the specified element (optional operation). Returns true if the collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.) Collections that support this operation may place limitations on what elements may be added to the collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

This implementation always throws an UnsupportedOperationException.

Specified by:
add sample code for java.util.Collection.add(E) definition code for java.util.Collection.add(E) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
add sample code for java.util.Set.add(E) definition code for java.util.Set.add(E) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
add sample code for java.util.AbstractCollection.add(E) definition code for java.util.AbstractCollection.add(E) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
o - element whose presence in this collection is to be ensured.
Returns:
true if the collection changed as a result of the call.

containsAll sample code for java.util.concurrent.CopyOnWriteArraySet.containsAll(java.util.Collection<?>) definition code for java.util.concurrent.CopyOnWriteArraySet.containsAll(java.util.Collection<?>)

public boolean containsAll(Collection sample code for java.util.Collection definition code for java.util.Collection <?> c)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.containsAll(java.util.Collection) definition code for java.util.AbstractCollection.containsAll(java.util.Collection)
Returns true if this collection contains all of the elements in the specified collection.

This implementation iterates over the specified collection, checking each element returned by the iterator in turn to see if it's contained in this collection. If all elements are so contained true is returned, otherwise false.

Specified by:
containsAll sample code for java.util.Collection.containsAll(java.util.Collection) definition code for java.util.Collection.containsAll(java.util.Collection) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
containsAll sample code for java.util.Set.containsAll(java.util.Collection) definition code for java.util.Set.containsAll(java.util.Collection) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
containsAll sample code for java.util.AbstractCollection.containsAll(java.util.Collection) definition code for java.util.AbstractCollection.containsAll(java.util.Collection) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
c - collection to be checked for containment in this collection.
Returns:
true if this collection contains all of the elements in the specified collection.
See Also:
AbstractCollection.contains(Object) sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object)

addAll sample code for java.util.concurrent.CopyOnWriteArraySet.addAll(java.util.Collection<? extends E>) definition code for java.util.concurrent.CopyOnWriteArraySet.addAll(java.util.Collection<? extends E>)

public boolean addAll(Collection sample code for java.util.Collection definition code for java.util.Collection <? extends E> c)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.addAll(java.util.Collection) definition code for java.util.AbstractCollection.addAll(java.util.Collection)
Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn.

Note that this implementation will throw an UnsupportedOperationException unless add is overridden (assuming the specified collection is non-empty).

Specified by:
addAll sample code for java.util.Collection.addAll(java.util.Collection) definition code for java.util.Collection.addAll(java.util.Collection) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
addAll sample code for java.util.Set.addAll(java.util.Collection) definition code for java.util.Set.addAll(java.util.Collection) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
addAll sample code for java.util.AbstractCollection.addAll(java.util.Collection) definition code for java.util.AbstractCollection.addAll(java.util.Collection) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
c - collection whose elements are to be added to this collection.
Returns:
true if this collection changed as a result of the call.
See Also:
AbstractCollection.add(Object) sample code for java.util.AbstractCollection.add(E) definition code for java.util.AbstractCollection.add(E)

removeAll sample code for java.util.concurrent.CopyOnWriteArraySet.removeAll(java.util.Collection<?>) definition code for java.util.concurrent.CopyOnWriteArraySet.removeAll(java.util.Collection<?>)

public boolean removeAll(Collection sample code for java.util.Collection definition code for java.util.Collection <?> c)
Description copied from class: AbstractSet sample code for java.util.AbstractSet.removeAll(java.util.Collection) definition code for java.util.AbstractSet.removeAll(java.util.Collection)
Removes from this set all of its elements that are contained in the specified collection (optional operation).

This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.

Specified by:
removeAll sample code for java.util.Collection.removeAll(java.util.Collection) definition code for java.util.Collection.removeAll(java.util.Collection) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
removeAll sample code for java.util.Set.removeAll(java.util.Collection) definition code for java.util.Set.removeAll(java.util.Collection) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
removeAll sample code for java.util.AbstractSet.removeAll(java.util.Collection) definition code for java.util.AbstractSet.removeAll(java.util.Collection) in class AbstractSet sample code for java.util.AbstractSet definition code for java.util.AbstractSet <E>
Parameters:
c - elements to be removed from this set.
Returns:
true if this set changed as a result of the call.
See Also:
AbstractCollection.remove(Object) sample code for java.util.AbstractCollection.remove(java.lang.Object) definition code for java.util.AbstractCollection.remove(java.lang.Object) , AbstractCollection.contains(Object) sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object)

retainAll sample code for java.util.concurrent.CopyOnWriteArraySet.retainAll(java.util.Collection<?>) definition code for java.util.concurrent.CopyOnWriteArraySet.retainAll(java.util.Collection<?>)

public boolean retainAll(Collection sample code for java.util.Collection definition code for java.util.Collection <?> c)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.retainAll(java.util.Collection) definition code for java.util.AbstractCollection.retainAll(java.util.Collection)
Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's not so contained, it's removed from this collection with the iterator's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements not present in the specified collection.

Specified by:
retainAll sample code for java.util.Collection.retainAll(java.util.Collection) definition code for java.util.Collection.retainAll(java.util.Collection) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
retainAll sample code for java.util.Set.retainAll(java.util.Collection) definition code for java.util.Set.retainAll(java.util.Collection) in interface Set sample code for java.util.Set definition code for java.util.Set <E>
Overrides:
retainAll sample code for java.util.AbstractCollection.retainAll(java.util.Collection) definition code for java.util.AbstractCollection.retainAll(java.util.Collection) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
c - elements to be retained in this collection.
Returns:
true if this collection changed as a result of the call.
See Also:
AbstractCollection.remove(Object) sample code for java.util.AbstractCollection.remove(java.lang.Object) definition code for java.util.AbstractCollection.remove(java.lang.Object) , AbstractCollection.contains(Object) sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object)