Class SynchronizedBag<E>
java.lang.Object
org.apache.commons.collections4.collection.SynchronizedCollection<E>
org.apache.commons.collections4.bag.SynchronizedBag<E>
- Type Parameters:
E- the type of elements in this bag
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,Bag<E>
- Direct Known Subclasses:
SynchronizedSortedBag
Decorates another
Bag to synchronize its behavior
for a multithreaded 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.
- Since:
- 3.0
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.collections4.collection.SynchronizedCollection
lock -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSynchronizedBag(Bag<E> bag) Constructor that wraps (not copies).protectedSynchronizedBag(Bag<E> bag, Object lock) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionbooleanAddsnCopiescopies of the specified object to the Bag.booleangetBag()Gets the bag being decorated.intGets the number of occurrences (cardinality) of the given object currently in the bag.inthashCode()booleanRemovesnCopiescopies of the specified object from the Bag.static <E> SynchronizedBag<E> synchronizedBag(Bag<E> bag) Factory method to create a synchronized bag.Returns aSetof unique elements in the Bag.Methods inherited from class org.apache.commons.collections4.collection.SynchronizedCollection
add, addAll, clear, contains, containsAll, decorated, isEmpty, iterator, remove, removeAll, removeIf, retainAll, size, synchronizedCollection, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.Bag
add, containsAll, iterator, remove, removeAll, retainAll, sizeMethods inherited from interface java.util.Collection
addAll, clear, contains, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArray
-
Constructor Details
-
SynchronizedBag
Constructor that wraps (not copies).- Parameters:
bag- the bag to decorate, must not be null- Throws:
NullPointerException- if bag is null
-
SynchronizedBag
Constructor that wraps (not copies).- Parameters:
bag- the bag to decorate, must not be nulllock- the lock to use, must not be null- Throws:
NullPointerException- if bag or lock is null
-
-
Method Details
-
synchronizedBag
Factory method to create a synchronized bag.- Type Parameters:
E- the type of the elements in the bag- Parameters:
bag- the bag to decorate, must not be null- Returns:
- a new synchronized Bag
- Throws:
NullPointerException- if bag is null- Since:
- 4.0
-
add
Description copied from interface:BagAddsnCopiescopies of the specified object to the Bag.If the object is already in the
Bag.uniqueSet()then increment its count as reported byBag.getCount(Object). Otherwise add it to theBag.uniqueSet()and report its count asnCopies. -
equals
- Specified by:
equalsin interfaceCollection<E>- Overrides:
equalsin classSynchronizedCollection<E>
-
getBag
-
getCount
Description copied from interface:BagGets the number of occurrences (cardinality) of the given object currently in the bag. If the object does not exist in the bag, return 0. -
hashCode
- Specified by:
hashCodein interfaceCollection<E>- Overrides:
hashCodein classSynchronizedCollection<E>
-
remove
Description copied from interface:BagRemovesnCopiescopies 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.
-
uniqueSet
-