Type Parameters:

K - Key type

V - Value type

All Superinterfaces:

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

All Known Implementing Classes:

TreeMultimap
```
public interface SortedMultimap<K,V>
extends Multimap<K,V>, Ordered<K>
```
An immutable SortedMultimap interface.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.vavr.collection.Multimap
  Multimap.ContainerType

Field Summary

Fields
Modifier and Type Field Description

static long serialVersionUID
The serial version UID for serialization.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`SortedMultimap<K,V>`	`distinct()`	Returns a new `Traversable` containing the elements of this instance with all duplicates removed.
`SortedMultimap<K,V>`	`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> SortedMultimap<K,V>`	`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`.
`SortedMultimap<K,V>`	`drop(int n)`	Returns a new `Traversable` without the first `n` elements, or an empty instance if this contains fewer than `n` elements.
`SortedMultimap<K,V>`	`dropRight(int n)`	Returns a new `Traversable` without the last `n` elements, or an empty instance if this contains fewer than `n` elements.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`filter(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)`	Returns a new Multimap consisting of all elements which satisfy the given predicate.
`SortedMultimap<K,V>`	`filter(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a new traversable containing only the elements that satisfy the given predicate.
`SortedMultimap<K,V>`	`filterKeys(@NonNull java.util.function.Predicate<? super K> predicate)`	Returns a new Multimap consisting of all elements with keys which satisfy the given predicate.
`SortedMultimap<K,V>`	`filterValues(@NonNull java.util.function.Predicate<? super V> predicate)`	Returns a new Multimap consisting of all elements with values which satisfy the given predicate.
`<C> Map<C,? extends SortedMultimap<K,V>>`	`groupBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)`	Groups elements of this `Traversable` based on a classifier function.
`Iterator<? extends SortedMultimap<K,V>>`	`grouped(int size)`	Splits this `Traversable` into consecutive blocks of the given size.
`SortedMultimap<K,V>`	`init()`	Returns all elements of this Traversable except the last one.
`Option<? extends SortedMultimap<K,V>>`	`initOption()`	Returns all elements of this Traversable except the last one, wrapped in an `Option`.
`SortedSet<K>`	`keySet()`	Returns the keys contained in this multimap.
`SortedMultimap<K,V>`	`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> SortedMultimap<K,V>`	`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.
`static <K,V> SortedMultimap<K,V>`	`narrow(SortedMultimap<? extends K,? extends V> map)`	Narrows a widened `SortedMultimap<? extends K, ? extends V>` to `SortedMultimap<K, V>` by performing a type-safe cast.
`SortedMultimap<K,V>`	`orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)`	Returns this `Traversable` if it is non-empty; otherwise, returns the result of evaluating the given supplier.
`SortedMultimap<K,V>`	`orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)`	Returns this `Traversable` if it is non-empty; otherwise, returns the given alternative.
`Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>>`	`partition(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Splits this `Traversable` into two partitions according to a predicate.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`put(@NonNull Tuple2<? extends K,? extends V> entry)`	Convenience method for `put(entry._1, entry._2)`.
`SortedMultimap<K,V>`	`put(K key, V value)`	Associates the specified value with the specified key in this multimap.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`remove(K key)`	Removes the mapping for a key from this multimap if it is present.
`SortedMultimap<K,V>`	`remove(K key, V value)`	Removes the key-value pair from this multimap if it is present.
`SortedMultimap<K,V>`	`removeAll(@NonNull java.lang.Iterable<? extends K> keys)`	Removes the mapping for a key from this multimap if it is present.
`SortedMultimap<K,V>`	`removeAll(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`removeKeys(@NonNull java.util.function.Predicate<? super K> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`removeValues(@NonNull java.util.function.Predicate<? super V> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`replace(@NonNull Tuple2<K,V> currentElement, Tuple2<K,V> newElement)`	Replaces the first occurrence of `currentElement` with `newElement`, if it exists.
`SortedMultimap<K,V>`	`replace(K key, V oldValue, V newValue)`	Replaces the entry with the specified key and oldValue.
`SortedMultimap<K,V>`	`replaceAll(@NonNull Tuple2<K,V> currentElement, Tuple2<K,V> newElement)`	Replaces all occurrences of `currentElement` with `newElement`.
`SortedMultimap<K,V>`	`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.
`SortedMultimap<K,V>`	`replaceValue(K key, V value)`	Replaces the entry for the specified key only if it is currently mapped to some value.
`SortedMultimap<K,V>`	`retainAll(@NonNull java.lang.Iterable<? extends Tuple2<K,V>> elements)`	Retains only the elements from this Traversable that are contained in the given `elements`.
`SortedMultimap<K,V>`	`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.
`Iterator<? extends SortedMultimap<K,V>>`	`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<? extends SortedMultimap<K,V>>`	`sliding(int size)`	Slides a window of a given `size` over this `Traversable` with a step size of 1.
`Iterator<? extends SortedMultimap<K,V>>`	`sliding(int size, int step)`	Slides a window of a specific `size` with a given `step` over this `Traversable`.
`Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>>`	`span(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Splits this `Traversable` into a prefix and remainder according to the given `predicate`.
`SortedMultimap<K,V>`	`tail()`	Returns a new `Traversable` without its first element.
`Option<? extends SortedMultimap<K,V>>`	`tailOption()`	Returns a new `Traversable` without its first element as an `Option`.
`SortedMultimap<K,V>`	`take(int n)`	Returns the first `n` elements of this `Traversable`, or all elements if `n` exceeds the length.
`SortedMultimap<K,V>`	`takeRight(int n)`	Returns the last `n` elements of this `Traversable`, or all elements if `n` exceeds the length.
`SortedMultimap<K,V>`	`takeUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Takes elements from this `Traversable` until the given predicate holds for an element.
`SortedMultimap<K,V>`	`takeWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Takes elements from this `Traversable` while the given predicate holds.
`java.util.SortedMap<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`).

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, asMap, asPartialFunction, bimap, collect, contains, containsKey, containsValue, flatMap, flatMap, foldRight, forEach, get, getContainerType, getOrElse, hasDefiniteSize, isDefinedAt, isDistinct, isTraversableAgain, iterator, iterator, length, map, map, mapTo, mapToVoid, mapValues, scanLeft, scanRight, size, transform, unzip, unzip, unzip3, unzip3, values, zip, zipAll, zipWith, zipWithIndex, zipWithIndex

Methods inherited from interface io.vavr.collection.Ordered
comparator

Methods inherited from interface io.vavr.PartialFunction
lift

Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, hashCode, head, headOption, isEmpty, isOrdered, isSequential, isSingleValued, last, 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, isAsync, isLazy, out, out, stderr, stdout, stringPrefix, 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, toString, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector

- Field Detail
  - serialVersionUID
```
static final long serialVersionUID
```
    The serial version UID for serialization.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - narrow
```
static <K,V> SortedMultimap<K,V> narrow(SortedMultimap<? extends K,? extends V> map)
```
    Narrows a widened SortedMultimap<? extends K, ? extends V> to SortedMultimap<K, V> by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.
    
    Type Parameters:
    
    K - Key type
    
    V - Value type
    
    Parameters:
    
    map - A SortedMultimap.
    
    Returns:
    
    the given multimap instance as narrowed type SortedMultimap<K, V>.
  - filter
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
  - keySet
```
SortedSet<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.
  - merge
```
SortedMultimap<K,V> 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
```
<K2 extends K,V2 extends V> SortedMultimap<K,V> 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
  - put
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
@Deprecated
SortedMultimap<K,V> 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
  - removeAll
```
SortedMultimap<K,V> 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.
  - removeKeys
```
@Deprecated
SortedMultimap<K,V> 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
SortedMultimap<K,V> 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
  - toJavaMap
```
java.util.SortedMap<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
  - distinct
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
<U> SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
  - groupBy
```
<C> Map<C,? extends SortedMultimap<K,V>> 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
```
Iterator<? extends SortedMultimap<K,V>> 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
```
SortedMultimap<K,V> 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
  - initOption
```
Option<? extends SortedMultimap<K,V>> 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
  - orElse
```
SortedMultimap<K,V> orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
```
    Description copied from interface: Traversable
    
    Returns this Traversable if it is non-empty; otherwise, returns the given alternative.
    
    Specified by:
    
    orElse in interface Multimap<K,V>
    
    Specified by:
    
    orElse in interface Traversable<K>
    
    Parameters:
    
    other - an alternative Traversable to return if this is empty
    
    Returns:
    
    this Traversable if non-empty, otherwise other
  - orElse
```
SortedMultimap<K,V> orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
```
    Description copied from interface: Traversable
    
    Returns this Traversable if it is non-empty; otherwise, returns the result of evaluating the given supplier.
    
    Specified by:
    
    orElse in interface Multimap<K,V>
    
    Specified by:
    
    orElse in interface Traversable<K>
    
    Parameters:
    
    supplier - a supplier of an alternative Traversable if this is empty
    
    Returns:
    
    this Traversable if non-empty, otherwise the result of supplier.get()
  - partition
```
Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
Iterator<? extends SortedMultimap<K,V>> 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
```
Iterator<? extends SortedMultimap<K,V>> 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
```
Iterator<? extends SortedMultimap<K,V>> 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
```
Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>> 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
```
SortedMultimap<K,V> 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
```
Option<? extends SortedMultimap<K,V>> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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
```
SortedMultimap<K,V> 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

Interface SortedMultimap<K,​V>

Nested Class Summary

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

Field Summary

Method Summary

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.collection.Ordered

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

Method Detail

narrow

filter

reject

filterKeys

rejectKeys

filterValues

rejectValues

keySet

merge

merge

put

put

remove

remove

removeAll

removeAll

removeKeys

removeValues

toJavaMap

distinct

distinctBy

distinctBy

drop

dropRight

dropUntil

dropWhile

filter

reject

groupBy

grouped

init

initOption

orElse

orElse

partition

peek

replace

replaceAll

replaceValue

replace

replaceAll

retainAll

scan

slideBy

sliding

sliding

span

tail

tailOption

take

takeRight

takeUntil

takeWhile

Interface SortedMultimap<K,V>