Interface SortedMultimap<K,V>
- Type Parameters:
K- Key typeV- Value type
- All Superinterfaces:
Foldable<Tuple2<K,V>>, Function<K, Traversable<V>>, Function1<K, Traversable<V>>, Iterable<Tuple2<K, V>>, Multimap<K, V>, Ordered<K>, PartialFunction<K, Traversable<V>>, Serializable, Traversable<Tuple2<K, V>>, Value<Tuple2<K, V>>
- All Known Implementing Classes:
TreeMultimap
-
Nested Class Summary
Nested classes/interfaces inherited from interface Multimap
Multimap.ContainerType -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiondistinct()Returns a new version of this which contains no duplicates.distinctBy(Comparator<? super Tuple2<K, V>> comparator) Returns a new version of this which contains no duplicates.<U> SortedMultimap<K, V> distinctBy(Function<? super Tuple2<K, V>, ? extends U> keyExtractor) Returns a new version of this which contains no duplicates.drop(int n) Drops the first n elements of this or all elements, if this length < n.dropRight(int n) Drops the last n elements of this or all elements, if this length < n.Drops elements until the predicate holds for the current element.Drops elements while the predicate holds for the current element.filter(BiPredicate<? super K, ? super V> predicate) Returns a new Multimap consisting of all elements which satisfy the given predicate.Returns a new traversable consisting of all elements which satisfy the given predicate.filterKeys(Predicate<? super K> predicate) Returns a new Multimap consisting of all elements with keys which satisfy the given predicate.filterValues(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>> Groups this elements by classifying the elements.Iterator<? extends SortedMultimap<K, V>> grouped(int size) Groups thisTraversableinto fixed size blocks.init()Dual of Traversable.tail(), returning all elements except the last.Option<? extends SortedMultimap<K, V>> Dual of Traversable.tailOption(), returning all elements except the last asOption.keySet()Returns the keys contained in this multimap.Creates a new multimap which by merging the entries ofthismultimap andthatmultimap.<K2 extends K, V2 extends V>
SortedMultimap<K, V> merge(Multimap<K2, V2> that, BiFunction<Traversable<V>, Traversable<V2>, Traversable<V>> collisionResolution) Creates a new multimap which by merging the entries ofthismultimap andthatmultimap.static <K,V> SortedMultimap <K, V> narrow(SortedMultimap<? extends K, ? extends V> map) Narrows a widenedSortedMultimap<? extends K, ? extends V>toSortedMultimap<K, V>by performing a type-safe cast.Returns thisTraversableif it is nonempty, otherwise return the alternative.Returns thisTraversableif it is nonempty, otherwise return the result of evaluating supplier.Tuple2<? extends SortedMultimap<K, V>, ? extends SortedMultimap<K, V>> Creates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.Performs the givenactionon the first element if this is an eager implementation.Convenience method forput(entry._1, entry._2).Associates the specified value with the specified key in this multimap.reject(BiPredicate<? super K, ? super V> predicate) Returns a new Multimap consisting of all elements which do not satisfy the given predicate.Returns a new traversable consisting of all elements which do not satisfy the given predicate.rejectKeys(Predicate<? super K> predicate) Returns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.rejectValues(Predicate<? super V> predicate) Returns a new Multimap consisting of all elements with values which do not satisfy the given predicate.Removes the mapping for a key from this multimap if it is present.Removes the key-value pair from this multimap if it is present.Removes the mapping for a key from this multimap if it is present.removeAll(BiPredicate<? super K, ? super V> predicate) Deprecated.removeKeys(Predicate<? super K> predicate) Deprecated.removeValues(Predicate<? super V> predicate) Deprecated.Replaces the first occurrence (if exists) of the given currentElement with newElement.Replaces the entry with the specified key and oldValue.Replaces all occurrences of the given currentElement with newElement.replaceAll(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.replaceValue(K key, V value) Replaces the entry for the specified key only if it is currently mapped to some value.Keeps all occurrences of the given elements from this.scan(Tuple2<K, V> zero, 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>> Slides a non-overlapping window of a variable size over thisTraversable.Iterator<? extends SortedMultimap<K, V>> sliding(int size) Slides a window of a specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int).Iterator<? extends SortedMultimap<K, V>> sliding(int size, int step) Slides a window of a specificsizeandstepsize over thisTraversable.Tuple2<? extends SortedMultimap<K, V>, ? extends SortedMultimap<K, V>> Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicateand the second element is the remainder.tail()Drops the first element of a non-empty Traversable.Option<? extends SortedMultimap<K, V>> Drops the first element of a non-empty Traversable and returns anOption.take(int n) Takes the first n elements of this or all elements, if this length < n.takeRight(int n) Takes the last n elements of this or all elements, if this length < n.Takes elements until the predicate holds for the current element.Takes elements while the predicate holds for the current element.SortedMap<K, Collection<V>> Converts this VavrMapto ajava.util.Mapwhile preserving characteristics like insertion order (LinkedHashMultimap) and sort order (SortedMultimap).Methods inherited from interface Foldable
fold, reduce, reduceOptionMethods inherited from interface Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupledMethods inherited from interface 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, zipWithIndexMethods inherited from interface Ordered
comparatorMethods inherited from interface PartialFunction
liftMethods inherited from interface 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, sumMethods inherited from interface 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 Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
-
Method Details
-
narrow
Narrows a widenedSortedMultimap<? extends K, ? extends V>toSortedMultimap<K, V>by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.- Type Parameters:
K- Key typeV- Value type- Parameters:
map- ASortedMultimap.- Returns:
- the given
multimapinstance as narrowed typeSortedMultimap<K, V>.
-
filter
Description copied from interface:MultimapReturns a new Multimap consisting of all elements which satisfy the given predicate. -
reject
Description copied from interface:MultimapReturns a new Multimap consisting of all elements which do not satisfy the given predicate. -
filterKeys
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with keys which satisfy the given predicate.- Specified by:
filterKeysin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Multimap
-
rejectKeys
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
rejectKeysin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Multimap
-
filterValues
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with values which satisfy the given predicate.- Specified by:
filterValuesin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Multimap
-
rejectValues
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with values which do not satisfy the given predicate.- Specified by:
rejectValuesin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Multimap
-
keySet
-
merge
Description copied from interface:MultimapCreates a new multimap which by merging the entries ofthismultimap andthatmultimap.If collisions occur, the value of
thismultimap is taken. -
merge
<K2 extends K, V2 extends V> SortedMultimap<K,V> merge(Multimap<K2, V2> that, BiFunction<Traversable<V>, Traversable<V2>, Traversable<V>> collisionResolution) Description copied from interface:MultimapCreates a new multimap which by merging the entries ofthismultimap andthatmultimap.Uses the specified collision resolution function if two keys are the same. The collision resolution function will always take the first argument from
thismultimap and the second fromthatmultimap. -
put
Description copied from interface:MultimapAssociates 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. -
put
Description copied from interface:MultimapConvenience method forput(entry._1, entry._2). -
remove
Description copied from interface:MultimapRemoves the mapping for a key from this multimap if it is present. -
remove
Description copied from interface:MultimapRemoves the key-value pair from this multimap if it is present. -
removeAll
Deprecated.Description copied from interface:MultimapReturns a new Multimap consisting of all elements which do not satisfy the given predicate. -
removeAll
Description copied from interface:MultimapRemoves the mapping for a key from this multimap if it is present. -
removeKeys
Deprecated.Description copied from interface:MultimapReturns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
removeKeysin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Multimap
-
removeValues
Deprecated.Description copied from interface:MultimapReturns a new Multimap consisting of all elements with values which do not satisfy the given predicate.- Specified by:
removeValuesin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Multimap
-
toJavaMap
SortedMap<K, Collection<V>> toJavaMap()Description copied from interface:MultimapConverts this VavrMapto ajava.util.Mapwhile preserving characteristics like insertion order (LinkedHashMultimap) and sort order (SortedMultimap). -
distinct
SortedMultimap<K,V> distinct()Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared usingequals. -
distinctBy
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared using the givencomparator.- Specified by:
distinctByin interfaceMultimap<K,V> - Specified by:
distinctByin interfaceTraversable<K>- Parameters:
comparator- A comparator- Returns:
- a new
Traversablecontaining this elements without duplicates
-
distinctBy
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements mapped to keys which are compared usingequals.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctByin interfaceMultimap<K,V> - Specified by:
distinctByin interfaceTraversable<K>- Type Parameters:
U- key type- Parameters:
keyExtractor- A key extractor- Returns:
- a new
Traversablecontaining this elements without duplicates
-
drop
Description copied from interface:TraversableDrops the first n elements of this or all elements, if this length < n. -
dropRight
Description copied from interface:TraversableDrops the last n elements of this or all elements, if this length < n. -
dropUntil
Description copied from interface:TraversableDrops elements until the predicate holds for the current element. -
dropWhile
Description copied from interface:TraversableDrops 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:
dropWhilein interfaceMultimap<K,V> - Specified by:
dropWhilein interfaceTraversable<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
Description copied from interface:TraversableReturns a new traversable consisting of all elements which satisfy the given predicate. -
reject
Description copied from interface:TraversableReturns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate() -
groupBy
<C> Map<C, ? extends SortedMultimap<K,V>> groupBy(Function<? super Tuple2<K, V>, ? extends C> classifier) Description copied from interface:TraversableGroups this elements by classifying the elements. -
grouped
Description copied from interface:TraversableGroups thisTraversableinto fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty(), the resultingIteratoris empty. - If
size <= length, the resultingIteratorwill containlength / sizeblocks of sizesizeand maybe a non-empty block of sizelength % size, if there are remaining elements. - If
size > length, the resultingIteratorwill contain one block of sizelength.
Please note that[].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]]grouped(int)is a special case of Traversable.sliding(int, int), i.e.grouped(size)is the same assliding(size, size). - If
-
init
SortedMultimap<K,V> init()Description copied from interface:TraversableDual of Traversable.tail(), returning all elements except the last. -
initOption
Option<? extends SortedMultimap<K,V>> initOption()Description copied from interface:TraversableDual of Traversable.tailOption(), returning all elements except the last asOption.- Specified by:
initOptionin interfaceMultimap<K,V> - Specified by:
initOptionin interfaceTraversable<K>- Returns:
Some(traversable)orNoneif this is empty.
-
orElse
Description copied from interface:TraversableReturns thisTraversableif it is nonempty, otherwise return the alternative. -
orElse
Description copied from interface:TraversableReturns thisTraversableif it is nonempty, otherwise return the result of evaluating supplier. -
partition
Tuple2<? extends SortedMultimap<K,V>, ? extends SortedMultimap<K, partitionV>> (Predicate<? super Tuple2<K, V>> predicate) Description copied from interface:TraversableCreates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partitionin interfaceMultimap<K,V> - Specified by:
partitionin interfaceTraversable<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
Traversablecontains all elements that satisfy the givenpredicate, the secondTraversablecontains all elements that don't. The original order of elements is preserved.
-
peek
Description copied from interface:ValuePerforms the givenactionon the first element if this is an eager implementation. Performs the givenactionon all elements (the first immediately, successive deferred), if this is a lazy implementation. -
replace
Description copied from interface:TraversableReplaces the first occurrence (if exists) of the given currentElement with newElement.- Specified by:
replacein interfaceMultimap<K,V> - Specified by:
replacein interfaceTraversable<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
Description copied from interface:TraversableReplaces all occurrences of the given currentElement with newElement.- Specified by:
replaceAllin interfaceMultimap<K,V> - Specified by:
replaceAllin interfaceTraversable<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
Description copied from interface:MultimapReplaces the entry for the specified key only if it is currently mapped to some value.- Specified by:
replaceValuein interfaceMultimap<K,V> - Parameters:
key- the key of the element to be substitutedvalue- 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
Description copied from interface:MultimapReplaces the entry with the specified key and oldValue.- Specified by:
replacein interfaceMultimap<K,V> - Parameters:
key- the key of the element to be substitutedoldValue- the expected current value associated with the keynewValue- 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
Description copied from interface:MultimapReplaces 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:
replaceAllin interfaceMultimap<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
Description copied from interface:TraversableKeeps all occurrences of the given elements from this. -
scan
SortedMultimap<K,V> scan(Tuple2<K, V> zero, BiFunction<? super Tuple2<K, V>, ? super Tuple2<K, V>, ? extends Tuple2<K, V>> operation) Description copied from interface:TraversableComputes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scanin interfaceMultimap<K,V> - Specified by:
scanin interfaceTraversable<K>- Parameters:
zero- neutral element for the operator opoperation- the associative operator for the scan- Returns:
- a new traversable collection containing the prefix scan of the elements in this traversable collection
-
slideBy
Description copied from interface:TraversableSlides a non-overlapping window of a variable size over thisTraversable.Each window contains elements with the same class, as determined by
classifier. Two consecutive values in thisTraversablewill be in the same window only ifclassifierreturns 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]] -
sliding
Description copied from interface:TraversableSlides a window of a specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int). -
sliding
Description copied from interface:TraversableSlides a window of a specificsizeandstepsize over thisTraversable.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]] -
span
Tuple2<? extends SortedMultimap<K,V>, ? extends SortedMultimap<K, spanV>> (Predicate<? super Tuple2<K, V>> predicate) Description copied from interface:TraversableReturns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicateand the second element is the remainder. -
tail
SortedMultimap<K,V> tail()Description copied from interface:TraversableDrops the first element of a non-empty Traversable. -
tailOption
Option<? extends SortedMultimap<K,V>> tailOption()Description copied from interface:TraversableDrops the first element of a non-empty Traversable and returns anOption.- Specified by:
tailOptionin interfaceMultimap<K,V> - Specified by:
tailOptionin interfaceTraversable<K>- Returns:
Some(traversable)orNoneif this is empty.
-
take
Description copied from interface:TraversableTakes 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 ifn < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned. -
takeRight
Description copied from interface:TraversableTakes 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 ifn < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned. -
takeUntil
Description copied from interface:TraversableTakes 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. -
takeWhile
Description copied from interface:TraversableTakes elements while the predicate holds for the current element.- Specified by:
takeWhilein interfaceMultimap<K,V> - Specified by:
takeWhilein interfaceTraversable<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.
-