org.apache.commons.collections.set

Class SynchronizedSet

Implemented Interfaces:
Collection, Serializable, 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.

Version:
$Revision: 1.5 $ $Date: 2004/06/03 22:02:13 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

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

collection, lock

Constructor Summary

SynchronizedSet(Set set)
Constructor that wraps (not copies).
SynchronizedSet(Set set, Object lock)
Constructor that wraps (not copies).

Method Summary

static Set
decorate(Set set)
Factory method to create a synchronized set.
protected Set
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

Constructor Details

SynchronizedSet

protected SynchronizedSet(Set set)
Constructor that wraps (not copies).
Parameters:
set - the set to decorate, must not be 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

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

getSet

protected Set getSet()
Gets the decorated set.
Returns:
the decorated set

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.