org.apache.commons.collections4.collection

Class SynchronizedCollection<E>

java.lang.Object

org.apache.commons.collections4.collection.SynchronizedCollection<E>

Type Parameters:

E - the type of the elements in the collection

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>

Direct Known Subclasses:

SynchronizedBag, SynchronizedBag.SynchronizedBagSet

public class SynchronizedCollection<E>
extends java.lang.Object
implements java.util.Collection<E>, java.io.Serializable

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
 }
 

This class is Serializable from Commons Collections 3.1.

Since:

3.0

Version:

$Id: SynchronizedCollection.java 1479401 2013-05-05 21:51:47Z tn $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<E>	collection The collection to decorate
protected java.lang.Object	lock The object to lock on, needed for List/SortedSet views
private static long	serialVersionUID Serialization version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SynchronizedCollection(java.util.Collection<E> collection) Constructor that wraps (not copies).
protected	SynchronizedCollection(java.util.Collection<E> collection, java.lang.Object lock) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
boolean	add(E object)
boolean	addAll(java.util.Collection<? extends E> coll)
void	clear()
boolean	contains(java.lang.Object object)
boolean	containsAll(java.util.Collection<?> coll)
protected java.util.Collection<E>	decorated() Gets the collection being decorated.
boolean	equals(java.lang.Object object)
int	hashCode()
boolean	isEmpty()
java.util.Iterator<E>	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()
static <T> SynchronizedCollection<T>	synchronizedCollection(java.util.Collection<T> coll) Factory method to create a synchronized collection.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] object)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

serialVersionUID

private static final long serialVersionUID

Serialization version

See Also:

Constant Field Values

collection

private final java.util.Collection<E> collection

The collection to decorate

lock

protected final java.lang.Object lock

The object to lock on, needed for List/SortedSet views

Constructor Detail

SynchronizedCollection

protected SynchronizedCollection(java.util.Collection<E> collection)

Constructor that wraps (not copies).

Parameters:

collection - the collection to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if the collection is null

SynchronizedCollection

protected SynchronizedCollection(java.util.Collection<E> collection,
                                 java.lang.Object lock)

Constructor that wraps (not copies).

Parameters:

collection - the collection to decorate, must not be null

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

Throws:

java.lang.IllegalArgumentException - if the collection is null

Method Detail

synchronizedCollection

public static <T> SynchronizedCollection<T> synchronizedCollection(java.util.Collection<T> coll)

Factory method to create a synchronized collection.

Type Parameters:

T - the type of the elements in the collection

Parameters:

coll - the collection to decorate, must not be null

Returns:

a new synchronized collection

Throws:

java.lang.IllegalArgumentException - if collection is null

Since:

4.0

decorated

protected java.util.Collection<E> decorated()

Gets the collection being decorated.

Returns:

the decorated collection

add

public boolean add(E object)

Specified by:

add in interface java.util.Collection<E>

addAll

public boolean addAll(java.util.Collection<? extends E> coll)

Specified by:

addAll in interface java.util.Collection<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

contains

public boolean contains(java.lang.Object object)

Specified by:

contains in interface java.util.Collection<E>

containsAll

public boolean containsAll(java.util.Collection<?> coll)

Specified by:

containsAll in interface java.util.Collection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

iterator

public java.util.Iterator<E> iterator()

Iterators must be manually synchronized.

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

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

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<E>

toArray

public <T> T[] toArray(T[] object)

Specified by:

toArray in interface java.util.Collection<E>

remove

public boolean remove(java.lang.Object object)

Specified by:

remove in interface java.util.Collection<E>

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Specified by:

removeAll in interface java.util.Collection<E>

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Specified by:

retainAll in interface java.util.Collection<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Collection<E>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object