# Uses of Interface
org.apache.commons.collections4.MultiSet

Packages that use MultiSet
Package
Description
org.apache.commons.collections4
Interfaces and utilities shared across all packages.
org.apache.commons.collections4.collection
Implementations of the `Collection` interface.
org.apache.commons.collections4.multimap
Implements the `MultiValuedMap` interfaces.
org.apache.commons.collections4.multiset
Implements the `MultiSet` interface.

- ## Uses of MultiSet in org.apache.commons.collections4

  Subinterfaces of MultiSet in org.apache.commons.collections4
  Modifier and Type
  Interface
  Description
  `interface`
  `SortedMultiSet<E>`
  Defines a type of `MultiSet` that maintains a sorted order among its unique representative members.
  Fields in org.apache.commons.collections4 declared as MultiSet
  Modifier and Type
  Field
  Description
  `static final MultiSet`
  MultiSetUtils.`EMPTY_MULTISET`
  An empty unmodifiable multiset.
  Methods in org.apache.commons.collections4 that return MultiSet
  Modifier and Type
  Method
  Description
  `static <E> MultiSet<E>`
  MultiSetUtils.`emptyMultiSet()`
  Gets an empty `MultiSet`.
  `static <K, V> MultiSet<V>`
  MultiMapUtils.`getValuesAsMultiSet(MultiValuedMap<K,V> map, K key)`
  Gets a MultiSet from `MultiValuedMap` in a null-safe manner.
  `MultiSet<K>`
  MultiValuedMap.`keys()`
  Returns a `MultiSet` view of the keys contained in this multivalued map.
  `static <E> MultiSet<E>`
  MultiSetUtils.`predicatedMultiSet(MultiSet<E> multiset, Predicate<? super E> predicate)`
  Returns a predicated (validating) multiset backed by the given multiset.
  `static <E> MultiSet<E>`
  MultiSetUtils.`synchronizedMultiSet(MultiSet<E> multiset)`
  Returns a synchronized (thread-safe) multiset backed by the given multiset.
  `static <E> MultiSet<E>`
  MultiSetUtils.`transformingMultiSet(MultiSet<E> multiset, Transformer<? super E,? extends E> transformer)`
  Returns a transformed multiset backed by the given multiset.
  `static <E> MultiSet<E>`
  MultiSetUtils.`unmodifiableMultiSet(MultiSet<? extends E> multiset)`
  Returns an unmodifiable view of the given multiset.
  Methods in org.apache.commons.collections4 with parameters of type MultiSet
  Modifier and Type
  Method
  Description
  `static boolean`
  MultiSetUtils.`containsOccurrences(MultiSet<?> superMultiSet, MultiSet<?> subMultiSet)`
  Returns `true` if `superMultiSet` contains at least as many occurrences of each element as `subMultiSet` does; in other words, whether `subMultiSet` is a sub-multiset of `superMultiSet`.
  `static <E> MultiSet<E>`
  MultiSetUtils.`predicatedMultiSet(MultiSet<E> multiset, Predicate<? super E> predicate)`
  Returns a predicated (validating) multiset backed by the given multiset.
  `static boolean`
  MultiSetUtils.`removeOccurrences(MultiSet<?> multiSetToModify, MultiSet<?> occurrencesToRemove)`
  For each occurrence of an element in `occurrencesToRemove`, removes one occurrence of that element from `multiSetToModify`, if present.
  `static <E> boolean`
  MultiSetUtils.`retainOccurrences(MultiSet<E> multiSetToModify, MultiSet<?> occurrencesToRetain)`
  Modifies `multiSetToModify` so that no element has more occurrences than it has in `occurrencesToRetain`.
  `static <E> MultiSet<E>`
  MultiSetUtils.`synchronizedMultiSet(MultiSet<E> multiset)`
  Returns a synchronized (thread-safe) multiset backed by the given multiset.
  `static <E> MultiSet<E>`
  MultiSetUtils.`transformingMultiSet(MultiSet<E> multiset, Transformer<? super E,? extends E> transformer)`
  Returns a transformed multiset backed by the given multiset.
  `static <E> MultiSet<E>`
  MultiSetUtils.`unmodifiableMultiSet(MultiSet<? extends E> multiset)`
  Returns an unmodifiable view of the given multiset.

- ## Uses of MultiSet in org.apache.commons.collections4.collection

  Methods in org.apache.commons.collections4.collection that return MultiSet
  Modifier and Type
  Method
  Description
  `MultiSet<E>`
  PredicatedCollection.Builder.`createPredicatedMultiSet()`
  Create a new predicated multiset filled with the accepted elements.
  `MultiSet<E>`
  PredicatedCollection.Builder.`createPredicatedMultiSet(MultiSet<E> multiset)`
  Decorates the given multiset with validating behavior using the predicate.
  Methods in org.apache.commons.collections4.collection with parameters of type MultiSet
  Modifier and Type
  Method
  Description
  `MultiSet<E>`
  PredicatedCollection.Builder.`createPredicatedMultiSet(MultiSet<E> multiset)`
  Decorates the given multiset with validating behavior using the predicate.

- ## Uses of MultiSet in org.apache.commons.collections4.multimap

  Methods in org.apache.commons.collections4.multimap that return MultiSet
  Modifier and Type
  Method
  Description
  `MultiSet<K>`
  AbstractMultiValuedMap.`keys()`
  Returns a `MultiSet` view of the key mapping contained in this map.
  `MultiSet<K>`
  AbstractMultiValuedMapDecorator.`keys()`
  `MultiSet<K>`
  UnmodifiableMultiValuedMap.`keys()`

- ## Uses of MultiSet in org.apache.commons.collections4.multiset

  Classes in org.apache.commons.collections4.multiset that implement MultiSet
  Modifier and Type
  Class
  Description
  `class`
  `AbstractMapMultiSet<E>`
  Abstract implementation of the `MultiSet` interface to simplify the creation of subclass implementations.
  `class`
  `AbstractMultiSet<E>`
  Abstract implementation of the `MultiSet` interface to simplify the creation of subclass implementations.
  `class`
  `AbstractMultiSetDecorator<E>`
  Decorates another `MultiSet` to provide additional behavior.
  `class`
  `AbstractSortedMultiSetDecorator<E>`
  Decorates another `SortedMultiSet` to provide additional behavior.
  `class`
  `HashMultiSet<E>`
  Implements `MultiSet`, using a `HashMap` to provide the data storage.
  `class`
  `PredicatedMultiSet<E>`
  Decorates another `MultiSet` to validate that additions match a specified predicate.
  `class`
  `PredicatedSortedMultiSet<E>`
  Decorates another `SortedMultiSet` to validate that additions match a specified predicate.
  `class`
  `SynchronizedMultiSet<E>`
  Decorates another `MultiSet` to synchronize its behavior for a multithreaded environment.
  `class`
  `SynchronizedSortedMultiSet<E>`
  Decorates another `SortedMultiSet` to synchronize its behavior for a multithreaded environment.
  `class`
  `TransformedMultiSet<E>`
  Decorates another `MultiSet` to transform objects that are added.
  `class`
  `TransformedSortedMultiSet<E>`
  Decorates another `SortedMultiSet` to transform objects that are added.
  `class`
  `TreeMultiSet<E>`
  Implements `SortedMultiSet`, using a `TreeMap` to provide the data storage.
  `final class`
  `UnmodifiableMultiSet<E>`
  Decorates another `MultiSet` to ensure it can't be altered.
  `final class`
  `UnmodifiableSortedMultiSet<E>`
  Decorates another `SortedMultiSet` to ensure it can't be altered.
  Methods in org.apache.commons.collections4.multiset that return MultiSet
  Modifier and Type
  Method
  Description
  `protected MultiSet<E>`
  AbstractMultiSetDecorator.`decorated()`
  Gets the multiset being decorated.
  `protected MultiSet<E>`
  PredicatedMultiSet.`decorated()`
  Gets the decorated multiset.
  `protected MultiSet<E>`
  SynchronizedMultiSet.`decorated()`
  Gets the multiset being decorated.
  `protected MultiSet<E>`
  TransformedMultiSet.`getMultiSet()`
  Gets the decorated multiset.
  `static <E> MultiSet<E>`
  UnmodifiableMultiSet.`unmodifiableMultiSet(MultiSet<? extends E> multiset)`
  Factory method to create an unmodifiable multiset.
  Methods in org.apache.commons.collections4.multiset with parameters of type MultiSet
  Modifier and Type
  Method
  Description
  `static <E> PredicatedMultiSet<E>`
  PredicatedMultiSet.`predicatedMultiSet(MultiSet<E> multiset, Predicate<? super E> predicate)`
  Factory method to create a predicated (validating) multiset.
  `static <E> SynchronizedMultiSet<E>`
  SynchronizedMultiSet.`synchronizedMultiSet(MultiSet<E> multiset)`
  Factory method to create a synchronized multiset.
  `static <E> TransformedMultiSet<E>`
  TransformedMultiSet.`transformedMultiSet(MultiSet<E> multiset, Transformer<? super E,? extends E> transformer)`
  Factory method to create a transforming multiset that will transform existing contents of the specified multiset.
  `static <E> TransformedMultiSet<E>`
  TransformedMultiSet.`transformingMultiSet(MultiSet<E> multiset, Transformer<? super E,? extends E> transformer)`
  Factory method to create a transforming multiset.
  `static <E> MultiSet<E>`
  UnmodifiableMultiSet.`unmodifiableMultiSet(MultiSet<? extends E> multiset)`
  Factory method to create an unmodifiable multiset.
  Constructors in org.apache.commons.collections4.multiset with parameters of type MultiSet
  Modifier
  Constructor
  Description
  `protected`
  `AbstractMultiSetDecorator(MultiSet<E> multiset)`
  Constructor that wraps (not copies).
  `protected`
  `PredicatedMultiSet(MultiSet<E> multiset, Predicate<? super E> predicate)`
  Constructor that wraps (not copies).
  `protected`
  `SynchronizedMultiSet(MultiSet<E> multiset)`
  Constructor that wraps (not copies).
  `protected`
  `SynchronizedMultiSet(MultiSet<E> multiset, Object lock)`
  Constructor that wraps (not copies).
  `protected`
  `TransformedMultiSet(MultiSet<E> multiset, Transformer<? super E,? extends E> transformer)`
  Constructor that wraps (not copies).