Class AbstractMultiSetDecorator<E>
- Type Parameters:
E- the type held in the multiset
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,MultiSet<E>
- Direct Known Subclasses:
UnmodifiableMultiSet
MultiSet to provide additional behavior.
Methods are forwarded directly to the decorated multiset.
- Since:
- 4.1
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.commons.collections4.MultiSet
MultiSet.Entry<E> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor only used in deserialization, do not use otherwise.protectedAbstractMultiSetDecorator(MultiSet<E> multiset) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionintAdds a number of occurrences of the specified object to the MultiSet.Gets the multiset being decorated.entrySet()Returns aSetof all entries contained in the MultiSet.booleanCompares this MultiSet to another object.intGets the number of occurrences of the given object currently in the MultiSet.inthashCode()Gets a hash code for the MultiSet compatible with the definition of equals.intRemoves a number of occurrences of the specified object from the MultiSet.intSets the number of occurrences of the specified object in the MultiSet to the given count.Returns aSetof unique elements in the MultiSet.Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, setCollection, size, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
addAll, clear, contains, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArray
-
Constructor Details
-
AbstractMultiSetDecorator
protected AbstractMultiSetDecorator()Constructor only used in deserialization, do not use otherwise. -
AbstractMultiSetDecorator
Constructor that wraps (not copies).- Parameters:
multiset- the multiset to decorate, must not be null- Throws:
NullPointerException- if multiset is null
-
-
Method Details
-
add
Description copied from interface:MultiSetAdds a number of occurrences of the specified object to the MultiSet.If the object is already in the
MultiSet.uniqueSet()then increment its count as reported byMultiSet.getCount(Object). Otherwise, add it to theMultiSet.uniqueSet()and report its count asoccurrences. -
decorated
-
entrySet
-
equals
Description copied from interface:MultiSetCompares this MultiSet to another object.This MultiSet equals another object if it is also a MultiSet that contains the same number of occurrences of the same elements.
-
getCount
Description copied from interface:MultiSetGets the number of occurrences of the given object currently in the MultiSet. If the object does not exist in the multiset, return 0. -
hashCode
Description copied from interface:MultiSetGets a hash code for the MultiSet compatible with the definition of equals. The hash code is defined as the sum total of a hash code for each element. The per element hash code is defined as(e==null ? 0 : e.hashCode()) ^ noOccurrences). -
remove
Description copied from interface:MultiSetRemoves a number of occurrences of the specified object from the MultiSet.If the number of occurrences to remove is greater than the actual number of occurrences in the multiset, the object will be removed from the multiset.
-
setCount
Description copied from interface:MultiSetSets the number of occurrences of the specified object in the MultiSet to the given count.If the provided count is zero, the object will be removed from the
MultiSet.uniqueSet(). -
uniqueSet
Description copied from interface:MultiSetReturns aSetof unique elements in the MultiSet.Uniqueness constraints are the same as those in
Set.The returned set is backed by this multiset, so any change to either is immediately reflected in the other. Only removal operations are supported, in which case all occurrences of the element are removed from the backing multiset.
-