public final class UnmodifiableBag extends AbstractBagDecorator implements Unmodifiable, Serializable
Bag to ensure it can't be altered.
This class is Serializable from Commons Collections 3.1.
collection| Modifier and Type | Method and Description |
|---|---|
boolean |
add(Object object)
(Violation)
Adds one copy the specified object to the Bag.
|
boolean |
add(Object object,
int count)
Adds
nCopies copies of the specified object to the Bag. |
boolean |
addAll(Collection coll) |
void |
clear() |
static Bag |
decorate(Bag bag)
Factory method to create an unmodifiable bag.
|
Iterator |
iterator()
Returns an
Iterator over the entire set of members,
including copies due to cardinality. |
boolean |
remove(Object object)
(Violation)
Removes all occurrences of the given object from the bag.
|
boolean |
remove(Object object,
int count)
Removes
nCopies copies of the specified object from the Bag. |
boolean |
removeAll(Collection coll)
(Violation)
Remove all elements represented in the given collection,
respecting cardinality.
|
boolean |
retainAll(Collection coll)
(Violation)
Remove any members of the bag that are not in the given
collection, respecting cardinality.
|
Set |
uniqueSet()
Returns a
Set of unique elements in the Bag. |
getBag, getCountcontains, containsAll, equals, getCollection, hashCode, isEmpty, size, toArray, toArray, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitcontainsAll, sizepublic static Bag decorate(Bag bag)
If the bag passed in is already unmodifiable, it is returned.
bag - the bag to decorate, must not be nullIllegalArgumentException - if bag is nullpublic Iterator iterator()
BagIterator over the entire set of members,
including copies due to cardinality. This iterator is fail-fast
and will not tolerate concurrent modifications.iterator in interface Iterableiterator in interface Collectioniterator in interface Bagiterator in class AbstractCollectionDecoratorpublic boolean add(Object object)
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 1.
Since this method always increases the size of the bag,
according to the Collection.add(Object) contract, it
should always return true. Since it sometimes returns
false, this method violates the contract.
add in interface Collectionadd in interface Bagadd in class AbstractCollectionDecoratorobject - the object to addtrue if the object was not already in the uniqueSetpublic boolean addAll(Collection coll)
addAll in interface CollectionaddAll in class AbstractCollectionDecoratorpublic void clear()
clear in interface Collectionclear in class AbstractCollectionDecoratorpublic boolean remove(Object object)
Bag
This will also remove the object from the Bag.uniqueSet().
According to the Collection.remove(Object) method,
this method should only remove the first occurrence of the
given object, not all occurrences.
remove in interface Collectionremove in interface Bagremove in class AbstractCollectionDecoratortrue if this call changed the collectionpublic boolean removeAll(Collection coll)
Bagcoll contains n copies of a given object,
the bag will have n fewer copies, assuming the bag
had at least n copies to begin with.
The Collection.removeAll(Collection) method specifies
that cardinality should not be respected; this method should
remove all occurrences of every object contained in the
given collection.
removeAll in interface CollectionremoveAll in interface BagremoveAll in class AbstractCollectionDecoratorcoll - the collection to removetrue if this call changed the collectionpublic boolean retainAll(Collection coll)
Bagcoll contains n copies of a
given object and the bag has m > n copies, then
delete m - n copies from the bag. In addition, if
e is an object in the bag but
!coll.contains(e), then remove e and any
of its copies.
The Collection.retainAll(Collection) method specifies
that cardinality should not be respected; this method should
keep all occurrences of every object contained in the
given collection.
retainAll in interface CollectionretainAll in interface BagretainAll in class AbstractCollectionDecoratorcoll - the collection to retaintrue if this call changed the collectionpublic boolean add(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 Bagadd in class AbstractBagDecoratorobject - the object to addcount - the number of copies to addtrue if the object was not already in the uniqueSetpublic boolean remove(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 Bagremove in class AbstractBagDecoratorobject - the object to removecount - the number of copies to removetrue if this call changed the collectionCopyright © 2001–2015 The Apache Software Foundation. All rights reserved.