|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.collection.SynchronizedCollection
org.apache.commons.collections.bag.SynchronizedBag
public class SynchronizedBag
Decorates another 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.
| Field Summary |
|---|
| Fields inherited from class org.apache.commons.collections.collection.SynchronizedCollection |
|---|
collection, lock |
| Constructor Summary | |
|---|---|
protected |
SynchronizedBag(Bag bag)
Constructor that wraps (not copies). |
protected |
SynchronizedBag(Bag bag,
java.lang.Object lock)
Constructor that wraps (not copies). |
| Method Summary | |
|---|---|
boolean |
add(java.lang.Object object,
int count)
Adds nCopies copies of the specified object to the Bag. |
static Bag |
decorate(Bag bag)
Factory method to create a synchronized bag. |
protected Bag |
getBag()
Gets the bag being decorated. |
int |
getCount(java.lang.Object object)
Returns the number of occurrences (cardinality) of the given object currently in the bag. |
boolean |
remove(java.lang.Object object,
int count)
Removes nCopies copies of the specified object from the Bag. |
java.util.Set |
uniqueSet()
Returns a Set of unique elements in the Bag. |
| 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 |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.apache.commons.collections.Bag |
|---|
add, containsAll, iterator, remove, removeAll, retainAll, size |
| Methods inherited from interface java.util.Collection |
|---|
addAll, clear, contains, equals, hashCode, isEmpty, toArray, toArray |
| Constructor Detail |
|---|
protected SynchronizedBag(Bag bag)
bag - the bag to decorate, must not be null
java.lang.IllegalArgumentException - if bag is null
protected SynchronizedBag(Bag bag,
java.lang.Object lock)
bag - the bag to decorate, must not be nulllock - the lock to use, must not be null
java.lang.IllegalArgumentException - if bag is null| Method Detail |
|---|
public static Bag decorate(Bag bag)
bag - the bag to decorate, must not be null
java.lang.IllegalArgumentException - if bag is nullprotected Bag getBag()
public boolean add(java.lang.Object object,
int count)
BagnCopies 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.
add in interface Bagobject - the object to addcount - the number of copies to add
true if the object was not already in the uniqueSet
public boolean remove(java.lang.Object object,
int count)
BagnCopies 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.
remove in interface Bagobject - the object to removecount - the number of copies to remove
true if this call changed the collectionpublic java.util.Set uniqueSet()
BagSet of unique elements in the Bag.
Uniqueness constraints are the same as those in Set.
uniqueSet in interface Bagpublic int getCount(java.lang.Object object)
Bag
getCount in interface Bagobject - the object to search for
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||