Package org.apache.commons.collections.set

Class SynchronizedSet

java.lang.Object
org.apache.commons.collections.collection.SynchronizedCollection
org.apache.commons.collections.set.SynchronizedSet
All Implemented Interfaces:
Serializable, Iterable, Collection, Set
public class SynchronizedSet extends SynchronizedCollection implements Set
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: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
Author:
Stephen Colebourne
See Also:

  • Constructor Details

    • SynchronizedSet

      protected SynchronizedSet(Set 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 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 Details

    • decorate

      public static Set decorate(Set 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 getSet()
      Gets the decorated set.
      Returns:
      the decorated set