Interface SortedMultimap<K,V>
-
- Type Parameters:
K
- Key typeV
- 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 immutableSortedMultimap
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 thisTraversable
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 asOption
.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 ofthis
multimap andthat
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 ofthis
multimap andthat
multimap.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.SortedMultimap<K,V>
orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Returns thisTraversable
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 thisTraversable
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 thisTraversable
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 givenaction
on the first element if this is an eager implementation.SortedMultimap<K,V>
put(Tuple2<? extends K,? extends V> entry)
Convenience method forput(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 thisTraversable
.Iterator<? extends SortedMultimap<K,V>>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.Iterator<? extends SortedMultimap<K,V>>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.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 givenpredicate
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 anOption
.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 VavrMap
to ajava.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.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 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
multimap
instance as narrowed typeSortedMultimap<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.
-
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.
-
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.
-
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 interfaceMultimap<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 interfaceMultimap<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 interfaceMultimap<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 interfaceMultimap<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 interfaceMultimap<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 interfaceMultimap<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.
-
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 ofthis
multimap andthat
multimap.If collisions occur, the value of
this
multimap is taken.
-
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 ofthis
multimap andthat
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 fromthat
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.
-
put
SortedMultimap<K,V> put(Tuple2<? extends K,? extends V> entry)
Description copied from interface:Multimap
Convenience method forput(entry._1, entry._2)
.
-
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.
-
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.
-
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.
-
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.
-
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 interfaceMultimap<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 interfaceMultimap<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 VavrMap
to ajava.util.Map
while preserving characteristics like insertion order (LinkedHashMultimap
) and sort order (SortedMultimap
).
-
distinct
SortedMultimap<K,V> distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.
-
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 givencomparator
.- Specified by:
distinctBy
in interfaceMultimap<K,V>
- Specified by:
distinctBy
in interfaceTraversable<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 usingequals
.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctBy
in interfaceMultimap<K,V>
- Specified by:
distinctBy
in interfaceTraversable<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.
-
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.
-
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.
-
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 interfaceMultimap<K,V>
- Specified by:
dropWhile
in 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
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.
-
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()
-
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()
-
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 interfaceMultimap<K,V>
- Specified by:
groupBy
in interfaceTraversable<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 thisTraversable
into fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty()
, the resultingIterator
is empty. - If
size <= length
, the resultingIterator
will containlength / size
blocks of sizesize
and maybe a non-empty block of sizelength % size
, if there are remaining elements. - If
size > length
, the resultingIterator
will contain one block of sizelength
.
[].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:Traversable
Dual of Traversable.tail(), returning 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 asOption
.- Specified by:
initOption
in interfaceMultimap<K,V>
- Specified by:
initOption
in interfaceTraversable<K>
- Returns:
Some(traversable)
orNone
if this is empty.
-
orElse
SortedMultimap<K,V> orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Description copied from interface:Traversable
Returns thisTraversable
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 thisTraversable
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 thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partition
in interfaceMultimap<K,V>
- Specified by:
partition
in 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
Traversable
contains all elements that satisfy the givenpredicate
, the secondTraversable
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 givenaction
on the first element if this is an eager implementation. Performs the givenaction
on all elements (the first immediately, successive deferred), if this is a lazy implementation.
-
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 interfaceMultimap<K,V>
- Specified by:
replace
in 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
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 interfaceMultimap<K,V>
- Specified by:
replaceAll
in 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
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 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
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 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
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 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
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.
-
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 interfaceMultimap<K,V>
- Specified by:
scan
in 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
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 thisTraversable
.Each window contains elements with the same class, as determined by
classifier
. Two consecutive values in thisTraversable
will be in the same window only ifclassifier
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]]
-
sliding
Iterator<? extends SortedMultimap<K,V>> sliding(int size)
Description copied from interface:Traversable
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.
-
sliding
Iterator<? extends SortedMultimap<K,V>> sliding(int size, int step)
Description copied from interface:Traversable
Slides a window of a specificsize
andstep
size 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,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 givenpredicate
and the second element is the remainder.
-
tail
SortedMultimap<K,V> tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.
-
tailOption
Option<? extends SortedMultimap<K,V>> tailOption()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable and returns anOption
.- Specified by:
tailOption
in interfaceMultimap<K,V>
- Specified by:
tailOption
in interfaceTraversable<K>
- Returns:
Some(traversable)
orNone
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 ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.
-
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 ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.
-
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.
-
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 interfaceMultimap<K,V>
- Specified by:
takeWhile
in 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.
-
-