org.apache.commons.collections.collection
Class SynchronizedCollection

java.lang.Object
  |
  +--org.apache.commons.collections.collection.SynchronizedCollection

All Implemented Interfaces:

java.util.Collection

Direct Known Subclasses:

SynchronizedBag, SynchronizedBuffer, SynchronizedList, SynchronizedSet, SynchronizedSortedSet

public class SynchronizedCollection

extends java.lang.Object

implements java.util.Collection

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

Iterators must be manually synchronized:

 synchronized (coll) {
   Iterator it = coll.iterator();
   // do stuff with iterator
 }
 

Since:

Commons Collections 3.0

Version:

$Revision: 1.3 $ $Date: 2004/01/14 21:43:18 $

Author:

Stephen Colebourne

Method Summary

boolean	add(java.lang.Object object)
boolean	addAll(java.util.Collection coll)
void	clear()
boolean	contains(java.lang.Object object)
boolean	containsAll(java.util.Collection coll)
static java.util.Collection	decorate(java.util.Collection coll) Factory method to create a synchronized collection.
boolean	equals(java.lang.Object object)
int	hashCode()
boolean	isEmpty()
java.util.Iterator	iterator() Iterators must be manually synchronized.
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection coll)
boolean	retainAll(java.util.Collection coll)
int	size()
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] object)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

decorate

public static java.util.Collection decorate(java.util.Collection coll)

Factory method to create a synchronized collection.

Parameters:

coll - the collection to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if collection is null

add

public boolean add(java.lang.Object object)

Specified by:

add in interface java.util.Collection

addAll

public boolean addAll(java.util.Collection coll)

Specified by:

addAll in interface java.util.Collection

clear

public void clear()

Specified by:

clear in interface java.util.Collection

contains

public boolean contains(java.lang.Object object)

Specified by:

contains in interface java.util.Collection

containsAll

public boolean containsAll(java.util.Collection coll)

Specified by:

containsAll in interface java.util.Collection

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

iterator

public java.util.Iterator iterator()

Iterators must be manually synchronized.

 synchronized (coll) {
   Iterator it = coll.iterator();
   // do stuff with iterator
 }


Specified by:
iterator in interface java.util.Collection



Returns:
an iterator that must be manually synchronized on the collection

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] object)

Specified by:

toArray in interface java.util.Collection

remove

public boolean remove(java.lang.Object object)

Specified by:

remove in interface java.util.Collection

removeAll

public boolean removeAll(java.util.Collection coll)

Specified by:

removeAll in interface java.util.Collection

retainAll

public boolean retainAll(java.util.Collection coll)

Specified by:

retainAll in interface java.util.Collection

size

public int size()

Specified by:

size in interface java.util.Collection

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Collection

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object