Class UnmodifiableSortedBag<E>
- Type Parameters:
E
- the type of elements in this bag
- All Implemented Interfaces:
Serializable
,Iterable<E>
,Collection<E>
,Bag<E>
,SortedBag<E>
,Unmodifiable
SortedBag
to ensure it can't be altered.
This class is Serializable from Commons Collections 3.1.
Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 3.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
(Violation) Adds one copy of the specified object to the Bag.boolean
AddsnCopies
copies of the specified object to the Bag.boolean
addAll
(Collection<? extends E> coll) void
clear()
iterator()
Returns anIterator
over the entire set of members, including copies due to cardinality.boolean
(Violation) Removes all occurrences of the given object from the bag.boolean
RemovesnCopies
copies of the specified object from the Bag.boolean
removeAll
(Collection<?> coll) (Violation) Remove all elements represented in the given collection, respecting cardinality.boolean
boolean
retainAll
(Collection<?> coll) (Violation) Remove any members of the bag that are not in the given collection, respecting cardinality.Returns aSet
of unique elements in the Bag.static <E> SortedBag<E>
unmodifiableSortedBag
(SortedBag<E> bag) Factory method to create an unmodifiable bag.Methods inherited from class org.apache.commons.collections4.bag.AbstractSortedBagDecorator
comparator, decorated, first, last
Methods inherited from class org.apache.commons.collections4.bag.AbstractBagDecorator
equals, getCount, hashCode
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, isEmpty, setCollection, 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.collections4.Bag
containsAll, getCount, size
Methods inherited from interface java.util.Collection
contains, equals, hashCode, isEmpty, parallelStream, spliterator, stream, toArray, toArray
-
Method Details
-
unmodifiableSortedBag
Factory method to create an unmodifiable bag.If the bag passed in is already unmodifiable, it is returned.
- Type Parameters:
E
- the type of the elements in the bag- Parameters:
bag
- the bag to decorate, must not be null- Returns:
- an unmodifiable SortedBag
- Throws:
NullPointerException
- if bag is null- Since:
- 4.0
-
add
Description copied from interface:Bag
(Violation) Adds one copy 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 as 1.Since this method always increases the size of the bag, according to the
Collection.add(Object)
contract, it should always returntrue
. Since it sometimes returnsfalse
, this method violates the contract.- Specified by:
add
in interfaceBag<E>
- Specified by:
add
in interfaceCollection<E>
- Overrides:
add
in classAbstractCollectionDecorator<E>
- Parameters:
object
- the object to add- Returns:
true
if the object was not already in theuniqueSet
-
add
Description copied from interface:Bag
AddsnCopies
copies 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
. -
addAll
- Specified by:
addAll
in interfaceCollection<E>
- Overrides:
addAll
in classAbstractCollectionDecorator<E>
-
clear
- Specified by:
clear
in interfaceCollection<E>
- Overrides:
clear
in classAbstractCollectionDecorator<E>
-
iterator
Description copied from interface:Bag
Returns anIterator
over the entire set of members, including copies due to cardinality. This iterator is fail-fast and will not tolerate concurrent modifications. -
remove
Description copied from interface:Bag
(Violation) Removes all occurrences of the given object from the 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.- Specified by:
remove
in interfaceBag<E>
- Specified by:
remove
in interfaceCollection<E>
- Overrides:
remove
in classAbstractCollectionDecorator<E>
- Parameters:
object
- the object to remove- Returns:
true
if this call changed the collection
-
remove
Description copied from interface:Bag
RemovesnCopies
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.
-
removeAll
Description copied from interface:Bag
(Violation) Remove all elements represented in the given collection, respecting cardinality. That is, if the given collectioncoll
containsn
copies of a given object, the bag will haven
fewer copies, assuming the bag had at leastn
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.- Specified by:
removeAll
in interfaceBag<E>
- Specified by:
removeAll
in interfaceCollection<E>
- Overrides:
removeAll
in classAbstractCollectionDecorator<E>
- Parameters:
coll
- the collection to remove- Returns:
true
if this call changed the collection
-
removeIf
- Specified by:
removeIf
in interfaceCollection<E>
- Overrides:
removeIf
in classAbstractCollectionDecorator<E>
- Since:
- 4.4
-
retainAll
Description copied from interface:Bag
(Violation) Remove any members of the bag that are not in the given collection, respecting cardinality. That is, if the given collectioncoll
containsn
copies of a given object and the bag hasm > n
copies, then deletem - n
copies from the bag. In addition, ife
is an object in the bag but!coll.contains(e)
, then removee
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.- Specified by:
retainAll
in interfaceBag<E>
- Specified by:
retainAll
in interfaceCollection<E>
- Overrides:
retainAll
in classAbstractCollectionDecorator<E>
- Parameters:
coll
- the collection to retain- Returns:
true
if this call changed the collection
-
uniqueSet
Description copied from interface:Bag
-