Class PredicatedMultiSet<E>
- Type Parameters:
- E- the type held in the multiset
- All Implemented Interfaces:
- Serializable,- Iterable<E>,- Collection<E>,- MultiSet<E>
MultiSet to validate that additions
 match a specified predicate.
 
 This multiset exists to provide validation for the decorated multiset.
 It is normally created to decorate an empty multiset.
 If an object cannot be added to the multiset, an IllegalArgumentException
 is thrown.
 
One usage would be to ensure that no null entries are added to the multiset.
 MultiSet<E> set =
      PredicatedMultiSet.predicatedMultiSet(new HashMultiSet<E>(),
                                            NotNullPredicate.notNullPredicate());
 - Since:
- 4.1
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from class org.apache.commons.collections4.collection.PredicatedCollectionPredicatedCollection.Builder<E>Nested classes/interfaces inherited from interface org.apache.commons.collections4.MultiSetMultiSet.Entry<E>
- 
Field SummaryFields inherited from class org.apache.commons.collections4.collection.PredicatedCollectionpredicate
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedPredicatedMultiSet(MultiSet<E> multiset, Predicate<? super E> predicate) Constructor that wraps (not copies).
- 
Method SummaryModifier and TypeMethodDescriptionintAdds a number of occurrences of the specified object to the MultiSet.Gets the decorated multiset.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.static <E> PredicatedMultiSet<E> predicatedMultiSet(MultiSet<E> multiset, Predicate<? super E> predicate) Factory method to create a predicated (validating) multiset.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.PredicatedCollectionadd, addAll, builder, notNullBuilder, predicatedCollection, validateMethods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecoratorclear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, setCollection, size, toArray, toArray, toStringMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.CollectionaddAll, clear, contains, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArray
- 
Constructor Details- 
PredicatedMultiSetConstructor that wraps (not copies).If there are any elements already in the multiset being decorated, they are validated. - Parameters:
- multiset- the multiset to decorate, must not be null
- predicate- the predicate to use for validation, must not be null
- Throws:
- NullPointerException- if multiset or predicate is null
- IllegalArgumentException- if the multiset contains invalid elements
 
 
- 
- 
Method Details- 
predicatedMultiSetpublic static <E> PredicatedMultiSet<E> predicatedMultiSet(MultiSet<E> multiset, Predicate<? super E> predicate) Factory method to create a predicated (validating) multiset.If there are any elements already in the multiset being decorated, they are validated. - Type Parameters:
- E- the type of the elements in the multiset
- Parameters:
- multiset- the multiset to decorate, must not be null
- predicate- the predicate to use for validation, must not be null
- Returns:
- a new predicated MultiSet
- Throws:
- NullPointerException- if multiset or predicate is null
- IllegalArgumentException- if the multiset contains invalid elements
 
- 
addDescription 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
- 
equalsDescription 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. 
- 
getCountDescription 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.
- 
hashCodeDescription 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).
- 
removeDescription 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. 
- 
setCountDescription 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().
- 
uniqueSetDescription 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. 
 
-