public final Class UnmodifiableBag<E>

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.add.

Implements org.apache.commons.collections4.Bag.add, java.util.Collection.add.

Doc from org.apache.commons.collections4.Bag.add.

(Violation) Adds one copy of the specified object to the Bag.

If the object is already in the uniqueSet() then increment its count as reported by getCount(Object). Otherwise add it to the 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.

Parameters

object:E

the object to add

Returns:boolean

true if the object was not already in the uniqueSet

Annotations

@Override

Overrides org.apache.commons.collections4.bag.AbstractBagDecorator.add.

Implements org.apache.commons.collections4.Bag.add.

Doc from org.apache.commons.collections4.Bag.add.

Adds nCopies copies of the specified object to the Bag.

If the object is already in the uniqueSet() then increment its count as reported by getCount(Object). Otherwise add it to the uniqueSet() and report its count as nCopies.

Parameters

object:E

the object to add

count:int

the number of copies to add

Returns:boolean

true if the object was not already in the uniqueSet

Annotations

@Override

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.addAll.

Implements java.util.Collection.addAll.

Doc from java.util.Collection.addAll.

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.) If the specified collection has a defined encounter order, processing of its elements generally occurs in that order.

Parameters

coll:Collection<? extends E>

collection containing elements to be added to this collection

Returns:boolean

true if this collection changed as a result of the call

Annotations

@Override

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.clear.

Implements java.util.Collection.clear.

Doc from java.util.Collection.clear.

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

Annotations

@Override

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.iterator.

Implements org.apache.commons.collections4.Bag.iterator, java.util.Collection.iterator.

Doc from org.apache.commons.collections4.Bag.iterator.

Returns an Iterator over the entire set of members, including copies due to cardinality. This iterator is fail-fast and will not tolerate concurrent modifications.

Returns:Iterator<E>

iterator over all elements in the Bag

Annotations

@Override

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.remove.

Implements org.apache.commons.collections4.Bag.remove, java.util.Collection.remove.

Doc from org.apache.commons.collections4.Bag.remove.

(Violation) Removes all occurrences of the given object from the bag.

This will also remove the object from the uniqueSet().

According to the Collection#remove(Object) method, this method should only remove the first occurrence of the given object, not all occurrences.

Parameters

object:Object

the object to remove

Returns:boolean

true if this call changed the collection

Annotations

@Override

Overrides org.apache.commons.collections4.bag.AbstractBagDecorator.remove.

Implements org.apache.commons.collections4.Bag.remove.

Doc from org.apache.commons.collections4.Bag.remove.

Removes 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.

Parameters

object:Object

the object to remove

count:int

the number of copies to remove

Returns:boolean

true if this call changed the collection

Annotations

@Override

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeAll.

Implements org.apache.commons.collections4.Bag.removeAll, java.util.Collection.removeAll.

Doc from org.apache.commons.collections4.Bag.removeAll.

(Violation) Remove all elements represented in the given collection, respecting cardinality. That is, if the given collection coll 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.

Parameters

coll:Collection<?>

the collection to remove

Returns:boolean

true if this call changed the collection

Annotations

@Override

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.removeIf.

Overrides default java.util.Collection.removeIf.

Doc from java.util.Collection.removeIf.

Removes all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.

Parameters

filter:Predicate<? super E>

a predicate which returns true for elements to be removed

Returns:boolean

true if any elements were removed

Annotations

@Override

Since

4.4

Overrides org.apache.commons.collections4.collection.AbstractCollectionDecorator.retainAll.

Implements org.apache.commons.collections4.Bag.retainAll, java.util.Collection.retainAll.

Doc from org.apache.commons.collections4.Bag.retainAll.

(Violation) Remove any members of the bag that are not in the given collection, respecting cardinality. That is, if the given collection coll 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.

Parameters

coll:Collection<?>

the collection to retain

Returns:boolean

true if this call changed the collection

Annotations

@Override

Overrides org.apache.commons.collections4.bag.AbstractBagDecorator.uniqueSet.

Implements org.apache.commons.collections4.Bag.uniqueSet.

Doc from org.apache.commons.collections4.Bag.uniqueSet.

Returns a Set of unique elements in the Bag.

Uniqueness constraints are the same as those in java.util.Set.

Returns:Set<E>

the Set of unique Bag elements

Annotations

@Override

Factory method to create an unmodifiable bag.

If the bag passed in is already unmodifiable, it is returned.

Parameters

<E>

the type of the elements in the bag

bag:Bag<? extends E>

the bag to decorate, must not be null

Returns:Bag<E>

an unmodifiable Bag

Exceptions

NullPointerException:

if bag is null

Since

4.0