java.lang.Object
- io.vavr.collection.AbstractMultimap<K,V,M>

Type Parameters:

K - Key type

V - Value type

M - Concrete Multimap type extending this class

All Implemented Interfaces:

Foldable<Tuple2<K,V>>, Multimap<K,V>, Traversable<Tuple2<K,V>>, Function1<K,Traversable<V>>, PartialFunction<K,Traversable<V>>, Value<Tuple2<K,V>>, java.io.Serializable, java.lang.Iterable<Tuple2<K,V>>, java.util.function.Function<K,Traversable<V>>

Direct Known Subclasses:

HashMultimap, LinkedHashMultimap, TreeMultimap
```
abstract class AbstractMultimap<K,V,M extends Multimap<K,V>>
extends java.lang.Object
implements Multimap<K,V>
```
An abstract base implementation of the Multimap interface that provides common functionality for concrete Multimap implementations. This class is not intended to be public and serves as a foundation for specialized Multimap types.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static interface AbstractMultimap.SerializableSupplier<T>
- Nested classes/interfaces inherited from interface io.vavr.collection.Multimap
  Multimap.ContainerType

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<K,Traversable<V>>`	`back`	The backing map that stores the key-value pairs.
`private Multimap.ContainerType`	`containerType`
`protected AbstractMultimap.SerializableSupplier<Traversable<?>>`	`emptyContainer`	A supplier that creates empty containers for new key entries.
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor	Description
`AbstractMultimap(Map<K,Traversable<V>> back, Multimap.ContainerType containerType, AbstractMultimap.SerializableSupplier<Traversable<?>> emptyContainer)`	Creates a new AbstractMultimap with the specified backing map, container type, and empty container supplier.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Map<K,Traversable<V>>`	`asMap()`	Converts this `Multimap` to a `Map`
`<K2,V2> Multimap<K2,V2>`	`bimap(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper, @NonNull java.util.function.Function<? super V,? extends V2> valueMapper)`	Maps this `Multimap` to a new `Multimap` with different component type by applying a function to its elements.
`boolean`	`containsKey(K key)`	Returns `true` if this multimap contains a mapping for the specified key.
`private <K2,V2> Multimap<K2,V2>`	`createFromEntries(java.lang.Iterable<? extends Tuple2<? extends K2,? extends V2>> entries)`	Creates a new Multimap from the given entries by grouping values by their keys.
`protected abstract <K2,V2> Multimap<K2,V2>`	`createFromMap(Map<K2,Traversable<V2>> back)`	Creates a new Multimap instance from the given backing map.
`M`	`distinct()`	Returns a new `Traversable` containing the elements of this instance with all duplicates removed.
`M`	`distinctBy(@NonNull java.util.Comparator<? super Tuple2<K,V>> comparator)`	Returns a new `Traversable` containing the elements of this instance without duplicates, as determined by the given `comparator`.
`<U> M`	`distinctBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)`	Returns a new `Traversable` containing the elements of this instance without duplicates, based on keys extracted from elements using `keyExtractor`.
`M`	`drop(int n)`	Returns a new `Traversable` without the first `n` elements, or an empty instance if this contains fewer than `n` elements.
`M`	`dropRight(int n)`	Returns a new `Traversable` without the last `n` elements, or an empty instance if this contains fewer than `n` elements.
`M`	`dropUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a new `Traversable` starting from the first element that satisfies the given `predicate`, dropping all preceding elements.
`M`	`dropWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a new `Traversable` starting from the first element that does not satisfy the given `predicate`, dropping all preceding elements.
`protected abstract <K2,V2> Multimap<K2,V2>`	`emptyInstance()`	Returns an empty Multimap instance specific to the implementing class.
`protected abstract <K2,V2> Map<K2,V2>`	`emptyMapSupplier()`	Returns an empty Map instance specific to the implementing class.
`boolean`	`equals(java.lang.Object o)`	Determines whether this collection is equal to the given object.
`M`	`filter(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)`	Returns a new Multimap consisting of all elements which satisfy the given predicate.
`M`	`filter(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a new traversable containing only the elements that satisfy the given predicate.
`M`	`filterKeys(@NonNull java.util.function.Predicate<? super K> predicate)`	Returns a new Multimap consisting of all elements with keys which satisfy the given predicate.
`M`	`filterValues(@NonNull java.util.function.Predicate<? super V> predicate)`	Returns a new Multimap consisting of all elements with values which satisfy the given predicate.
`<K2,V2> Multimap<K2,V2>`	`flatMap(@NonNull java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)`	FlatMaps this `Multimap` to a new `Multimap` with different component type.
`Option<Traversable<V>>`	`get(K key)`	Returns the `Some` of value to which the specified key is mapped, or `None` if this multimap contains no mapping for the key.
`Multimap.ContainerType`	`getContainerType()`	Returns the type of the `Traversable` value container of this `MultiMap`.
`Traversable<V>`	`getOrElse(K key, Traversable<? extends V> defaultValue)`	Returns the value associated with a key, or a default value if the key is not contained in the map
`<C> Map<C,M>`	`groupBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)`	Groups elements of this `Traversable` based on a classifier function.
`Iterator<M>`	`grouped(int size)`	Splits this `Traversable` into consecutive blocks of the given size.
`int`	`hashCode()`	Returns the hash code of this collection.
`Tuple2<K,V>`	`head()`	Returns the first element of this non-empty `Traversable`.
`M`	`init()`	Returns all elements of this Traversable except the last one.
`Option<M>`	`initOption()`	Returns all elements of this Traversable except the last one, wrapped in an `Option`.
`boolean`	`isAsync()`	Checks if this `Value` is asynchronously (short: async) computed.
`boolean`	`isEmpty()`	Checks if this Traversable contains no elements.
`boolean`	`isLazy()`	Checks if this `Value` is lazily evaluated.
`@NonNull Iterator<Tuple2<K,V>>`	`iterator()`	Returns an iterator over the elements of this Traversable, implemented via `Traversable.head()` and `Traversable.tail()`.
`Set<K>`	`keySet()`	Returns the keys contained in this multimap.
`Tuple2<K,V>`	`last()`	Returns the last element of this Traversable.
`<K2,V2> Multimap<K2,V2>`	`map(@NonNull java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)`	Maps the entries of this `Multimap` to form a new `Multimap`.
`<V2> Multimap<K,V2>`	`mapValues(@NonNull java.util.function.Function<? super V,? extends V2> valueMapper)`	Maps the values of this `Multimap` while preserving the corresponding keys.
`M`	`merge(@NonNull Multimap<? extends K,? extends V> that)`	Creates a new multimap which by merging the entries of `this` multimap and `that` multimap.
`<K2 extends K,V2 extends V> M`	`merge(@NonNull Multimap<K2,V2> that, @NonNull java.util.function.BiFunction<Traversable<V>,Traversable<V2>,Traversable<V>> collisionResolution)`	Creates a new multimap which by merging the entries of `this` multimap and `that` multimap.
`M`	`orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)`	Returns this `Multimap` if it is nonempty, otherwise `Multimap` created from result of evaluating supplier, using existing multimap properties.
`M`	`orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)`	Returns this `Multimap` if it is nonempty, otherwise `Multimap` created from iterable, using existing multimap properties.
`Tuple2<M,M>`	`partition(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Splits this `Traversable` into two partitions according to a predicate.
`M`	`peek(@NonNull java.util.function.Consumer<? super Tuple2<K,V>> action)`	Performs the given `action` on the first element if this is an eager implementation.
`M`	`put(@NonNull Tuple2<? extends K,? extends V> entry)`	Convenience method for `put(entry._1, entry._2)`.
`M`	`put(K key, V value)`	Associates the specified value with the specified key in this multimap.
`M`	`reject(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)`	Returns a new Multimap consisting of all elements which do not satisfy the given predicate.
`M`	`reject(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a new traversable containing only the elements that do not satisfy the given predicate.
`M`	`rejectKeys(@NonNull java.util.function.Predicate<? super K> predicate)`	Returns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.
`M`	`rejectValues(@NonNull java.util.function.Predicate<? super V> predicate)`	Returns a new Multimap consisting of all elements with values which do not satisfy the given predicate.
`M`	`remove(K key)`	Removes the mapping for a key from this multimap if it is present.
`M`	`remove(K key, V value)`	Removes the key-value pair from this multimap if it is present.
`M`	`removeAll(@NonNull java.lang.Iterable<? extends K> keys)`	Removes the mapping for a key from this multimap if it is present.
`M`	`removeAll(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)`	Deprecated.
`M`	`removeKeys(@NonNull java.util.function.Predicate<? super K> predicate)`	Deprecated.
`M`	`removeValues(@NonNull java.util.function.Predicate<? super V> predicate)`	Deprecated.
`M`	`replace(@NonNull Tuple2<K,V> currentElement, Tuple2<K,V> newElement)`	Replaces the first occurrence of `currentElement` with `newElement`, if it exists.
`M`	`replace(K key, V oldValue, V newValue)`	Replaces the entry with the specified key and oldValue.
`M`	`replaceAll(@NonNull Tuple2<K,V> currentElement, Tuple2<K,V> newElement)`	Replaces all occurrences of `currentElement` with `newElement`.
`M`	`replaceAll(@NonNull java.util.function.BiFunction<? super K,? super V,? extends V> function)`	Replaces each entry's values with the result of invoking the given function on that each tuple until all entries have been processed or the function throws an exception.
`M`	`replaceValue(K key, V value)`	Replaces the entry for the specified key only if it is currently mapped to some value.
`M`	`retainAll(@NonNull java.lang.Iterable<? extends Tuple2<K,V>> elements)`	Retains only the elements from this Traversable that are contained in the given `elements`.
`M`	`scan(Tuple2<K,V> zero, @NonNull java.util.function.BiFunction<? super Tuple2<K,V>,? super Tuple2<K,V>,? extends Tuple2<K,V>> operation)`	Computes a prefix scan of the elements of this Traversable.
`int`	`size()`	Returns the number of elements in this Traversable.
`Iterator<M>`	`slideBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,?> classifier)`	Partitions this `Traversable` into consecutive non-overlapping windows according to a classification function.
`Iterator<M>`	`sliding(int size)`	Slides a window of a given `size` over this `Traversable` with a step size of 1.
`Iterator<M>`	`sliding(int size, int step)`	Slides a window of a specific `size` with a given `step` over this `Traversable`.
`Tuple2<M,M>`	`span(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Splits this `Traversable` into a prefix and remainder according to the given `predicate`.
`java.lang.String`	`stringPrefix()`	Returns the name of this Value type, which is used by toString().
`M`	`tail()`	Returns a new `Traversable` without its first element.
`Option<M>`	`tailOption()`	Returns a new `Traversable` without its first element as an `Option`.
`M`	`take(int n)`	Returns the first `n` elements of this `Traversable`, or all elements if `n` exceeds the length.
`M`	`takeRight(int n)`	Returns the last `n` elements of this `Traversable`, or all elements if `n` exceeds the length.
`M`	`takeUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Takes elements from this `Traversable` until the given predicate holds for an element.
`M`	`takeWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Takes elements from this `Traversable` while the given predicate holds.
`java.util.Map<K,java.util.Collection<V>>`	`toJavaMap()`	Converts this Vavr `Map` to a `java.util.Map` while preserving characteristics like insertion order (`LinkedHashMultimap`) and sort order (`SortedMultimap`).
`protected <JM extends java.util.Map<K,java.util.Collection<V>>> JM`	`toJavaMap(JM javaMap)`	Converts this `Multimap` to a Java `Map` using the provided map instance.
`java.lang.String`	`toString()`	Clarifies that values have a proper toString() method implemented.
`Traversable<V>`	`values()`	Returns a `Traversable` containing all the values of this `Multimap`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vavr.collection.Foldable
fold, reduce, reduceOption

Methods inherited from interface io.vavr.Function1
andThen, arity, compose, compose1, curried, isMemoized, memoized, partial, reversed, tupled

Methods inherited from interface io.vavr.collection.Multimap
apply, asPartialFunction, collect, contains, containsValue, flatMap, foldRight, forEach, hasDefiniteSize, isDefinedAt, isDistinct, isTraversableAgain, iterator, length, map, mapTo, mapToVoid, scanLeft, scanRight, transform, unzip, unzip, unzip3, unzip3, zip, zipAll, zipWith, zipWithIndex, zipWithIndex

Methods inherited from interface io.vavr.PartialFunction
lift

Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, headOption, isOrdered, isSequential, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, single, singleOption, spliterator, sum

Methods inherited from interface io.vavr.Value
collect, collect, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, out, out, stderr, stdout, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - back
```
protected final Map<K,Traversable<V>> back
```
    The backing map that stores the key-value pairs.
  - emptyContainer
```
protected final AbstractMultimap.SerializableSupplier<Traversable<?>> emptyContainer
```
    A supplier that creates empty containers for new key entries.
  - containerType
```
private final Multimap.ContainerType containerType
```
- Constructor Detail
  - AbstractMultimap
```
AbstractMultimap(Map<K,Traversable<V>> back,
                 Multimap.ContainerType containerType,
                 AbstractMultimap.SerializableSupplier<Traversable<?>> emptyContainer)
```
    Creates a new AbstractMultimap with the specified backing map, container type, and empty container supplier.
    
    Parameters:
    
    back - The backing map that stores the key-value pairs
    
    containerType - The type of container used to store multiple values for a key
    
    emptyContainer - A supplier that creates empty containers for new key entries
- Method Detail
  - emptyMapSupplier
```
protected abstract <K2,V2> Map<K2,V2> emptyMapSupplier()
```
    Returns an empty Map instance specific to the implementing class.
    
    Type Parameters:
    
    K2 - Key type of the empty map
    
    V2 - Value type of the empty map
    
    Returns:
    
    An empty Map instance
  - emptyInstance
```
protected abstract <K2,V2> Multimap<K2,V2> emptyInstance()
```
    Returns an empty Multimap instance specific to the implementing class.
    
    Type Parameters:
    
    K2 - Key type of the empty multimap
    
    V2 - Value type of the empty multimap
    
    Returns:
    
    An empty Multimap instance
  - createFromMap
```
protected abstract <K2,V2> Multimap<K2,V2> createFromMap(Map<K2,Traversable<V2>> back)
```
    Creates a new Multimap instance from the given backing map.
    
    Type Parameters:
    
    K2 - Key type of the new multimap
    
    V2 - Value type of the new multimap
    
    Parameters:
    
    back - The backing map to create the multimap from
    
    Returns:
    
    A new Multimap instance containing the entries from the backing map
  - createFromEntries
```
private <K2,V2> Multimap<K2,V2> createFromEntries(java.lang.Iterable<? extends Tuple2<? extends K2,? extends V2>> entries)
```
    Creates a new Multimap from the given entries by grouping values by their keys. For each key, a new container is created using the emptyContainer supplier, and values are added using the containerType's add operation.
    
    Type Parameters:
    
    K2 - Key type of the new multimap
    
    V2 - Value type of the new multimap
    
    Parameters:
    
    entries - The entries to create the multimap from
    
    Returns:
    
    A new Multimap containing all the entries with values grouped by keys
  - asMap
```
public Map<K,Traversable<V>> asMap()
```
    Description copied from interface: Multimap
    
    Converts this Multimap to a Map
    
    Specified by:
    
    asMap in interface Multimap<K,V>
    
    Returns:
    
    Map<K, Traversable<V>>
  - bimap
```
public <K2,V2> Multimap<K2,V2> bimap(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper,
                                                 @NonNull java.util.function.Function<? super V,? extends V2> valueMapper)
```
    Description copied from interface: Multimap
    
    Maps this Multimap to a new Multimap with different component type by applying a function to its elements.
    
    Specified by:
    
    bimap in interface Multimap<K,V>
    
    Type Parameters:
    
    K2 - key's component type of the multimap result
    
    V2 - value's component type of the multimap result
    
    Parameters:
    
    keyMapper - a Function that maps the keys of type K to keys of type K2
    
    valueMapper - a Function that the values of type V to values of type V2
    
    Returns:
    
    a new Multimap
  - containsKey
```
public boolean containsKey(K key)
```
    Description copied from interface: Multimap
    
    Returns true if this multimap contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface Multimap<K,V>
    
    Parameters:
    
    key - key whose presence in this multimap is to be tested
    
    Returns:
    
    true if this multimap contains a mapping for the specified key
  - getContainerType
```
public Multimap.ContainerType getContainerType()
```
    Description copied from interface: Multimap
    
    Returns the type of the Traversable value container of this MultiMap.
    
    Specified by:
    
    getContainerType in interface Multimap<K,V>
    
    Returns:
    
    an enum value representing the container type
  - flatMap
```
public <K2,V2> Multimap<K2,V2> flatMap(@NonNull java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
```
    Description copied from interface: Multimap
    
    FlatMaps this Multimap to a new Multimap with different component type.
    
    Specified by:
    
    flatMap in interface Multimap<K,V>
    
    Type Parameters:
    
    K2 - key's component type of the mapped Multimap
    
    V2 - value's component type of the mapped Multimap
    
    Parameters:
    
    mapper - A mapper
    
    Returns:
    
    A new Multimap.
  - get
```
public Option<Traversable<V>> get(K key)
```
    Description copied from interface: Multimap
    
    Returns the Some of value to which the specified key is mapped, or None if this multimap contains no mapping for the key.
    
    Specified by:
    
    get in interface Multimap<K,V>
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the Some of value to which the specified key is mapped, or None if this multimap contains no mapping for the key
  - getOrElse
```
public Traversable<V> getOrElse(K key,
                                Traversable<? extends V> defaultValue)
```
    Description copied from interface: Multimap
    
    Returns the value associated with a key, or a default value if the key is not contained in the map
    
    Specified by:
    
    getOrElse in interface Multimap<K,V>
    
    Parameters:
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value associated with key if it exists, otherwise the result of the default value
  - keySet
```
public Set<K> keySet()
```
    Description copied from interface: Multimap
    
    Returns the keys contained in this multimap.
    
    Specified by:
    
    keySet in interface Multimap<K,V>
    
    Returns:
    
    Set of the keys contained in this multimap.
  - map
```
public <K2,V2> Multimap<K2,V2> map(@NonNull java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
```
    Description copied from interface: Multimap
    
    Maps the entries of this Multimap to form a new Multimap.
    
    Specified by:
    
    map in interface Multimap<K,V>
    
    Type Parameters:
    
    K2 - key's component type of the multimap result
    
    V2 - value's component type of the multimap result
    
    Parameters:
    
    mapper - a Function that maps entries of type (K, V) to entries of type (K2, V2)
    
    Returns:
    
    a new Multimap
  - mapValues
```
public <V2> Multimap<K,V2> mapValues(@NonNull java.util.function.Function<? super V,? extends V2> valueMapper)
```
    Description copied from interface: Multimap
    
    Maps the values of this Multimap while preserving the corresponding keys.
    
    Specified by:
    
    mapValues in interface Multimap<K,V>
    
    Type Parameters:
    
    V2 - the new value type
    
    Parameters:
    
    valueMapper - a Function that maps values of type V to values of type V2
    
    Returns:
    
    a new Multimap
  - put
```
public M put(K key,
             V value)
```
    Description copied from interface: Multimap
    
    Associates the specified value with the specified key in this multimap. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
    
    Specified by:
    
    put in interface Multimap<K,V>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    A new Multimap containing these elements and that entry.
  - put
```
public M put(@NonNull Tuple2<? extends K,? extends V> entry)
```
    Description copied from interface: Multimap
    
    Convenience method for put(entry._1, entry._2).
    
    Specified by:
    
    put in interface Multimap<K,V>
    
    Parameters:
    
    entry - A Tuple2 containing the key and value
    
    Returns:
    
    A new Multimap containing these elements and that entry.
  - remove
```
public M remove(K key)
```
    Description copied from interface: Multimap
    
    Removes the mapping for a key from this multimap if it is present.
    
    Specified by:
    
    remove in interface Multimap<K,V>
    
    Parameters:
    
    key - key whose mapping is to be removed from the multimap
    
    Returns:
    
    A new Multimap containing these elements without the entry specified by that key.
  - remove
```
public M remove(K key,
                V value)
```
    Description copied from interface: Multimap
    
    Removes the key-value pair from this multimap if it is present.
    
    Specified by:
    
    remove in interface Multimap<K,V>
    
    Parameters:
    
    key - key whose mapping is to be removed from the multimap
    
    value - value whose mapping is to be removed from the multimap
    
    Returns:
    
    A new Multimap containing these elements without the entry specified by that key and value.
  - removeAll
```
public M removeAll(@NonNull java.lang.Iterable<? extends K> keys)
```
    Description copied from interface: Multimap
    
    Removes the mapping for a key from this multimap if it is present.
    
    Specified by:
    
    removeAll in interface Multimap<K,V>
    
    Parameters:
    
    keys - keys are to be removed from the multimap
    
    Returns:
    
    A new Multimap containing these elements without the entries specified by that keys.
  - size
```
public int size()
```
    Description copied from interface: Traversable
    
    Returns the number of elements in this Traversable.
    Alias for Traversable.length().
    
    Specified by:
    
    size in interface Multimap<K,V>
    
    Specified by:
    
    size in interface Traversable<K>
    
    Returns:
    
    the number of elements
  - values
```
public Traversable<V> values()
```
    Description copied from interface: Multimap
    
    Returns a Traversable containing all the values of this Multimap.
    
    Specified by:
    
    values in interface Multimap<K,V>
    
    Returns:
    
    a new Traversable
  - distinct
```
public M distinct()
```
    Description copied from interface: Traversable
    
    Returns a new Traversable containing the elements of this instance with all duplicates removed. Element equality is determined using equals.
    
    Specified by:
    
    distinct in interface Multimap<K,V>
    
    Specified by:
    
    distinct in interface Traversable<K>
    
    Returns:
    
    a new Traversable without duplicate elements
  - distinctBy
```
public M distinctBy(@NonNull java.util.Comparator<? super Tuple2<K,V>> comparator)
```
    Description copied from interface: Traversable
    
    Returns a new Traversable containing the elements of this instance without duplicates, as determined by the given comparator.
    
    Specified by:
    
    distinctBy in interface Multimap<K,V>
    
    Specified by:
    
    distinctBy in interface Traversable<K>
    
    Parameters:
    
    comparator - a comparator used to determine equality of elements
    
    Returns:
    
    a new Traversable with duplicates removed
  - distinctBy
```
public <U> M distinctBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
```
    Description copied from interface: Traversable
    
    Returns a new Traversable containing the elements of this instance without duplicates, based on keys extracted from elements using keyExtractor.
    The first occurrence of each key is retained in the resulting sequence.
    
    Specified by:
    
    distinctBy in interface Multimap<K,V>
    
    Specified by:
    
    distinctBy in interface Traversable<K>
    
    Type Parameters:
    
    U - the type of key
    
    Parameters:
    
    keyExtractor - a function to extract keys for determining uniqueness
    
    Returns:
    
    a new Traversable with duplicates removed based on keys
  - drop
```
public M drop(int n)
```
    Description copied from interface: Traversable
    
    Returns a new Traversable without the first n elements, or an empty instance if this contains fewer than n elements.
    
    Specified by:
    
    drop in interface Multimap<K,V>
    
    Specified by:
    
    drop in interface Traversable<K>
    
    Parameters:
    
    n - the number of elements to drop
    
    Returns:
    
    a new instance excluding the first n elements
  - dropRight
```
public M dropRight(int n)
```
    Description copied from interface: Traversable
    
    Returns a new Traversable without the last n elements, or an empty instance if this contains fewer than n elements.
    
    Specified by:
    
    dropRight in interface Multimap<K,V>
    
    Specified by:
    
    dropRight in interface Traversable<K>
    
    Parameters:
    
    n - the number of elements to drop from the end
    
    Returns:
    
    a new instance excluding the last n elements
  - dropUntil
```
public M dropUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Returns a new Traversable starting from the first element that satisfies the given predicate, dropping all preceding elements.
    
    Specified by:
    
    dropUntil in interface Multimap<K,V>
    
    Specified by:
    
    dropUntil in interface Traversable<K>
    
    Parameters:
    
    predicate - a condition tested on each element
    
    Returns:
    
    a new instance starting from the first element matching the predicate
  - dropWhile
```
public M dropWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Returns a new Traversable starting from the first element that does not satisfy the given predicate, dropping all preceding elements.
    This is equivalent to dropUntil(predicate.negate()), which is useful for method references that cannot be negated directly.
    
    Specified by:
    
    dropWhile in interface Multimap<K,V>
    
    Specified by:
    
    dropWhile in interface Traversable<K>
    
    Parameters:
    
    predicate - a condition tested on each element
    
    Returns:
    
    a new instance starting from the first element not matching the predicate
  - filter
```
public M filter(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Returns a new traversable containing only the elements that satisfy the given predicate.
    
    Specified by:
    
    filter in interface Multimap<K,V>
    
    Specified by:
    
    filter in interface Traversable<K>
    
    Parameters:
    
    predicate - the condition to test elements
    
    Returns:
    
    a traversable with elements matching the predicate
  - reject
```
public M reject(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Returns a new traversable containing only the elements that do not satisfy the given predicate.
    This is equivalent to filter(predicate.negate()).
    
    Specified by:
    
    reject in interface Multimap<K,V>
    
    Specified by:
    
    reject in interface Traversable<K>
    
    Parameters:
    
    predicate - the condition to test elements
    
    Returns:
    
    a traversable with elements not matching the predicate
  - filter
```
public M filter(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)
```
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements which satisfy the given predicate.
    
    Specified by:
    
    filter in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test elements
    
    Returns:
    
    a new Multimap
  - reject
```
public M reject(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)
```
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements which do not satisfy the given predicate.
    
    Specified by:
    
    reject in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test elements
    
    Returns:
    
    a new Multimap
  - filterKeys
```
public M filterKeys(@NonNull java.util.function.Predicate<? super K> predicate)
```
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements with keys which satisfy the given predicate.
    
    Specified by:
    
    filterKeys in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test keys of elements
    
    Returns:
    
    a new Multimap
  - rejectKeys
```
public M rejectKeys(@NonNull java.util.function.Predicate<? super K> predicate)
```
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.
    
    Specified by:
    
    rejectKeys in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test keys of elements
    
    Returns:
    
    a new Multimap
  - filterValues
```
public M filterValues(@NonNull java.util.function.Predicate<? super V> predicate)
```
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements with values which satisfy the given predicate.
    
    Specified by:
    
    filterValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test values of elements
    
    Returns:
    
    a new Multimap
  - rejectValues
```
public M rejectValues(@NonNull java.util.function.Predicate<? super V> predicate)
```
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements with values which do not satisfy the given predicate.
    
    Specified by:
    
    rejectValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test values of elements
    
    Returns:
    
    a new Multimap
  - removeAll
```
@Deprecated
public M removeAll(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)
```
    Deprecated.
    
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements which do not satisfy the given predicate.
    
    Specified by:
    
    removeAll in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test elements
    
    Returns:
    
    a new Multimap
  - removeKeys
```
@Deprecated
public M removeKeys(@NonNull java.util.function.Predicate<? super K> predicate)
```
    Deprecated.
    
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.
    
    Specified by:
    
    removeKeys in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test keys of elements
    
    Returns:
    
    a new Multimap
  - removeValues
```
@Deprecated
public M removeValues(@NonNull java.util.function.Predicate<? super V> predicate)
```
    Deprecated.
    
    Description copied from interface: Multimap
    
    Returns a new Multimap consisting of all elements with values which do not satisfy the given predicate.
    
    Specified by:
    
    removeValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test values of elements
    
    Returns:
    
    a new Multimap
  - groupBy
```
public <C> Map<C,M> groupBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)
```
    Description copied from interface: Traversable
    
    Groups elements of this Traversable based on a classifier function.
    
    Specified by:
    
    groupBy in interface Multimap<K,V>
    
    Specified by:
    
    groupBy in interface Traversable<K>
    
    Type Parameters:
    
    C - The type of the group keys
    
    Parameters:
    
    classifier - A function that assigns each element to a group
    
    Returns:
    
    A map where each key corresponds to a group of elements
    
    See Also:
    
    Traversable.arrangeBy(Function)
  - grouped
```
public Iterator<M> grouped(int size)
```
    Description copied from interface: Traversable
    Splits this Traversable into consecutive blocks of the given size.
    Let length be the number of elements in this Traversable:
    
    If empty, the resulting Iterator is empty.
    
    If size <= length, the resulting Iterator contains length / size blocks of size size and possibly a final smaller block of size length % size.
    
    If size > length, the resulting Iterator contains a single block of size length.
    
    Examples:
    
    [].grouped(1) = [] [].grouped(0) throws [].grouped(-1) throws [1,2,3,4].grouped(2) = [[1,2],[3,4]] [1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]] [1,2,3,4].grouped(5) = [[1,2,3,4]]
    
    Note: grouped(size) is equivalent to sliding(size, size).
    Specified by:
    
    grouped in interface Multimap<K,V>
    
    Specified by:
    
    grouped in interface Traversable<K>
    
    Parameters:
    
    size - the block size; must be positive
    
    Returns:
    
    an Iterator over blocks of elements
  - init
```
public M init()
```
    Description copied from interface: Traversable
    
    Returns all elements of this Traversable except the last one.
    This is the dual of Traversable.tail().
    
    Specified by:
    
    init in interface Multimap<K,V>
    
    Specified by:
    
    init in interface Traversable<K>
    
    Returns:
    
    a new instance containing all elements except the last
  - head
```
public Tuple2<K,V> head()
```
    Description copied from interface: Traversable
    
    Returns the first element of this non-empty Traversable.
    
    Specified by:
    
    head in interface Traversable<K>
    
    Returns:
    
    the first element
  - initOption
```
public Option<M> initOption()
```
    Description copied from interface: Traversable
    
    Returns all elements of this Traversable except the last one, wrapped in an Option.
    This is the dual of Traversable.tailOption().
    
    Specified by:
    
    initOption in interface Multimap<K,V>
    
    Specified by:
    
    initOption in interface Traversable<K>
    
    Returns:
    
    Some(traversable) if non-empty, or None if this Traversable is empty
  - isAsync
```
public boolean isAsync()
```
    Description copied from interface: Value
    
    Checks if this Value is asynchronously (short: async) computed.
    Methods of a Value instance that operate on the underlying value may block the current thread until the value is present and the computation can be performed.
    
    Specified by:
    
    isAsync in interface Value<K>
    
    Returns:
    
    true if this Value is async (like Future), false otherwise.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Traversable
    
    Checks if this Traversable contains no elements.
    
    Specified by:
    
    isEmpty in interface Traversable<K>
    
    Specified by:
    
    isEmpty in interface Value<K>
    
    Returns:
    
    true if empty, false otherwise
  - isLazy
```
public boolean isLazy()
```
    Description copied from interface: Value
    
    Checks if this Value is lazily evaluated.
    
    Specified by:
    
    isLazy in interface Value<K>
    
    Returns:
    
    true if this Value is lazy (like Lazy and Stream), false otherwise.
  - iterator
```
public @NonNull Iterator<Tuple2<K,V>> iterator()
```
    Description copied from interface: Traversable
    
    Returns an iterator over the elements of this Traversable, implemented via Traversable.head() and Traversable.tail(). Subclasses may override for a more efficient implementation.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<K>
    
    Specified by:
    
    iterator in interface Multimap<K,V>
    
    Specified by:
    
    iterator in interface Traversable<K>
    
    Specified by:
    
    iterator in interface Value<K>
    
    Returns:
    
    a new Iterator over the elements of this Traversable
  - last
```
public Tuple2<K,V> last()
```
    Description copied from interface: Traversable
    
    Returns the last element of this Traversable.
    
    Specified by:
    
    last in interface Traversable<K>
    
    Returns:
    
    the last element
  - merge
```
public M merge(@NonNull Multimap<? extends K,? extends V> that)
```
    Description copied from interface: Multimap
    
    Creates a new multimap which by merging the entries of this multimap and that multimap.
    If collisions occur, the value of this multimap is taken.
    
    Specified by:
    
    merge in interface Multimap<K,V>
    
    Parameters:
    
    that - the other multimap
    
    Returns:
    
    A merged multimap
  - merge
```
public <K2 extends K,V2 extends V> M merge(@NonNull Multimap<K2,V2> that,
                                                 @NonNull java.util.function.BiFunction<Traversable<V>,Traversable<V2>,Traversable<V>> collisionResolution)
```
    Description copied from interface: Multimap
    
    Creates a new multimap which by merging the entries of this multimap and that multimap.
    Uses the specified collision resolution function if two keys are the same. The collision resolution function will always take the first argument from this multimap and the second from that multimap.
    
    Specified by:
    
    merge in interface Multimap<K,V>
    
    Type Parameters:
    
    K2 - key type of that Multimap
    
    V2 - value type of that Multimap
    
    Parameters:
    
    that - the other multimap
    
    collisionResolution - the collision resolution function
    
    Returns:
    
    A merged multimap
  - orElse
```
public M orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
```
    Returns this Multimap if it is nonempty, otherwise Multimap created from iterable, using existing multimap properties.
    
    Specified by:
    
    orElse in interface Multimap<K,V>
    
    Specified by:
    
    orElse in interface Traversable<K>
    
    Parameters:
    
    other - An alternative Traversable
    
    Returns:
    
    this Multimap if it is nonempty, otherwise Multimap created from iterable, using existing multimap properties.
  - orElse
```
public M orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
```
    Returns this Multimap if it is nonempty, otherwise Multimap created from result of evaluating supplier, using existing multimap properties.
    
    Specified by:
    
    orElse in interface Multimap<K,V>
    
    Specified by:
    
    orElse in interface Traversable<K>
    
    Parameters:
    
    supplier - An alternative Traversable
    
    Returns:
    
    this Multimap if it is nonempty, otherwise Multimap created from result of evaluating supplier, using existing multimap properties.
  - partition
```
public Tuple2<M,M> partition(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Splits this Traversable into two partitions according to a predicate.
    The first partition contains all elements that satisfy the predicate, and the second contains all elements that do not. The original iteration order is preserved.
    
    Specified by:
    
    partition in interface Multimap<K,V>
    
    Specified by:
    
    partition in interface Traversable<K>
    
    Parameters:
    
    predicate - a predicate used to classify elements
    
    Returns:
    
    a Tuple2 containing the two resulting Traversable instances
  - peek
```
public M peek(@NonNull java.util.function.Consumer<? super Tuple2<K,V>> action)
```
    Description copied from interface: Value
    
    Performs the given action on the first element if this is an eager implementation. Performs the given action on all elements (the first immediately, successive deferred), if this is a lazy implementation.
    
    Specified by:
    
    peek in interface Multimap<K,V>
    
    Specified by:
    
    peek in interface Traversable<K>
    
    Specified by:
    
    peek in interface Value<K>
    
    Parameters:
    
    action - The action that will be performed on the element(s).
    
    Returns:
    
    this instance
  - replace
```
public M replace(@NonNull Tuple2<K,V> currentElement,
                 Tuple2<K,V> newElement)
```
    Description copied from interface: Traversable
    
    Replaces the first occurrence of currentElement with newElement, if it exists.
    
    Specified by:
    
    replace in interface Multimap<K,V>
    
    Specified by:
    
    replace in interface Traversable<K>
    
    Parameters:
    
    currentElement - the element to be replaced
    
    newElement - the replacement element
    
    Returns:
    
    a new Traversable with the first occurrence of currentElement replaced by newElement
  - replaceAll
```
public M replaceAll(@NonNull Tuple2<K,V> currentElement,
                    Tuple2<K,V> newElement)
```
    Description copied from interface: Traversable
    
    Replaces all occurrences of currentElement with newElement.
    
    Specified by:
    
    replaceAll in interface Multimap<K,V>
    
    Specified by:
    
    replaceAll in interface Traversable<K>
    
    Parameters:
    
    currentElement - the element to be replaced
    
    newElement - the replacement element
    
    Returns:
    
    a new Traversable with all occurrences of currentElement replaced by newElement
  - replaceValue
```
public M replaceValue(K key,
                      V value)
```
    Description copied from interface: Multimap
    
    Replaces the entry for the specified key only if it is currently mapped to some value.
    
    Specified by:
    
    replaceValue in interface Multimap<K,V>
    
    Parameters:
    
    key - the key of the element to be substituted
    
    value - the new value to be associated with the key
    
    Returns:
    
    a new map containing key mapped to value if key was contained before. The old map otherwise
  - replace
```
public M replace(K key,
                 V oldValue,
                 V newValue)
```
    Description copied from interface: Multimap
    
    Replaces the entry with the specified key and oldValue.
    
    Specified by:
    
    replace in interface Multimap<K,V>
    
    Parameters:
    
    key - the key of the element to be substituted
    
    oldValue - the expected current value associated with the key
    
    newValue - the new value to be associated with the key
    
    Returns:
    
    a new map containing key mapped to newValue if key was contained before and oldValue was associated with the key. The old map otherwise.
  - replaceAll
```
public M replaceAll(@NonNull java.util.function.BiFunction<? super K,? super V,? extends V> function)
```
    Description copied from interface: Multimap
    
    Replaces each entry's values with the result of invoking the given function on that each tuple until all entries have been processed or the function throws an exception.
    
    Specified by:
    
    replaceAll in interface Multimap<K,V>
    
    Parameters:
    
    function - function transforming key and current value to a new value
    
    Returns:
    
    a new map with the same keySet but transformed values
  - retainAll
```
public M retainAll(@NonNull java.lang.Iterable<? extends Tuple2<K,V>> elements)
```
    Description copied from interface: Traversable
    
    Retains only the elements from this Traversable that are contained in the given elements.
    
    Specified by:
    
    retainAll in interface Multimap<K,V>
    
    Specified by:
    
    retainAll in interface Traversable<K>
    
    Parameters:
    
    elements - the elements to keep
    
    Returns:
    
    a new Traversable containing only the elements present in elements, in their original order
  - scan
```
public M scan(Tuple2<K,V> zero,
              @NonNull java.util.function.BiFunction<? super Tuple2<K,V>,? super Tuple2<K,V>,? extends Tuple2<K,V>> operation)
```
    Description copied from interface: Traversable
    
    Computes a prefix scan of the elements of this Traversable.
    The neutral element zero may be applied more than once.
    
    Specified by:
    
    scan in interface Multimap<K,V>
    
    Specified by:
    
    scan in interface Traversable<K>
    
    Parameters:
    
    zero - the neutral element for the operator
    
    operation - an associative binary operator
    
    Returns:
    
    a new Traversable containing the prefix scan of the elements
  - slideBy
```
public Iterator<M> slideBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,?> classifier)
```
    Description copied from interface: Traversable
    Partitions this Traversable into consecutive non-overlapping windows according to a classification function.
    Each window contains elements with the same class, as determined by classifier. Two consecutive elements belong to the same window only if classifier returns equal values for both. Otherwise, the current window ends and a new window begins with the next element.
    Examples:
    [].slideBy(Function.identity()) = [] [1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]] [1,2,3,10,12,5,7,20,29].slideBy(x -> x / 10) = [[1,2,3],[10,12],[5,7],[20,29]]
    Specified by:
    
    slideBy in interface Multimap<K,V>
    
    Specified by:
    
    slideBy in interface Traversable<K>
    
    Parameters:
    
    classifier - A function classifying elements into groups
    
    Returns:
    
    An Iterator of windows (grouped elements)
  - sliding
```
public Iterator<M> sliding(int size)
```
    Description copied from interface: Traversable
    
    Slides a window of a given size over this Traversable with a step size of 1.
    This is equivalent to calling Traversable.sliding(int, int) with a step size of 1.
    
    Specified by:
    
    sliding in interface Multimap<K,V>
    
    Specified by:
    
    sliding in interface Traversable<K>
    
    Parameters:
    
    size - a positive window size
    
    Returns:
    
    An Iterator of windows, each containing up to size elements
  - sliding
```
public Iterator<M> sliding(int size,
                           int step)
```
    Description copied from interface: Traversable
    Slides a window of a specific size with a given step over this Traversable.
    Examples:
    [].sliding(1, 1) = [] [1,2,3,4,5].sliding(2, 3) = [[1,2],[4,5]] [1,2,3,4,5].sliding(2, 4) = [[1,2],[5]] [1,2,3,4,5].sliding(2, 5) = [[1,2]] [1,2,3,4].sliding(5, 3) = [[1,2,3,4],[4]]
    Specified by:
    
    sliding in interface Multimap<K,V>
    
    Specified by:
    
    sliding in interface Traversable<K>
    
    Parameters:
    
    size - a positive window size
    
    step - a positive step size
    
    Returns:
    
    an Iterator of windows with the given size and step
  - span
```
public Tuple2<M,M> span(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Splits this Traversable into a prefix and remainder according to the given predicate.
    The first element of the returned Tuple is the longest prefix of elements satisfying predicate, and the second element is the remaining elements.
    
    Specified by:
    
    span in interface Multimap<K,V>
    
    Specified by:
    
    span in interface Traversable<K>
    
    Parameters:
    
    predicate - a predicate used to determine the prefix
    
    Returns:
    
    a Tuple containing the prefix and remainder
  - tail
```
public M tail()
```
    Description copied from interface: Traversable
    
    Returns a new Traversable without its first element.
    
    Specified by:
    
    tail in interface Multimap<K,V>
    
    Specified by:
    
    tail in interface Traversable<K>
    
    Returns:
    
    a new Traversable containing all elements except the first
  - tailOption
```
public Option<M> tailOption()
```
    Description copied from interface: Traversable
    
    Returns a new Traversable without its first element as an Option.
    
    Specified by:
    
    tailOption in interface Multimap<K,V>
    
    Specified by:
    
    tailOption in interface Traversable<K>
    
    Returns:
    
    Some(traversable) if non-empty, otherwise None
  - take
```
public M take(int n)
```
    Description copied from interface: Traversable
    
    Returns the first n elements of this Traversable, or all elements if n exceeds the length.
    Equivalent to sublist(0, max(0, min(length(), n))), but safe for n < 0 or n > length().
    If n < 0, an empty instance is returned. If n > length(), the full instance is returned.
    
    Specified by:
    
    take in interface Multimap<K,V>
    
    Specified by:
    
    take in interface Traversable<K>
    
    Parameters:
    
    n - the number of elements to take
    
    Returns:
    
    a new Traversable containing the first n elements
  - takeRight
```
public M takeRight(int n)
```
    Description copied from interface: Traversable
    
    Returns the last n elements of this Traversable, or all elements if n exceeds the length.
    Equivalent to sublist(max(0, length() - n), length()), but safe for n < 0 or n > length().
    If n < 0, an empty instance is returned. If n > length(), the full instance is returned.
    
    Specified by:
    
    takeRight in interface Multimap<K,V>
    
    Specified by:
    
    takeRight in interface Traversable<K>
    
    Parameters:
    
    n - the number of elements to take from the end
    
    Returns:
    
    a new Traversable containing the last n elements
  - takeUntil
```
public M takeUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Takes elements from this Traversable until the given predicate holds for an element.
    Equivalent to takeWhile(predicate.negate()), but useful when using method references that cannot be negated directly.
    
    Specified by:
    
    takeUntil in interface Multimap<K,V>
    
    Specified by:
    
    takeUntil in interface Traversable<K>
    
    Parameters:
    
    predicate - a condition tested sequentially on the elements
    
    Returns:
    
    a new Traversable containing all elements before the first one that satisfies the predicate
  - takeWhile
```
public M takeWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Takes elements from this Traversable while the given predicate holds.
    
    Specified by:
    
    takeWhile in interface Multimap<K,V>
    
    Specified by:
    
    takeWhile in interface Traversable<K>
    
    Parameters:
    
    predicate - a condition tested sequentially on the elements
    
    Returns:
    
    a new Traversable containing all elements up to (but not including) the first one that does not satisfy the predicate
  - equals
```
public boolean equals(java.lang.Object o)
```
    Description copied from interface: Traversable
    Determines whether this collection is equal to the given object.
    In Vavr, there are four basic collection types:
    
    Seq – sequential elements
    
    Set – distinct elements
    
    Map – key-value pairs
    
    Multimap – keys mapped to multiple values
    
    Two collections are considered equal if and only if:
    
    They are of the same collection type (Seq, Set, Map, Multimap)
    
    They contain the same elements
    
    For Seq, the element order is the same
    
    For Map and Multimap, two entries (key1, value1) and (key2, value2) are equal if both their keys and values are equal.
    Additional notes:
    
    No collection equals null (e.g., Queue(1) != null)
    
    Null elements are allowed and treated as expected (e.g., List(null, 1) == Stream(null, 1), HashMap((null,1)) == LinkedHashMap((null,1)))
    
    Element order matters only for Seq
    
    Other collection classes are equal if their types and elements (in iteration order) are equal
    
    Iterators are compared by reference only
    Specified by:
    
    equals in interface Traversable<K>
    
    Specified by:
    
    equals in interface Value<K>
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the object to compare with, may be null
    
    Returns:
    
    true if the collections are equal according to the rules above, false otherwise
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Traversable
    Returns the hash code of this collection.
    Vavr distinguishes between collections with predictable iteration order (like Seq) and collections with arbitrary iteration order (like Set, Map, and Multimap). In all cases, the hash of an empty collection is defined as 1.
    
    For collections with predictable iteration order, the hash is computed as:
    
    int hash = 1; for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }
    
    For collections with arbitrary iteration order, the hash is computed to be independent of element order:
    
    int hash = 1; for (T t : this) { hash += Objects.hashCode(t); }
    
    Note that these algorithms may change in future Vavr versions. Hash codes are generally not cached, unlike size/length, because caching would increase memory usage due to persistent tree-based structures. Computing the hash code is linear in time, O(n). For frequently re-used collections (e.g., as HashMap keys), caching can be done externally using a wrapper, for example:
    
    {@code public final class Hashed { private final K key; private final Lazy hashCode; public Hashed(K key) { this.key = key; this.hashCode = Lazy.of(() -> Objects.hashCode(key)); } public K key() { return key; }
    Specified by:
    
    hashCode in interface Traversable<K>
    
    Specified by:
    
    hashCode in interface Value<K>
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code of this collection
  - stringPrefix
```
public java.lang.String stringPrefix()
```
    Description copied from interface: Value
    
    Returns the name of this Value type, which is used by toString().
    
    Specified by:
    
    stringPrefix in interface Value<K>
    
    Returns:
    
    This type name.
  - toString
```
public java.lang.String toString()
```
    Description copied from interface: Value
    
    Clarifies that values have a proper toString() method implemented.
    See Object.toString().
    
    Specified by:
    
    toString in interface Value<K>
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of this object
  - toJavaMap
```
public java.util.Map<K,java.util.Collection<V>> toJavaMap()
```
    Description copied from interface: Multimap
    
    Converts this Vavr Map to a java.util.Map while preserving characteristics like insertion order (LinkedHashMultimap) and sort order (SortedMultimap).
    
    Specified by:
    
    toJavaMap in interface Multimap<K,V>
    
    Returns:
    
    a new java.util.Map instance
  - toJavaMap
```
protected <JM extends java.util.Map<K,java.util.Collection<V>>> JM toJavaMap(JM javaMap)
```
    Converts this Multimap to a Java Map using the provided map instance.
    
    Type Parameters:
    
    JM - The type of the Java map
    
    Parameters:
    
    javaMap - The Java map instance to populate with this multimap's entries
    
    Returns:
    
    The populated Java map

Class AbstractMultimap<K,​V,​M extends Multimap<K,​V>>

Nested Class Summary

Nested classes/interfaces inherited from interface io.vavr.collection.Multimap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vavr.collection.Foldable

Methods inherited from interface io.vavr.Function1

Methods inherited from interface io.vavr.collection.Multimap

Methods inherited from interface io.vavr.PartialFunction

Methods inherited from interface io.vavr.collection.Traversable

Methods inherited from interface io.vavr.Value

Field Detail

serialVersionUID

back

emptyContainer

containerType

Constructor Detail

AbstractMultimap

Method Detail

emptyMapSupplier

emptyInstance

createFromMap

createFromEntries

asMap

bimap

containsKey

getContainerType

flatMap

get

getOrElse

keySet

map

mapValues

put

put

remove

remove

removeAll

size

values

distinct

distinctBy

distinctBy

drop

dropRight

dropUntil

dropWhile

filter

reject

filter

reject

filterKeys

rejectKeys

filterValues

rejectValues

removeAll

removeKeys

removeValues

groupBy

grouped

init

head

initOption

isAsync

isEmpty

isLazy

iterator

last

merge

merge

orElse

orElse

partition

peek

replace

replaceAll

replaceValue

replace

Class AbstractMultimap<K,V,M extends Multimap<K,V>>