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>>, Iterable<Tuple2<K,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

Method Summary

Modifier and Type	Method	Description
`SortedMultimap<K,V>`	`distinct()`	Returns a new version of this which contains no duplicates.
`SortedMultimap<K,V>`	`distinctBy(java.util.Comparator<? super Tuple2<K,V>> comparator)`	Returns a new version of this which contains no duplicates.
`<U> SortedMultimap<K,V>`	`distinctBy(java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)`	Returns a new version of this which contains no duplicates.
`SortedMultimap<K,V>`	`drop(int n)`	Drops the first n elements of this or all elements, if this length < n.
`SortedMultimap<K,V>`	`dropRight(int n)`	Drops the last n elements of this or all elements, if this length < n.
`SortedMultimap<K,V>`	`dropUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Drops elements until the predicate holds for the current element.
`SortedMultimap<K,V>`	`dropWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Drops elements while the predicate holds for the current element.
`SortedMultimap<K,V>`	`filter(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(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a new traversable consisting of all elements which satisfy the given predicate.
`SortedMultimap<K,V>`	`filterKeys(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>`	`filterNot(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>`	`filterNot(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a new traversable consisting of all elements which do not satisfy the given predicate.
`SortedMultimap<K,V>`	`filterNotKeys(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>`	`filterNotValues(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>`	`filterValues(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(java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)`	Groups this elements by classifying the elements.
`Iterator<? extends SortedMultimap<K,V>>`	`grouped(int size)`	Groups this `Traversable` into fixed size blocks.
`SortedMultimap<K,V>`	`init()`	Dual of Traversable.tail(), returning all elements except the last.
`Option<? extends SortedMultimap<K,V>>`	`initOption()`	Dual of Traversable.tailOption(), returning all elements except the last as `Option`.
`SortedSet<K>`	`keySet()`	Returns the keys contained in this multimap.
`SortedMultimap<K,V>`	`merge(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(Multimap<K2,V2> that, 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(java.lang.Iterable<? extends Tuple2<K,V>> other)`	Returns this `Traversable` if it is nonempty, otherwise return the alternative.
`SortedMultimap<K,V>`	`orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)`	Returns this `Traversable` if it is nonempty, otherwise return the result of evaluating supplier.
`Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>>`	`partition(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Creates a partition of this `Traversable` by splitting this elements in two in distinct traversables according to a predicate.
`SortedMultimap<K,V>`	`peek(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(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(java.util.function.BiPredicate<? super K,? super V> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`reject(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`rejectKeys(java.util.function.Predicate<? super K> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`rejectValues(java.util.function.Predicate<? super V> predicate)`	Deprecated.
`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(java.lang.Iterable<? extends K> keys)`	Removes the mapping for a key from this multimap if it is present.
`SortedMultimap<K,V>`	`removeAll(java.util.function.BiPredicate<? super K,? super V> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`removeKeys(java.util.function.Predicate<? super K> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`removeValues(java.util.function.Predicate<? super V> predicate)`	Deprecated.
`SortedMultimap<K,V>`	`replace(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)`	Replaces the first occurrence (if exists) of the given currentElement with newElement.
`SortedMultimap<K,V>`	`replace(K key, V oldValue, V newValue)`	Replaces the entry with the specified key and oldValue.
`SortedMultimap<K,V>`	`replaceAll(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)`	Replaces all occurrences of the given currentElement with newElement.
`SortedMultimap<K,V>`	`replaceAll(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(java.lang.Iterable<? extends Tuple2<K,V>> elements)`	Keeps all occurrences of the given elements from this.
`SortedMultimap<K,V>`	`scan(Tuple2<K,V> zero, 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 the collection.
`Iterator<? extends SortedMultimap<K,V>>`	`slideBy(java.util.function.Function<? super Tuple2<K,V>,?> classifier)`	Slides a non-overlapping window of a variable size over this `Traversable`.
`Iterator<? extends SortedMultimap<K,V>>`	`sliding(int size)`	Slides a window of a specific `size` and step size 1 over this `Traversable` by calling `Traversable.sliding(int, int)`.
`Iterator<? extends SortedMultimap<K,V>>`	`sliding(int size, int step)`	Slides a window of a specific `size` and `step` size over this `Traversable`.
`Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>>`	`span(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Returns a tuple where the first element is the longest prefix of elements that satisfy the given `predicate` and the second element is the remainder.
`SortedMultimap<K,V>`	`tail()`	Drops the first element of a non-empty Traversable.
`Option<? extends SortedMultimap<K,V>>`	`tailOption()`	Drops the first element of a non-empty Traversable and returns an `Option`.
`SortedMultimap<K,V>`	`take(int n)`	Takes the first n elements of this or all elements, if this length < n.
`SortedMultimap<K,V>`	`takeRight(int n)`	Takes the last n elements of this or all elements, if this length < n.
`SortedMultimap<K,V>`	`takeUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Takes elements until the predicate holds for the current element.
`SortedMultimap<K,V>`	`takeWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)`	Takes elements while the predicate holds for the current element.
`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.Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupled

Methods inherited from interface io.vavr.Iterable
to

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, 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, fold, 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, reduce, reduceLeft, reduceLeftOption, reduceOption, 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
```
    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(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
  - filterNot
```
SortedMultimap<K,V> filterNot(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:
    
    filterNot in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test elements
    
    Returns:
    
    a new Multimap
  - reject
```
@Deprecated
SortedMultimap<K,V> reject(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:
    
    reject in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test elements
    
    Returns:
    
    a new Multimap
  - filterKeys
```
SortedMultimap<K,V> filterKeys(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
  - filterNotKeys
```
SortedMultimap<K,V> filterNotKeys(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:
    
    filterNotKeys in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test keys of elements
    
    Returns:
    
    a new Multimap
  - rejectKeys
```
@Deprecated
SortedMultimap<K,V> rejectKeys(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:
    
    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(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
  - filterNotValues
```
SortedMultimap<K,V> filterNotValues(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:
    
    filterNotValues in interface Multimap<K,V>
    
    Parameters:
    
    predicate - the predicate used to test values of elements
    
    Returns:
    
    a new Multimap
  - rejectValues
```
@Deprecated
SortedMultimap<K,V> rejectValues(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:
    
    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(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(Multimap<K2,V2> that,
                                                                  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(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(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(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(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(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 version of this which contains no duplicates. Elements are compared using equals.
    
    Specified by:
    
    distinct in interface Multimap<K,V>
    
    Specified by:
    
    distinct in interface Traversable<K>
    
    Returns:
    
    a new Traversable containing this elements without duplicates
  - distinctBy
```
SortedMultimap<K,V> distinctBy(java.util.Comparator<? super Tuple2<K,V>> comparator)
```
    Description copied from interface: Traversable
    
    Returns a new version of this which contains no duplicates. Elements are compared using the given comparator.
    
    Specified by:
    
    distinctBy in interface Multimap<K,V>
    
    Specified by:
    
    distinctBy in interface Traversable<K>
    
    Parameters:
    
    comparator - A comparator
    
    Returns:
    
    a new Traversable containing this elements without duplicates
  - distinctBy
```
<U> SortedMultimap<K,V> distinctBy(java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
```
    Description copied from interface: Traversable
    
    Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared using equals.
    The elements of the result are determined in the order of their occurrence - first match wins.
    
    Specified by:
    
    distinctBy in interface Multimap<K,V>
    
    Specified by:
    
    distinctBy in interface Traversable<K>
    
    Type Parameters:
    
    U - key type
    
    Parameters:
    
    keyExtractor - A key extractor
    
    Returns:
    
    a new Traversable containing this elements without duplicates
  - drop
```
SortedMultimap<K,V> drop(int n)
```
    Description copied from interface: Traversable
    
    Drops the first n elements of this or all elements, if this length < n.
    
    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 consisting of all elements of this except the first n ones, or else the empty instance, if this has less than n elements.
  - dropRight
```
SortedMultimap<K,V> dropRight(int n)
```
    Description copied from interface: Traversable
    
    Drops the last n elements of this or all elements, if this length < n.
    
    Specified by:
    
    dropRight in interface Multimap<K,V>
    
    Specified by:
    
    dropRight in interface Traversable<K>
    
    Parameters:
    
    n - The number of elements to drop.
    
    Returns:
    
    a new instance consisting of all elements of this except the last n ones, or else the empty instance, if this has less than n elements.
  - dropUntil
```
SortedMultimap<K,V> dropUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Drops elements until the predicate holds for the current element.
    
    Specified by:
    
    dropUntil in interface Multimap<K,V>
    
    Specified by:
    
    dropUntil in interface Traversable<K>
    
    Parameters:
    
    predicate - A condition tested subsequently for this elements.
    
    Returns:
    
    a new instance consisting of all elements starting from the first one which does satisfy the given predicate.
  - dropWhile
```
SortedMultimap<K,V> dropWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Drops elements while the predicate holds for the current element.
    Note: This is essentially the same as dropUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.
    
    Specified by:
    
    dropWhile in interface Multimap<K,V>
    
    Specified by:
    
    dropWhile in interface Traversable<K>
    
    Parameters:
    
    predicate - A condition tested subsequently for this elements.
    
    Returns:
    
    a new instance consisting of all elements starting from the first one which does not satisfy the given predicate.
  - filter
```
SortedMultimap<K,V> filter(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Returns a new traversable consisting of all elements which satisfy the given predicate.
    
    Specified by:
    
    filter in interface Multimap<K,V>
    
    Specified by:
    
    filter in interface Traversable<K>
    
    Parameters:
    
    predicate - A predicate
    
    Returns:
    
    a new traversable
  - filterNot
```
SortedMultimap<K,V> filterNot(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    Returns a new traversable consisting of all elements which do not satisfy the given predicate.
    The default implementation is equivalent to
    filter(predicate.negate()
    Specified by:
    
    filterNot in interface Multimap<K,V>
    
    Specified by:
    
    filterNot in interface Traversable<K>
    
    Parameters:
    
    predicate - A predicate
    
    Returns:
    
    a new traversable
  - reject
```
@Deprecated
SortedMultimap<K,V> reject(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Deprecated.
    
    Description copied from interface: Traversable
    Returns a new traversable consisting of all elements which do not satisfy the given predicate.
    The default implementation is equivalent to
    filter(predicate.negate()
    Specified by:
    
    reject in interface Multimap<K,V>
    
    Specified by:
    
    reject in interface Traversable<K>
    
    Parameters:
    
    predicate - A predicate
    
    Returns:
    
    a new traversable
  - groupBy
```
<C> Map<C,? extends SortedMultimap<K,V>> groupBy(java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)
```
    Description copied from interface: Traversable
    
    Groups this elements by classifying the elements.
    
    Specified by:
    
    groupBy in interface Multimap<K,V>
    
    Specified by:
    
    groupBy in interface Traversable<K>
    
    Type Parameters:
    
    C - classified class type
    
    Parameters:
    
    classifier - A function which classifies elements into classes
    
    Returns:
    
    A Map containing the grouped elements
    
    See Also:
    
    Traversable.arrangeBy(Function)
  - grouped
```
Iterator<? extends SortedMultimap<K,V>> grouped(int size)
```
    Description copied from interface: Traversable
    Groups this Traversable into fixed size blocks.
    Let length be the length of this Iterable. Then grouped is defined as follows:
    
    If this.isEmpty(), the resulting Iterator is empty.
    
    If size <= length, the resulting Iterator will contain length / size blocks of size size and maybe a non-empty block of size length % size, if there are remaining elements.
    
    If size > length, the resulting Iterator will contain one 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]]
    Please note that grouped(int) is a special case of Traversable.sliding(int, int), i.e. grouped(size) is the same as sliding(size, size).
    Specified by:
    
    grouped in interface Multimap<K,V>
    
    Specified by:
    
    grouped in interface Traversable<K>
    
    Parameters:
    
    size - a positive block size
    
    Returns:
    
    A new Iterator of grouped blocks of the given size
  - init
```
SortedMultimap<K,V> init()
```
    Description copied from interface: Traversable
    
    Dual of Traversable.tail(), returning all elements except the last.
    
    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
    
    Dual of Traversable.tailOption(), returning all elements except the last as Option.
    
    Specified by:
    
    initOption in interface Multimap<K,V>
    
    Specified by:
    
    initOption in interface Traversable<K>
    
    Returns:
    
    Some(traversable) or None if this 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 nonempty, otherwise return the alternative.
    
    Specified by:
    
    orElse in interface Multimap<K,V>
    
    Specified by:
    
    orElse in interface Traversable<K>
    
    Parameters:
    
    other - An alternative Traversable
    
    Returns:
    
    this Traversable if it is nonempty, otherwise return the alternative.
  - orElse
```
SortedMultimap<K,V> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
```
    Description copied from interface: Traversable
    
    Returns this Traversable if it is nonempty, otherwise return the result of evaluating supplier.
    
    Specified by:
    
    orElse in interface Multimap<K,V>
    
    Specified by:
    
    orElse in interface Traversable<K>
    
    Parameters:
    
    supplier - An alternative Traversable supplier
    
    Returns:
    
    this Traversable if it is nonempty, otherwise return the result of evaluating supplier.
  - partition
```
Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>> partition(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Creates a partition of this Traversable by splitting this elements in two in distinct traversables according to a predicate.
    
    Specified by:
    
    partition in interface Multimap<K,V>
    
    Specified by:
    
    partition in interface Traversable<K>
    
    Parameters:
    
    predicate - A predicate which classifies an element if it is in the first or the second traversable.
    
    Returns:
    
    A disjoint union of two traversables. The first Traversable contains all elements that satisfy the given predicate, the second Traversable contains all elements that don't. The original order of elements is preserved.
  - peek
```
SortedMultimap<K,V> peek(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(Tuple2<K,V> currentElement,
                                  Tuple2<K,V> newElement)
```
    Description copied from interface: Traversable
    
    Replaces the first occurrence (if exists) of the given currentElement with newElement.
    
    Specified by:
    
    replace in interface Multimap<K,V>
    
    Specified by:
    
    replace in interface Traversable<K>
    
    Parameters:
    
    currentElement - An element to be substituted.
    
    newElement - A replacement for currentElement.
    
    Returns:
    
    a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newElement.
  - replaceAll
```
SortedMultimap<K,V> replaceAll(Tuple2<K,V> currentElement,
                                     Tuple2<K,V> newElement)
```
    Description copied from interface: Traversable
    
    Replaces all occurrences of the given currentElement with newElement.
    
    Specified by:
    
    replaceAll in interface Multimap<K,V>
    
    Specified by:
    
    replaceAll in interface Traversable<K>
    
    Parameters:
    
    currentElement - An element to be substituted.
    
    newElement - A replacement for currentElement.
    
    Returns:
    
    a Traversable containing all elements of this where all occurrences of currentElement are replaced with 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(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(java.lang.Iterable<? extends Tuple2<K,V>> elements)
```
    Description copied from interface: Traversable
    
    Keeps all occurrences of the given elements from this.
    
    Specified by:
    
    retainAll in interface Multimap<K,V>
    
    Specified by:
    
    retainAll in interface Traversable<K>
    
    Parameters:
    
    elements - Elements to be kept.
    
    Returns:
    
    a Traversable containing all occurrences of the given elements.
  - scan
```
SortedMultimap<K,V> scan(Tuple2<K,V> zero,
                               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 the collection. Note: The neutral element z may be applied more than once.
    
    Specified by:
    
    scan in interface Multimap<K,V>
    
    Specified by:
    
    scan in interface Traversable<K>
    
    Parameters:
    
    zero - neutral element for the operator op
    
    operation - the associative operator for the scan
    
    Returns:
    
    a new traversable collection containing the prefix scan of the elements in this traversable collection
  - slideBy
```
Iterator<? extends SortedMultimap<K,V>> slideBy(java.util.function.Function<? super Tuple2<K,V>,?> classifier)
```
    Description copied from interface: Traversable
    Slides a non-overlapping window of a variable size over this Traversable.
    Each window contains elements with the same class, as determined by classifier. Two consecutive values in this Traversable will be in the same window only if classifier returns equal values for them. Otherwise, the values will constitute the last element of the previous window and the first element of the next window.
    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 which classifies elements into classes
    
    Returns:
    
    A new Iterator of windows of the grouped elements
  - sliding
```
Iterator<? extends SortedMultimap<K,V>> sliding(int size)
```
    Description copied from interface: Traversable
    
    Slides a window of a specific size and step size 1 over this Traversable by calling Traversable.sliding(int, int).
    
    Specified by:
    
    sliding in interface Multimap<K,V>
    
    Specified by:
    
    sliding in interface Traversable<K>
    
    Parameters:
    
    size - a positive window size
    
    Returns:
    
    a new Iterator of windows of a specific size using step size 1
  - sliding
```
Iterator<? extends SortedMultimap<K,V>> sliding(int size,
                                                      int step)
```
    Description copied from interface: Traversable
    Slides a window of a specific size and step size 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:
    
    a new Iterator of windows of a specific size using a specific step size
  - span
```
Tuple2<? extends SortedMultimap<K,V>,? extends SortedMultimap<K,V>> span(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Returns a tuple where the first element is the longest prefix of elements that satisfy the given predicate and the second element is the remainder.
    
    Specified by:
    
    span in interface Multimap<K,V>
    
    Specified by:
    
    span in interface Traversable<K>
    
    Parameters:
    
    predicate - A predicate.
    
    Returns:
    
    a Tuple containing the longest prefix of elements that satisfy p and the remainder.
  - tail
```
SortedMultimap<K,V> tail()
```
    Description copied from interface: Traversable
    
    Drops the first element of a non-empty Traversable.
    
    Specified by:
    
    tail in interface Multimap<K,V>
    
    Specified by:
    
    tail in interface Traversable<K>
    
    Returns:
    
    A new instance of Traversable containing all elements except the first.
  - tailOption
```
Option<? extends SortedMultimap<K,V>> tailOption()
```
    Description copied from interface: Traversable
    
    Drops the first element of a non-empty Traversable and returns an Option.
    
    Specified by:
    
    tailOption in interface Multimap<K,V>
    
    Specified by:
    
    tailOption in interface Traversable<K>
    
    Returns:
    
    Some(traversable) or None if this is empty.
  - take
```
SortedMultimap<K,V> take(int n)
```
    Description copied from interface: Traversable
    
    Takes the first n elements of this or all elements, if this length < n.
    The result is equivalent to sublist(0, max(0, min(length(), n))) but does not throw if n < 0 or n > length().
    In the case of n < 0 the empty instance is returned, in the case of n > length() this 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 instance consisting of the first n elements of this or all elements, if this has less than n elements.
  - takeRight
```
SortedMultimap<K,V> takeRight(int n)
```
    Description copied from interface: Traversable
    
    Takes the last n elements of this or all elements, if this length < n.
    The result is equivalent to sublist(max(0, min(length(), length() - n)), n), i.e. takeRight will not throw if n < 0 or n > length().
    In the case of n < 0 the empty instance is returned, in the case of n > length() this 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.
    
    Returns:
    
    A new instance consisting of the last n elements of this or all elements, if this has less than n elements.
  - takeUntil
```
SortedMultimap<K,V> takeUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Takes elements until the predicate holds for the current element.
    Note: This is essentially the same as takeWhile(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.
    
    Specified by:
    
    takeUntil in interface Multimap<K,V>
    
    Specified by:
    
    takeUntil in interface Traversable<K>
    
    Parameters:
    
    predicate - A condition tested subsequently for this elements.
    
    Returns:
    
    a new instance consisting of all elements before the first one which does satisfy the given predicate.
  - takeWhile
```
SortedMultimap<K,V> takeWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Traversable
    
    Takes elements while the predicate holds for the current element.
    
    Specified by:
    
    takeWhile in interface Multimap<K,V>
    
    Specified by:
    
    takeWhile in interface Traversable<K>
    
    Parameters:
    
    predicate - A condition tested subsequently for the contained elements.
    
    Returns:
    
    a new instance consisting of all elements before the first one which does not satisfy the given 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.Function1

Methods inherited from interface io.vavr.Iterable

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

filterNot

reject

filterKeys

filterNotKeys

rejectKeys

filterValues

filterNotValues

rejectValues

keySet

merge

merge

put

put

remove

remove

removeAll

removeAll

removeKeys

removeValues

toJavaMap

distinct

distinctBy

distinctBy

drop

dropRight

dropUntil

dropWhile

filter

filterNot

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>