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
MultSet
to provide additional behaviour.
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>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serialization version -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor only used in deserialization, do not use otherwise.protected
AbstractMultiSetDecorator
(MultiSet<E> multiset) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionint
Adds a number of occurrences of the specified object to the MultiSet.Gets the multiset being decorated.entrySet()
Returns aSet
of all entries contained in the MultiSet.boolean
Compares this MultiSet to another object.int
Returns the number of occurrences of the given object currently in the MultiSet.int
hashCode()
Gets a hash code for the MultiSet compatible with the definition of equals.int
Removes a number of occurrences of the specified object from the MultiSet.int
Sets the number of occurrences of the specified object in the MultiSet to the given count.Returns aSet
of 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, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
addAll, clear, contains, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArray
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerialization version- See Also:
-
-
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
-
decorated
Gets the multiset being decorated.- Overrides:
decorated
in classAbstractCollectionDecorator<E>
- Returns:
- the decorated multiset
-
equals
Description copied from interface:MultiSet
Compares 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.
-
hashCode
public int hashCode()Description copied from interface:MultiSet
Gets 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()) ^ noOccurances)
. -
getCount
Description copied from interface:MultiSet
Returns the number of occurrences of the given object currently in the MultiSet. If the object does not exist in the multiset, return 0. -
setCount
Description copied from interface:MultiSet
Sets 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()
. -
add
Description copied from interface:MultiSet
Adds 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
. -
remove
Description copied from interface:MultiSet
Removes 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.
-
uniqueSet
Description copied from interface:MultiSet
Returns aSet
of 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.
-
entrySet
Description copied from interface:MultiSet
Returns aSet
of all entries contained in the MultiSet.The returned set is backed by this multiset, so any change to either is immediately reflected in the other.
-