public class SynchronizedBag<E> extends SynchronizedCollection<E> implements Bag<E>
Bag
to synchronize its behaviour
for a multi-threaded environment.
Methods are synchronized, then forwarded to the decorated bag. Iterators must be separately synchronized around the loop.
This class is Serializable from Commons Collections 3.1.
lock
Modifier | Constructor and Description |
---|---|
protected |
SynchronizedBag(Bag<E> bag)
Constructor that wraps (not copies).
|
protected |
SynchronizedBag(Bag<E> bag,
Object lock)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(E object,
int count)
Adds
nCopies copies of the specified object to the Bag. |
protected Bag<E> |
getBag()
Gets the bag being decorated.
|
int |
getCount(Object object)
Returns the number of occurrences (cardinality) of the given
object currently in the bag.
|
boolean |
remove(Object object,
int count)
Removes
nCopies copies of the specified object from the Bag. |
static <E> SynchronizedBag<E> |
synchronizedBag(Bag<E> bag)
Factory method to create a synchronized bag.
|
Set<E> |
uniqueSet()
Returns a
Set of unique elements in the Bag. |
add, addAll, clear, contains, containsAll, decorated, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, synchronizedCollection, toArray, toArray, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
protected SynchronizedBag(Bag<E> bag)
bag
- the bag to decorate, must not be nullIllegalArgumentException
- if bag is nullprotected SynchronizedBag(Bag<E> bag, Object lock)
bag
- the bag to decorate, must not be nulllock
- the lock to use, must not be nullIllegalArgumentException
- if bag is nullpublic static <E> SynchronizedBag<E> synchronizedBag(Bag<E> bag)
E
- the type of the elements in the bagbag
- the bag to decorate, must not be nullIllegalArgumentException
- if bag is nullpublic boolean add(E object, int count)
Bag
nCopies
copies of the specified object to the Bag.
If the object is already in the Bag.uniqueSet()
then increment its
count as reported by Bag.getCount(Object)
. Otherwise add it to the
Bag.uniqueSet()
and report its count as nCopies
.
public boolean remove(Object object, int count)
Bag
nCopies
copies of the specified object from the Bag.
If the number of copies to remove is greater than the actual number of copies in the Bag, no error is thrown.
Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.