org.apache.commons.collections.set
Class SynchronizedSet<E>

java.lang.Object
  org.apache.commons.collections.collection.SynchronizedCollection<E>
      org.apache.commons.collections.set.SynchronizedSet<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>

public class SynchronizedSet<E>
extends SynchronizedCollection<E>
implements Set<E>

Decorates another Set to synchronize its behaviour for a multi-threaded environment.

Methods are synchronized, then forwarded to the decorated set.

This class is Serializable from Commons Collections 3.1.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:36:23 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.commons.collections.collection.SynchronizedCollection

collection, lock

Constructor Summary

protected	SynchronizedSet(Set<E> set) Constructor that wraps (not copies).
protected	SynchronizedSet(Set<E> set, Object lock) Constructor that wraps (not copies).

Method Summary

static <E> Set<E>	decorate(Set<E> set) Factory method to create a synchronized set.
protected Set<E>	getSet() Gets the decorated set.

Methods inherited from class org.apache.commons.collections.collection.SynchronizedCollection

add, addAll, clear, contains, containsAll, decorate, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Constructor Detail

SynchronizedSet

protected SynchronizedSet(Set<E> set)

Constructor that wraps (not copies).

Parameters:

set - the set to decorate, must not be null

Throws:

IllegalArgumentException - if set is null

SynchronizedSet

protected SynchronizedSet(Set<E> set,
                          Object lock)

Constructor that wraps (not copies).

Parameters:

set - the set to decorate, must not be null

lock - the lock object to use, must not be null

Throws:

IllegalArgumentException - if set is null

Method Detail

decorate

public static <E> Set<E> decorate(Set<E> set)

Factory method to create a synchronized set.

Parameters:

set - the set to decorate, must not be null

Throws:

IllegalArgumentException - if set is null

getSet

protected Set<E> getSet()

Gets the decorated set.

Returns:

the decorated set