Interface Multimap<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>>
,PartialFunction<K,Traversable<V>>
,java.io.Serializable
,Traversable<Tuple2<K,V>>
,Value<Tuple2<K,V>>
- All Known Subinterfaces:
SortedMultimap<K,V>
- All Known Implementing Classes:
HashMultimap
,LinkedHashMultimap
,TreeMultimap
public interface Multimap<K,V> extends Traversable<Tuple2<K,V>>, PartialFunction<K,Traversable<V>>, java.io.Serializable
An immutableMultimap
interface.Basic operations:
containsKey(Object)
containsValue(Object)
get(Object)
getContainerType()
keySet()
merge(Multimap)
merge(Multimap, BiFunction)
put(Object, Object)
put(Tuple2)
values()
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Multimap.ContainerType
-
Field Summary
Fields Modifier and Type Field Description static long
serialVersionUID
-
Method Summary
Modifier and Type Method Description default Traversable<V>
apply(K key)
Deprecated.Map<K,Traversable<V>>
asMap()
Converts thisMultimap
to aMap
default PartialFunction<K,Traversable<V>>
asPartialFunction()
Turns thisMultimap
into aPartialFunction
which is defined at a specific index, if thisMultimap
contains the given key.<K2,V2>
Multimap<K2,V2>bimap(java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.Function<? super V,? extends V2> valueMapper)
Maps thisMultimap
to a newMultimap
with different component type by applying a function to its elements.default <R> Seq<R>
collect(PartialFunction<? super Tuple2<K,V>,? extends R> partialFunction)
Collects all elements that are in the domain of the givenpartialFunction
by mapping the elements to typeR
.default boolean
contains(Tuple2<K,V> element)
Shortcut forexists(e -> Objects.equals(e, element))
, tests if the givenelement
is contained.boolean
containsKey(K key)
Returnstrue
if this multimap contains a mapping for the specified key.default boolean
containsValue(V value)
Returnstrue
if this multimap maps one or more keys to the specified value.Multimap<K,V>
distinct()
Returns a new version of this which contains no duplicates.Multimap<K,V>
distinctBy(java.util.Comparator<? super Tuple2<K,V>> comparator)
Returns a new version of this which contains no duplicates.<U> Multimap<K,V>
distinctBy(java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.Multimap<K,V>
drop(int n)
Drops the first n elements of this or all elements, if this length < n.Multimap<K,V>
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.Multimap<K,V>
dropUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements until the predicate holds for the current element.Multimap<K,V>
dropWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements while the predicate holds for the current element.Multimap<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.Multimap<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.Multimap<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.Multimap<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.Multimap<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.Multimap<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.Multimap<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.Multimap<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.<K2,V2>
Multimap<K2,V2>flatMap(java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
FlatMaps thisMultimap
to a newMultimap
with different component type.default <U> Seq<U>
flatMap(java.util.function.Function<? super Tuple2<K,V>,? extends java.lang.Iterable<? extends U>> mapper)
Flat-maps this entries to a sequence of values.default <U> U
foldRight(U zero, java.util.function.BiFunction<? super Tuple2<K,V>,? super U,? extends U> f)
Folds this elements from the right, starting withzero
and successively callingcombine
.default void
forEach(java.util.function.BiConsumer<K,V> action)
Performs an action on key, value pair.Option<Traversable<V>>
get(K key)
Returns theSome
of value to which the specified key is mapped, orNone
if this multimap contains no mapping for the key.Multimap.ContainerType
getContainerType()
Returns the type of theTraversable
value container of thisMultiMap
.Traversable<V>
getOrElse(K key, Traversable<? extends V> defaultValue)
Returns the value associated with a key, or a default value if the key is not contained in the map<C> Map<C,? extends Multimap<K,V>>
groupBy(java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)
Groups this elements by classifying the elements.Iterator<? extends Multimap<K,V>>
grouped(int size)
Groups thisTraversable
into fixed size blocks.default boolean
hasDefiniteSize()
Checks if this Traversable is known to have a finite size.Multimap<K,V>
init()
Dual of Traversable.tail(), returning all elements except the last.Option<? extends Multimap<K,V>>
initOption()
Dual of Traversable.tailOption(), returning all elements except the last asOption
.default boolean
isDefinedAt(K key)
Deprecated.default boolean
isDistinct()
Checks if this Traversable may consist of distinct elements only.default boolean
isTraversableAgain()
Checks if this Traversable can be repeatedly traversed.Iterator<Tuple2<K,V>>
iterator()
An iterator by means of head() and tail().default <U> Iterator<U>
iterator(java.util.function.BiFunction<K,V,? extends U> mapper)
Iterates this Multimap sequentially, mapping the (key, value) pairs to elements.Set<K>
keySet()
Returns the keys contained in this multimap.default int
length()
Computes the number of elements of this Traversable.<K2,V2>
Multimap<K2,V2>map(java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Maps the entries of thisMultimap
to form a newMultimap
.default <U> Seq<U>
map(java.util.function.Function<? super Tuple2<K,V>,? extends U> mapper)
Maps theMultimap
entries to a sequence of values.<V2> Multimap<K,V2>
mapValues(java.util.function.Function<? super V,? extends V2> valueMapper)
Maps the values of thisMultimap
while preserving the corresponding keys.Multimap<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>
Multimap<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>
Multimap<K,V>narrow(Multimap<? extends K,? extends V> map)
Narrows a widenedMultimap<? extends K, ? extends V>
toMultimap<K, V>
by performing a type-safe cast.Multimap<K,V>
orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Returns thisTraversable
if it is nonempty, otherwise return the alternative.Multimap<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 Multimap<K,V>,? extends Multimap<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.Multimap<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.Multimap<K,V>
put(Tuple2<? extends K,? extends V> entry)
Convenience method forput(entry._1, entry._2)
.Multimap<K,V>
put(K key, V value)
Associates the specified value with the specified key in this multimap.Multimap<K,V>
reject(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.Please usefilterNot(BiPredicate)
Multimap<K,V>
reject(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Deprecated.Multimap<K,V>
rejectKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.Please usefilterNotKeys(Predicate)
Multimap<K,V>
rejectValues(java.util.function.Predicate<? super V> predicate)
Deprecated.Please usefilterNotValues(Predicate)
Multimap<K,V>
remove(K key)
Removes the mapping for a key from this multimap if it is present.Multimap<K,V>
remove(K key, V value)
Removes the key-value pair from this multimap if it is present.Multimap<K,V>
removeAll(java.lang.Iterable<? extends K> keys)
Removes the mapping for a key from this multimap if it is present.Multimap<K,V>
removeAll(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.Please usereject(BiPredicate)
Multimap<K,V>
removeKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.Please userejectKeys(Predicate)
Multimap<K,V>
removeValues(java.util.function.Predicate<? super V> predicate)
Deprecated.Please userejectValues(Predicate)
Multimap<K,V>
replace(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.Multimap<K,V>
replace(K key, V oldValue, V newValue)
Replaces the entry with the specified key and oldValue.Multimap<K,V>
replaceAll(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces all occurrences of the given currentElement with newElement.Multimap<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.Multimap<K,V>
replaceValue(K key, V value)
Replaces the entry for the specified key only if it is currently mapped to some value.Multimap<K,V>
retainAll(java.lang.Iterable<? extends Tuple2<K,V>> elements)
Keeps all occurrences of the given elements from this.Multimap<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.default <U> Seq<U>
scanLeft(U zero, java.util.function.BiFunction<? super U,? super Tuple2<K,V>,? extends U> operation)
Produces a collection containing cumulative results of applying the operator going left to right.default <U> Seq<U>
scanRight(U zero, java.util.function.BiFunction<? super Tuple2<K,V>,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the operator going right to left.int
size()
Computes the number of elements of this Traversable.Iterator<? extends Multimap<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 Multimap<K,V>>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.Iterator<? extends Multimap<K,V>>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.Tuple2<? extends Multimap<K,V>,? extends Multimap<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.Multimap<K,V>
tail()
Drops the first element of a non-empty Traversable.Option<? extends Multimap<K,V>>
tailOption()
Drops the first element of a non-empty Traversable and returns anOption
.Multimap<K,V>
take(int n)
Takes the first n elements of this or all elements, if this length < n.Multimap<K,V>
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.Multimap<K,V>
takeUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Takes elements until the predicate holds for the current element.Multimap<K,V>
takeWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Takes elements while the predicate holds for the current element.java.util.Map<K,java.util.Collection<V>>
toJavaMap()
Converts this VavrMap
to ajava.util.Map
while preserving characteristics like insertion order (LinkedHashMultimap
) and sort order (SortedMultimap
).default <U> U
transform(java.util.function.Function<? super Multimap<K,V>,? extends U> f)
Transforms thisMultimap
.default <T1,T2>
Tuple2<Seq<T1>,Seq<T2>>unzip(java.util.function.BiFunction<? super K,? super V,Tuple2<? extends T1,? extends T2>> unzipper)
default <T1,T2>
Tuple2<Seq<T1>,Seq<T2>>unzip(java.util.function.Function<? super Tuple2<K,V>,Tuple2<? extends T1,? extends T2>> unzipper)
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.default <T1,T2,T3>
Tuple3<Seq<T1>,Seq<T2>,Seq<T3>>unzip3(java.util.function.BiFunction<? super K,? super V,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
default <T1,T2,T3>
Tuple3<Seq<T1>,Seq<T2>,Seq<T3>>unzip3(java.util.function.Function<? super Tuple2<K,V>,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.Traversable<V>
values()
default <U> Seq<Tuple2<Tuple2<K,V>,U>>
zip(java.lang.Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs.default <U> Seq<Tuple2<Tuple2<K,V>,U>>
zipAll(java.lang.Iterable<? extends U> that, Tuple2<K,V> thisElem, U thatElem)
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs.default <U,R>
Seq<R>zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super Tuple2<K,V>,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.default Seq<Tuple2<Tuple2<K,V>,java.lang.Integer>>
zipWithIndex()
Zips this traversable with its indices.default <U> Seq<U>
zipWithIndex(java.util.function.BiFunction<? super Tuple2<K,V>,? super java.lang.Integer,? extends U> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.-
Methods inherited from interface io.vavr.Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupled
-
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> Multimap<K,V> narrow(Multimap<? extends K,? extends V> map)
Narrows a widenedMultimap<? extends K, ? extends V>
toMultimap<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
- AMultimap
.- Returns:
- the given
multimap
instance as narrowed typeMultimap<K, V>
.
-
apply
@Deprecated default Traversable<V> apply(K key)
Deprecated.Description copied from interface:PartialFunction
Applies this function to the given argument and returns the result.
-
asMap
Map<K,Traversable<V>> asMap()
Converts thisMultimap
to aMap
- Returns:
Map<K, Traversable<V>>
-
asPartialFunction
default PartialFunction<K,Traversable<V>> asPartialFunction() throws java.lang.IndexOutOfBoundsException
Turns thisMultimap
into aPartialFunction
which is defined at a specific index, if thisMultimap
contains the given key. When applied to a defined key, the partial function will return theTraversable
of thisMultimap
that is associated with the key.- Returns:
- a new
PartialFunction
- Throws:
java.util.NoSuchElementException
- when a non-existing key is applied to the partial functionjava.lang.IndexOutOfBoundsException
-
bimap
<K2,V2> Multimap<K2,V2> bimap(java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.Function<? super V,? extends V2> valueMapper)
Maps thisMultimap
to a newMultimap
with different component type by applying a function to its elements.- Type Parameters:
K2
- key's component type of the multimap resultV2
- value's component type of the multimap result- Parameters:
keyMapper
- aFunction
that maps the keys of typeK
to keys of typeK2
valueMapper
- aFunction
that the values of typeV
to values of typeV2
- Returns:
- a new
Multimap
- Throws:
java.lang.NullPointerException
- ifkeyMapper
orvalueMapper
is null
-
collect
default <R> Seq<R> collect(PartialFunction<? super Tuple2<K,V>,? extends R> partialFunction)
Description copied from interface:Traversable
Collects all elements that are in the domain of the givenpartialFunction
by mapping the elements to typeR
.More specifically, for each of this elements in iteration order first it is checked
If the elements makes it through that filter, the mapped instance is added to the result collectionpartialFunction.isDefinedAt(element)
Note:If thisR newElement = partialFunction.apply(element)
Traversable
is ordered (i.e. extendsOrdered
, the caller ofcollect
has to ensure that the elements are comparable (i.e. extendComparable
).- Specified by:
collect
in interfaceTraversable<K>
- Type Parameters:
R
- The new element type- Parameters:
partialFunction
- A function that is not necessarily defined of all elements of this traversable.- Returns:
- A new
Traversable
instance containing elements of typeR
-
contains
default boolean contains(Tuple2<K,V> element)
Description copied from interface:Value
Shortcut forexists(e -> Objects.equals(e, element))
, tests if the givenelement
is contained.
-
containsKey
boolean containsKey(K key)
Returnstrue
if this multimap contains a mapping for the specified key.- Parameters:
key
- key whose presence in this multimap is to be tested- Returns:
true
if this multimap contains a mapping for the specified key
-
containsValue
default boolean containsValue(V value)
Returnstrue
if this multimap maps one or more keys to the specified value. This operation will require time linear in the map size.- Parameters:
value
- value whose presence in this multimap is to be tested- Returns:
true
if this multimap maps one or more keys to the specified value
-
filter
Multimap<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.- Parameters:
predicate
- the predicate used to test elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
filterNot
Multimap<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.- Parameters:
predicate
- the predicate used to test elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
reject
@Deprecated Multimap<K,V> reject(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.Please usefilterNot(BiPredicate)
Returns a new Multimap consisting of all elements which do not satisfy the given predicate.- Parameters:
predicate
- the predicate used to test elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
filterKeys
Multimap<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.- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
filterNotKeys
Multimap<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.- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
rejectKeys
@Deprecated Multimap<K,V> rejectKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.Please usefilterNotKeys(Predicate)
Returns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
filterValues
Multimap<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.- Parameters:
predicate
- the predicate used to test values of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
filterNotValues
Multimap<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.- Parameters:
predicate
- the predicate used to test values of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
rejectValues
@Deprecated Multimap<K,V> rejectValues(java.util.function.Predicate<? super V> predicate)
Deprecated.Please usefilterNotValues(Predicate)
Returns a new Multimap consisting of all elements with values which do not satisfy the given predicate.- Parameters:
predicate
- the predicate used to test values of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
flatMap
<K2,V2> Multimap<K2,V2> flatMap(java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
FlatMaps thisMultimap
to a newMultimap
with different component type.- Type Parameters:
K2
- key's component type of the mappedMultimap
V2
- value's component type of the mappedMultimap
- Parameters:
mapper
- A mapper- Returns:
- A new
Multimap
. - Throws:
java.lang.NullPointerException
- ifmapper
is null
-
forEach
default void forEach(java.util.function.BiConsumer<K,V> action)
Performs an action on key, value pair.- Parameters:
action
- ABiConsumer
- Throws:
java.lang.NullPointerException
- ifaction
is null
-
get
Option<Traversable<V>> get(K key)
Returns theSome
of value to which the specified key is mapped, orNone
if this multimap contains no mapping for the key.- Parameters:
key
- the key whose associated value is to be returned- Returns:
- the
Some
of value to which the specified key is mapped, orNone
if this multimap contains no mapping for the key
-
getOrElse
Traversable<V> getOrElse(K key, Traversable<? extends V> defaultValue)
Returns the value associated with a key, or a default value if the key is not contained in the map- Parameters:
key
- the keydefaultValue
- a default value- Returns:
- the value associated with key if it exists, otherwise the result of the default value
-
getContainerType
Multimap.ContainerType getContainerType()
Returns the type of theTraversable
value container of thisMultiMap
.- Returns:
- an enum value representing the container type
-
hasDefiniteSize
default boolean hasDefiniteSize()
Description copied from interface:Traversable
Checks if this Traversable is known to have a finite size.This method should be implemented by classes only, i.e. not by interfaces.
- Specified by:
hasDefiniteSize
in interfaceTraversable<K>
- Returns:
- true, if this Traversable is known to have a finite size, false otherwise.
-
isDefinedAt
@Deprecated default boolean isDefinedAt(K key)
Deprecated.Description copied from interface:PartialFunction
Tests if a value is contained in the function's domain.- Specified by:
isDefinedAt
in interfacePartialFunction<K,V>
- Parameters:
key
- a potential function argument- Returns:
- true, if the given value is contained in the function's domain, false otherwise
-
isDistinct
default boolean isDistinct()
Description copied from interface:Traversable
Checks if this Traversable may consist of distinct elements only.- Specified by:
isDistinct
in interfaceTraversable<K>
- Returns:
- true if this Traversable may consist of distinct elements only, false otherwise.
-
isTraversableAgain
default boolean isTraversableAgain()
Description copied from interface:Traversable
Checks if this Traversable can be repeatedly traversed.This method should be implemented by classes only, i.e. not by interfaces.
- Specified by:
isTraversableAgain
in interfaceTraversable<K>
- Returns:
- true, if this Traversable is known to be traversable repeatedly, false otherwise.
-
iterator
Iterator<Tuple2<K,V>> iterator()
Description copied from interface:Traversable
An iterator by means of head() and tail(). Subclasses may want to override this method.
-
iterator
default <U> Iterator<U> iterator(java.util.function.BiFunction<K,V,? extends U> mapper)
Iterates this Multimap sequentially, mapping the (key, value) pairs to elements.- Type Parameters:
U
- The type of the resulting elements- Parameters:
mapper
- A function that maps (key, value) pairs to elements of type U- Returns:
- An iterator through the mapped elements.
-
keySet
Set<K> keySet()
Returns the keys contained in this multimap.- Returns:
Set
of the keys contained in this multimap.
-
length
default int length()
Description copied from interface:Traversable
Computes the number of elements of this Traversable.Same as
Traversable.size()
.- Specified by:
length
in interfaceTraversable<K>
- Returns:
- the number of elements
-
map
<K2,V2> Multimap<K2,V2> map(java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Maps the entries of thisMultimap
to form a newMultimap
.- Type Parameters:
K2
- key's component type of the multimap resultV2
- value's component type of the multimap result- Parameters:
mapper
- aFunction
that maps entries of type(K, V)
to entries of type(K2, V2)
- Returns:
- a new
Multimap
- Throws:
java.lang.NullPointerException
- ifmapper
is null
-
map
default <U> Seq<U> map(java.util.function.Function<? super Tuple2<K,V>,? extends U> mapper)
Maps theMultimap
entries to a sequence of values.Please use
map(BiFunction)
if the result has to be of typeMultimap
.
-
mapValues
<V2> Multimap<K,V2> mapValues(java.util.function.Function<? super V,? extends V2> valueMapper)
Maps the values of thisMultimap
while preserving the corresponding keys.- Type Parameters:
V2
- the new value type- Parameters:
valueMapper
- aFunction
that maps values of typeV
to values of typeV2
- Returns:
- a new
Multimap
- Throws:
java.lang.NullPointerException
- ifvalueMapper
is null
-
merge
Multimap<K,V> merge(Multimap<? extends K,? extends V> that)
Creates a new multimap which by merging the entries ofthis
multimap andthat
multimap.If collisions occur, the value of
this
multimap is taken.- Parameters:
that
- the other multimap- Returns:
- A merged multimap
- Throws:
java.lang.NullPointerException
- if that multimap is null
-
merge
<K2 extends K,V2 extends V> Multimap<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.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.- Type Parameters:
K2
- key type of that MultimapV2
- value type of that Multimap- Parameters:
that
- the other multimapcollisionResolution
- the collision resolution function- Returns:
- A merged multimap
- Throws:
java.lang.NullPointerException
- if that multimap or the given collision resolution function is null
-
put
Multimap<K,V> put(K key, V value)
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.- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified key- Returns:
- A new Multimap containing these elements and that entry.
-
put
Multimap<K,V> put(Tuple2<? extends K,? extends V> entry)
Convenience method forput(entry._1, entry._2)
.- Parameters:
entry
- A Tuple2 containing the key and value- Returns:
- A new Multimap containing these elements and that entry.
-
remove
Multimap<K,V> remove(K key)
Removes the mapping for a key from this multimap if it is present.- 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
Multimap<K,V> remove(K key, V value)
Removes the key-value pair from this multimap if it is present.- Parameters:
key
- key whose mapping is to be removed from the multimapvalue
- 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 Multimap<K,V> removeAll(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.Please usereject(BiPredicate)
Returns a new Multimap consisting of all elements which do not satisfy the given predicate.- Parameters:
predicate
- the predicate used to test elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
removeAll
Multimap<K,V> removeAll(java.lang.Iterable<? extends K> keys)
Removes the mapping for a key from this multimap if it is present.- 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 Multimap<K,V> removeKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.Please userejectKeys(Predicate)
Returns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
removeValues
@Deprecated Multimap<K,V> removeValues(java.util.function.Predicate<? super V> predicate)
Deprecated.Please userejectValues(Predicate)
Returns a new Multimap consisting of all elements with values which do not satisfy the given predicate.- Parameters:
predicate
- the predicate used to test values of elements- Returns:
- a new Multimap
- Throws:
java.lang.NullPointerException
- ifpredicate
is null
-
scanLeft
default <U> Seq<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super Tuple2<K,V>,? extends U> operation)
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going left to right. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanLeft
in interfaceTraversable<K>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
scanRight
default <U> Seq<U> scanRight(U zero, java.util.function.BiFunction<? super Tuple2<K,V>,? super U,? extends U> operation)
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanRight
in interfaceTraversable<K>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
size
int size()
Description copied from interface:Traversable
Computes the number of elements of this Traversable.Same as
Traversable.length()
.- Specified by:
size
in interfaceTraversable<K>
- Returns:
- the number of elements
-
toJavaMap
java.util.Map<K,java.util.Collection<V>> toJavaMap()
Converts this VavrMap
to ajava.util.Map
while preserving characteristics like insertion order (LinkedHashMultimap
) and sort order (SortedMultimap
).- Returns:
- a new
java.util.Map
instance
-
transform
default <U> U transform(java.util.function.Function<? super Multimap<K,V>,? extends U> f)
Transforms thisMultimap
.- Type Parameters:
U
- Type of transformation result- Parameters:
f
- A transformation- Returns:
- An instance of type
U
- Throws:
java.lang.NullPointerException
- iff
is null
-
unzip
default <T1,T2> Tuple2<Seq<T1>,Seq<T2>> unzip(java.util.function.BiFunction<? super K,? super V,Tuple2<? extends T1,? extends T2>> unzipper)
-
unzip
default <T1,T2> Tuple2<Seq<T1>,Seq<T2>> unzip(java.util.function.Function<? super Tuple2<K,V>,Tuple2<? extends T1,? extends T2>> unzipper)
Description copied from interface:Traversable
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.- Specified by:
unzip
in interfaceTraversable<K>
- Type Parameters:
T1
- 1st element type of a pair returned by unzipperT2
- 2nd element type of a pair returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A pair of set containing elements split by unzipper
-
unzip3
default <T1,T2,T3> Tuple3<Seq<T1>,Seq<T2>,Seq<T3>> unzip3(java.util.function.BiFunction<? super K,? super V,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
-
unzip3
default <T1,T2,T3> Tuple3<Seq<T1>,Seq<T2>,Seq<T3>> unzip3(java.util.function.Function<? super Tuple2<K,V>,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Description copied from interface:Traversable
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.- Specified by:
unzip3
in interfaceTraversable<K>
- Type Parameters:
T1
- 1st element type of a triplet returned by unzipperT2
- 2nd element type of a triplet returned by unzipperT3
- 3rd element type of a triplet returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A triplet of set containing elements split by unzipper
-
values
Traversable<V> values()
-
zip
default <U> Seq<Tuple2<Tuple2<K,V>,U>> zip(java.lang.Iterable<? extends U> that)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zip
in interfaceTraversable<K>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
that
- The Iterable providing the second half of each result pair.- Returns:
- a new traversable containing pairs consisting of corresponding elements of this traversable and
that
iterable.
-
zipAll
default <U> Seq<Tuple2<Tuple2<K,V>,U>> zipAll(java.lang.Iterable<? extends U> that, Tuple2<K,V> thisElem, U thatElem)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.The length of the returned traversable is the maximum of the lengths of this traversable and
that
iterable.Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
- Specified by:
zipAll
in interfaceTraversable<K>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
that
- The Iterable providing the second half of each result pair.thisElem
- The element to be used to fill up the result if this traversable is shorter than that.thatElem
- The element to be used to fill up the result if that is shorter than this traversable.- Returns:
- A new traversable containing pairs consisting of corresponding elements of this traversable and that.
-
zipWith
default <U,R> Seq<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super Tuple2<K,V>,? super U,? extends R> mapper)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWith
in interfaceTraversable<K>
- Type Parameters:
U
- The type of the second parameter of the mapper.R
- The type of the mapped elements.- Parameters:
that
- The Iterable providing the second parameter of the mapper.mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-
zipWithIndex
default Seq<Tuple2<Tuple2<K,V>,java.lang.Integer>> zipWithIndex()
Description copied from interface:Traversable
Zips this traversable with its indices.- Specified by:
zipWithIndex
in interfaceTraversable<K>
- Returns:
- A new traversable containing all elements of this traversable paired with their index, starting with 0.
-
zipWithIndex
default <U> Seq<U> zipWithIndex(java.util.function.BiFunction<? super Tuple2<K,V>,? super java.lang.Integer,? extends U> mapper)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWithIndex
in interfaceTraversable<K>
- Type Parameters:
U
- The type of the mapped elements.- Parameters:
mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-
distinct
Multimap<K,V> distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.- Specified by:
distinct
in interfaceTraversable<K>
- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
Multimap<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 interfaceTraversable<K>
- Parameters:
comparator
- A comparator- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
<U> Multimap<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 interfaceTraversable<K>
- Type Parameters:
U
- key type- Parameters:
keyExtractor
- A key extractor- Returns:
- a new
Traversable
containing this elements without duplicates
-
drop
Multimap<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 interfaceTraversable<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
Multimap<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 interfaceTraversable<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
Multimap<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 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 satisfy the given predicate.
-
dropWhile
Multimap<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 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
Multimap<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 interfaceTraversable<K>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
filterNot
Multimap<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 interfaceTraversable<K>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
reject
@Deprecated Multimap<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 interfaceTraversable<K>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
flatMap
default <U> Seq<U> flatMap(java.util.function.Function<? super Tuple2<K,V>,? extends java.lang.Iterable<? extends U>> mapper)
Flat-maps this entries to a sequence of values.Please use
flatMap(BiFunction)
if the result should be aMultimap
- Specified by:
flatMap
in interfaceTraversable<K>
- Type Parameters:
U
- Component type- Parameters:
mapper
- A mapper- Returns:
- A sequence of flat-mapped values.
-
foldRight
default <U> U foldRight(U zero, java.util.function.BiFunction<? super Tuple2<K,V>,? super U,? extends U> f)
Description copied from interface:Traversable
Folds this elements from the right, starting withzero
and successively callingcombine
.Example:
// = "!cba" List("a", "b", "c").foldRight("!", (x, xs) -> xs + x)
-
groupBy
<C> Map<C,? extends Multimap<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 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 Multimap<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)
.- Specified by:
grouped
in interfaceTraversable<K>
- Parameters:
size
- a positive block size- Returns:
- A new Iterator of grouped blocks of the given size
- If
-
init
Multimap<K,V> init()
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last.- Specified by:
init
in interfaceTraversable<K>
- Returns:
- a new instance containing all elements except the last.
-
initOption
Option<? extends Multimap<K,V>> initOption()
Description copied from interface:Traversable
Dual of Traversable.tailOption(), returning all elements except the last asOption
.- Specified by:
initOption
in interfaceTraversable<K>
- Returns:
Some(traversable)
orNone
if this is empty.
-
orElse
Multimap<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.- Specified by:
orElse
in interfaceTraversable<K>
- Parameters:
other
- An alternativeTraversable
- Returns:
- this
Traversable
if it is nonempty, otherwise return the alternative.
-
orElse
Multimap<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.- Specified by:
orElse
in interfaceTraversable<K>
- Parameters:
supplier
- An alternativeTraversable
supplier- Returns:
- this
Traversable
if it is nonempty, otherwise return the result of evaluating supplier.
-
partition
Tuple2<? extends Multimap<K,V>,? extends Multimap<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 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
Multimap<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
Multimap<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 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
Multimap<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 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
Multimap<K,V> replaceValue(K key, V value)
Replaces the entry for the specified key only if it is currently mapped to some value.- 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
Multimap<K,V> replace(K key, V oldValue, V newValue)
Replaces the entry with the specified key and oldValue.- 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
Multimap<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.- Parameters:
function
- function transforming key and current value to a new value- Returns:
- a new map with the same keySet but transformed values
-
retainAll
Multimap<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 interfaceTraversable<K>
- Parameters:
elements
- Elements to be kept.- Returns:
- a Traversable containing all occurrences of the given elements.
-
scan
Multimap<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 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 Multimap<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]]
- Specified by:
slideBy
in interfaceTraversable<K>
- Parameters:
classifier
- A function which classifies elements into classes- Returns:
- A new Iterator of windows of the grouped elements
-
sliding
Iterator<? extends Multimap<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)
.- Specified by:
sliding
in interfaceTraversable<K>
- Parameters:
size
- a positive window size- Returns:
- a new Iterator of windows of a specific size using step size 1
-
sliding
Iterator<? extends Multimap<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]]
- Specified by:
sliding
in interfaceTraversable<K>
- Parameters:
size
- a positive window sizestep
- a positive step size- Returns:
- a new Iterator of windows of a specific size using a specific step size
-
span
Tuple2<? extends Multimap<K,V>,? extends Multimap<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.- Specified by:
span
in interfaceTraversable<K>
- Parameters:
predicate
- A predicate.- Returns:
- a
Tuple
containing the longest prefix of elements that satisfy p and the remainder.
-
tail
Multimap<K,V> tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.- Specified by:
tail
in interfaceTraversable<K>
- Returns:
- A new instance of Traversable containing all elements except the first.
-
tailOption
Option<? extends Multimap<K,V>> tailOption()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable and returns anOption
.- Specified by:
tailOption
in interfaceTraversable<K>
- Returns:
Some(traversable)
orNone
if this is empty.
-
take
Multimap<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.- Specified by:
take
in interfaceTraversable<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
Multimap<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.- Specified by:
takeRight
in interfaceTraversable<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
Multimap<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 interfaceTraversable<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
Multimap<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 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.
-
-