Class HashMultimap<K,V>
- java.lang.Object
-
- io.vavr.collection.HashMultimap<K,V>
-
- Type Parameters:
K
- Key typeV
- Value type
- All Implemented Interfaces:
Foldable<Tuple2<K,V>>
,Multimap<K,V>
,Traversable<Tuple2<K,V>>
,Function1<K,Traversable<V>>
,Iterable<Tuple2<K,V>>
,PartialFunction<K,Traversable<V>>
,Value<Tuple2<K,V>>
,java.io.Serializable
,java.lang.Iterable<Tuple2<K,V>>
,java.util.function.Function<K,Traversable<V>>
public final class HashMultimap<K,V> extends java.lang.Object implements java.io.Serializable
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HashMultimap.Builder<V>
-
Nested classes/interfaces inherited from interface io.vavr.collection.Multimap
Multimap.ContainerType
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<K,Traversable<V>>
back
protected io.vavr.collection.AbstractMultimap.SerializableSupplier<Traversable<?>>
emptyContainer
-
Method Summary
Modifier and Type Method Description Map<K,Traversable<V>>
asMap()
Converts thisMultimap
to aMap
<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.boolean
containsKey(K key)
Returnstrue
if this multimap contains a mapping for the specified key.protected <K2,V2>
HashMultimap<K2,V2>createFromMap(Map<K2,Traversable<V2>> back)
M
distinct()
Returns a new version of this which contains no duplicates.M
distinctBy(java.util.Comparator<? super Tuple2<K,V>> comparator)
Returns a new version of this which contains no duplicates.<U> M
distinctBy(java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.M
drop(int n)
Drops the first n elements of this or all elements, if this length < n.M
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.M
dropUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements until the predicate holds for the current element.M
dropWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements while the predicate holds for the current element.protected <K2,V2>
HashMultimap<K2,V2>emptyInstance()
protected <K2,V2>
Map<K2,V2>emptyMapSupplier()
boolean
equals(java.lang.Object o)
In Vavr there are four basic classes of collections: Seq (sequential elements) Set (distinct elements) Map (indexed elements) Multimap (indexed collections) Two collection instances of these classes are equal if and only if both collections belong to the same basic collection class (Seq, Set, Map or Multimap) contain the same elements have the same element order, if the collections are of type Seq Two Map/Multimap elements, resp.M
filter(java.util.function.BiPredicate<? super K,? super V> predicate)
Returns a new Multimap consisting of all elements which satisfy the given predicate.M
filter(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.M
filterKeys(java.util.function.Predicate<? super K> predicate)
Returns a new Multimap consisting of all elements with keys which satisfy the given predicate.M
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.M
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.M
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.M
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.M
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.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,M>
groupBy(java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)
Groups this elements by classifying the elements.Iterator<M>
grouped(int size)
Groups thisTraversable
into fixed size blocks.int
hashCode()
Returns the hash code of this collection.Tuple2<K,V>
head()
Returns the first element of a non-empty Traversable.M
init()
Dual of Traversable.tail(), returning all elements except the last.Option<M>
initOption()
Dual of Traversable.tailOption(), returning all elements except the last asOption
.boolean
isAsync()
Checks if thisValue
is asynchronously (short: async) computed.boolean
isEmpty()
Checks if this Traversable is empty.boolean
isLazy()
Checks if thisValue
is lazily evaluated.Iterator<Tuple2<K,V>>
iterator()
An iterator by means of head() and tail().Set<K>
keySet()
Returns the keys contained in this multimap.Tuple2<K,V>
last()
Dual of Traversable.head(), returning the last element.<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
.<V2> Multimap<K,V2>
mapValues(java.util.function.Function<? super V,? extends V2> valueMapper)
Maps the values of thisMultimap
while preserving the corresponding keys.M
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>
Mmerge(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>
HashMultimap<K,V>narrow(HashMultimap<? extends K,? extends V> map)
Narrows a widenedHashMultimap<? extends K, ? extends V>
toHashMultimap<K, V>
by performing a type safe-cast.M
orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Returns thisMultimap
if it is nonempty, otherwiseMultimap
created from iterable, using existing multimap properties.M
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
Returns thisMultimap
if it is nonempty, otherwiseMultimap
created from result of evaluating supplier, using existing multimap properties.Tuple2<M,M>
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.M
peek(java.util.function.Consumer<? super Tuple2<K,V>> action)
Performs the givenaction
on the first element if this is an eager implementation.M
put(Tuple2<? extends K,? extends V> entry)
Convenience method forput(entry._1, entry._2)
.M
put(K key, V value)
Associates the specified value with the specified key in this multimap.M
reject(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.M
reject(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Deprecated.M
rejectKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.M
rejectValues(java.util.function.Predicate<? super V> predicate)
Deprecated.M
remove(K key)
Removes the mapping for a key from this multimap if it is present.M
remove(K key, V value)
Removes the key-value pair from this multimap if it is present.M
removeAll(java.lang.Iterable<? extends K> keys)
Removes the mapping for a key from this multimap if it is present.M
removeAll(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.M
removeKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.M
removeValues(java.util.function.Predicate<? super V> predicate)
Deprecated.M
replace(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.M
replace(K key, V oldValue, V newValue)
Replaces the entry with the specified key and oldValue.M
replaceAll(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces all occurrences of the given currentElement with newElement.M
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.M
replaceValue(K key, V value)
Replaces the entry for the specified key only if it is currently mapped to some value.M
retainAll(java.lang.Iterable<? extends Tuple2<K,V>> elements)
Keeps all occurrences of the given elements from this.M
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.int
size()
Computes the number of elements of this Traversable.Iterator<M>
slideBy(java.util.function.Function<? super Tuple2<K,V>,?> classifier)
Slides a non-overlapping window of a variable size over thisTraversable
.Iterator<M>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.Iterator<M>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.Tuple2<M,M>
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.java.lang.String
stringPrefix()
Returns the name of this Value type, which is used by toString().M
tail()
Drops the first element of a non-empty Traversable.Option<M>
tailOption()
Drops the first element of a non-empty Traversable and returns anOption
.M
take(int n)
Takes the first n elements of this or all elements, if this length < n.M
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.M
takeUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Takes elements until the predicate holds for the current element.M
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
).protected <JM extends java.util.Map<K,java.util.Collection<V>>>
JMtoJavaMap(JM javaMap)
java.lang.String
toString()
Clarifies that values have a proper toString() method implemented.Traversable<V>
values()
static <V> HashMultimap.Builder<V>
withSeq()
static <V> HashMultimap.Builder<V>
withSet()
static <V extends java.lang.Comparable<?>>
HashMultimap.Builder<V>withSortedSet()
static <V> HashMultimap.Builder<V>
withSortedSet(java.util.Comparator<? super V> comparator)
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
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, asPartialFunction, collect, contains, containsValue, flatMap, foldRight, forEach, hasDefiniteSize, isDefinedAt, isDistinct, isTraversableAgain, iterator, length, map, scanLeft, scanRight, transform, unzip, unzip, unzip3, unzip3, zip, zipAll, zipWith, zipWithIndex, zipWithIndex
-
Methods inherited from interface io.vavr.PartialFunction
lift
-
Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, existsUnique, find, findLast, fold, foldLeft, forEachWithIndex, get, headOption, isOrdered, isSequential, isSingleValued, 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, out, out, stderr, stdout, 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, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
-
-
-
-
Field Detail
-
back
protected final Map<K,Traversable<V>> back
-
emptyContainer
protected final io.vavr.collection.AbstractMultimap.SerializableSupplier<Traversable<?>> emptyContainer
-
-
Method Detail
-
withSeq
public static <V> HashMultimap.Builder<V> withSeq()
-
withSet
public static <V> HashMultimap.Builder<V> withSet()
-
withSortedSet
public static <V extends java.lang.Comparable<?>> HashMultimap.Builder<V> withSortedSet()
-
withSortedSet
public static <V> HashMultimap.Builder<V> withSortedSet(java.util.Comparator<? super V> comparator)
-
narrow
public static <K,V> HashMultimap<K,V> narrow(HashMultimap<? extends K,? extends V> map)
Narrows a widenedHashMultimap<? extends K, ? extends V>
toHashMultimap<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
- AMap
.- Returns:
- the given
multimap
instance as narrowed typeMultimap<K, V>
.
-
emptyMapSupplier
protected <K2,V2> Map<K2,V2> emptyMapSupplier()
-
emptyInstance
protected <K2,V2> HashMultimap<K2,V2> emptyInstance()
-
createFromMap
protected <K2,V2> HashMultimap<K2,V2> createFromMap(Map<K2,Traversable<V2>> back)
-
asMap
public Map<K,Traversable<V>> asMap()
Description copied from interface:Multimap
Converts thisMultimap
to aMap
-
bimap
public <K2,V2> Multimap<K2,V2> bimap(java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.Function<? super V,? extends V2> valueMapper)
Description copied from interface:Multimap
Maps thisMultimap
to a newMultimap
with different component type by applying a function to its elements.- Specified by:
bimap
in interfaceMultimap<K,V>
- 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
-
containsKey
public boolean containsKey(K key)
Description copied from interface:Multimap
Returnstrue
if this multimap contains a mapping for the specified key.- Specified by:
containsKey
in interfaceMultimap<K,V>
- Parameters:
key
- key whose presence in this multimap is to be tested- Returns:
true
if this multimap contains a mapping for the specified key
-
getContainerType
public Multimap.ContainerType getContainerType()
Description copied from interface:Multimap
Returns the type of theTraversable
value container of thisMultiMap
.- Specified by:
getContainerType
in interfaceMultimap<K,V>
- Returns:
- an enum value representing the container type
-
flatMap
public <K2,V2> Multimap<K2,V2> flatMap(java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
Description copied from interface:Multimap
FlatMaps thisMultimap
to a newMultimap
with different component type.
-
get
public Option<Traversable<V>> get(K key)
Description copied from interface:Multimap
Returns theSome
of value to which the specified key is mapped, orNone
if this multimap contains no mapping for the key.
-
getOrElse
public Traversable<V> getOrElse(K key, Traversable<? extends V> defaultValue)
Description copied from interface:Multimap
Returns the value associated with a key, or a default value if the key is not contained in the map
-
keySet
public Set<K> keySet()
Description copied from interface:Multimap
Returns the keys contained in this multimap.
-
map
public <K2,V2> Multimap<K2,V2> map(java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Description copied from interface:Multimap
Maps the entries of thisMultimap
to form a newMultimap
.
-
mapValues
public <V2> Multimap<K,V2> mapValues(java.util.function.Function<? super V,? extends V2> valueMapper)
Description copied from interface:Multimap
Maps the values of thisMultimap
while preserving the corresponding keys.
-
put
public M 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
public M put(Tuple2<? extends K,? extends V> entry)
Description copied from interface:Multimap
Convenience method forput(entry._1, entry._2)
.
-
remove
public M remove(K key)
Description copied from interface:Multimap
Removes the mapping for a key from this multimap if it is present.
-
remove
public M remove(K key, V value)
Description copied from interface:Multimap
Removes the key-value pair from this multimap if it is present.
-
removeAll
public M 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.
-
size
public int size()
Description copied from interface:Traversable
Computes the number of elements of this Traversable.Same as
Traversable.length()
.- Specified by:
size
in interfaceMultimap<K,V>
- Specified by:
size
in interfaceTraversable<K>
- Returns:
- the number of elements
-
values
public Traversable<V> values()
-
distinct
public M distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.- Specified by:
distinct
in interfaceMultimap<K,V>
- Specified by:
distinct
in interfaceTraversable<K>
- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
public M 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
public <U> M 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
public M 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 interfaceMultimap<K,V>
- 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
public M 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 interfaceMultimap<K,V>
- 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
public M 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 interfaceMultimap<K,V>
- 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
public M 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
public M 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 interfaceMultimap<K,V>
- Specified by:
filter
in interfaceTraversable<K>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
filterNot
public M 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 interfaceMultimap<K,V>
- Specified by:
filterNot
in interfaceTraversable<K>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
reject
@Deprecated public M 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 interfaceMultimap<K,V>
- Specified by:
reject
in interfaceTraversable<K>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
filter
public M 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
public M 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 public M 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
public M 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
public M 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 public M 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
public M 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
public M 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 public M 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
-
removeAll
@Deprecated public M 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.
-
removeKeys
@Deprecated public M 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 public M 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
-
groupBy
public <C> Map<C,M> 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
public Iterator<M> 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 interfaceMultimap<K,V>
- 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
public M init()
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last.- Specified by:
init
in interfaceMultimap<K,V>
- Specified by:
init
in interfaceTraversable<K>
- Returns:
- a new instance containing all elements except the last.
-
head
public Tuple2<K,V> head()
Description copied from interface:Traversable
Returns the first element of a non-empty Traversable.- Specified by:
head
in interfaceTraversable<K>
- Returns:
- The first element of this Traversable.
-
initOption
public Option<M> 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.
-
isAsync
public boolean isAsync()
Description copied from interface:Value
Checks if thisValue
is asynchronously (short: async) computed.Methods of a
Value
instance that operate on the underlying value may block the current thread until the value is present and the computation can be performed.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Traversable
Checks if this Traversable is empty.- Specified by:
isEmpty
in interfaceTraversable<K>
- Specified by:
isEmpty
in interfaceValue<K>
- Returns:
- true, if this Traversable contains no elements, false otherwise.
-
isLazy
public boolean isLazy()
Description copied from interface:Value
Checks if thisValue
is lazily evaluated.
-
iterator
public 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.- Specified by:
iterator
in interfaceIterable<K>
- Specified by:
iterator
in interfacejava.lang.Iterable<K>
- Specified by:
iterator
in interfaceMultimap<K,V>
- Specified by:
iterator
in interfaceTraversable<K>
- Specified by:
iterator
in interfaceValue<K>
- Returns:
- A new Iterator of this Traversable elements.
-
last
public Tuple2<K,V> last()
Description copied from interface:Traversable
Dual of Traversable.head(), returning the last element.- Specified by:
last
in interfaceTraversable<K>
- Returns:
- the last element.
-
merge
public M 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
public <K2 extends K,V2 extends V> M 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.
-
orElse
public M orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Returns thisMultimap
if it is nonempty, otherwiseMultimap
created from iterable, using existing multimap properties.- Specified by:
orElse
in interfaceMultimap<K,V>
- Specified by:
orElse
in interfaceTraversable<K>
- Parameters:
other
- An alternativeTraversable
- Returns:
- this
Multimap
if it is nonempty, otherwiseMultimap
created from iterable, using existing multimap properties.
-
orElse
public M orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
Returns thisMultimap
if it is nonempty, otherwiseMultimap
created from result of evaluating supplier, using existing multimap properties.- Specified by:
orElse
in interfaceMultimap<K,V>
- Specified by:
orElse
in interfaceTraversable<K>
- Parameters:
supplier
- An alternativeTraversable
- Returns:
- this
Multimap
if it is nonempty, otherwiseMultimap
created from result of evaluating supplier, using existing multimap properties.
-
partition
public Tuple2<M,M> 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
public M 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
public M 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
public M 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
public M 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
public M 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
public M 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
public M 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 interfaceMultimap<K,V>
- Specified by:
retainAll
in interfaceTraversable<K>
- Parameters:
elements
- Elements to be kept.- Returns:
- a Traversable containing all occurrences of the given elements.
-
scan
public M 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
public Iterator<M> 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 interfaceMultimap<K,V>
- 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
public Iterator<M> 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 interfaceMultimap<K,V>
- 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
public Iterator<M> 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 interfaceMultimap<K,V>
- 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
public Tuple2<M,M> 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 interfaceMultimap<K,V>
- 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
public M tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.- Specified by:
tail
in interfaceMultimap<K,V>
- Specified by:
tail
in interfaceTraversable<K>
- Returns:
- A new instance of Traversable containing all elements except the first.
-
tailOption
public Option<M> 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
public M 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 interfaceMultimap<K,V>
- 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
public M 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 interfaceMultimap<K,V>
- 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
public M 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 interfaceMultimap<K,V>
- 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
public M 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.
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:Traversable
In Vavr there are four basic classes of collections:- Seq (sequential elements)
- Set (distinct elements)
- Map (indexed elements)
- Multimap (indexed collections)
- belong to the same basic collection class (Seq, Set, Map or Multimap)
- contain the same elements
- have the same element order, if the collections are of type Seq
Notes:
- No collection instance equals null, e.g. Queue(1) not equals null.
- Nulls are allowed and handled as expected, e.g. List(null, 1) equals Stream(null, 1) and HashMap((null, 1)) equals LinkedHashMap((null, 1)).
- The element order is taken into account for Seq only. E.g. List(null, 1) not equals Stream(1, null) and HashMap((null, 1), ("a", null)) equals LinkedHashMap(("a", null), (null, 1)). The reason is, that we do not know which implementations we compare when having two instances of type Map, Multimap or Set (see Liskov Substitution Principle).
- Other collection classes are equal if their types are equal and their elements are equal (in iteration order).
- Iterator equality is defined to be object reference equality.
- Specified by:
equals
in interfaceTraversable<K>
- Specified by:
equals
in interfaceValue<K>
- Overrides:
equals
in classjava.lang.Object
- Parameters:
o
- an object, may be null- Returns:
- true, if this collection equals the given object according to the rules described above, false otherwise.
-
hashCode
public int hashCode()
Description copied from interface:Traversable
Returns the hash code of this collection.
We distinguish between two types of hashes, those for collections with predictable iteration order (like Seq) and those with arbitrary iteration order (like Set, Map and Multimap).
In all cases the hash of an empty collection is defined to be 1.
Collections with predictable iteration order are hashed as follows:
Collections with arbitrary iteration order are hashed in a way such that the hash of a fixed number of elements is independent of their iteration order.int hash = 1; for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }
Please note that the particular hashing algorithms may change in a future version of Vavr.int hash = 1; for (T t : this) { hash += Objects.hashCode(t); }
Generally, hash codes of collections aren't cached in Vavr (opposed to the size/length). Storing hash codes in order to reduce the time complexity would increase the memory footprint. Persistent collections are built upon tree structures, it allows us to implement efficient memory sharing. A drawback of tree structures is that they make it necessary to store collection attributes at each tree node (read: element).
The computation of the hash code is linear in time, i.e. O(n). If the hash code of a collection is re-calculated often, e.g. when using a List as HashMap key, we might want to cache the hash code. This can be achieved by simply using a wrapper class, which is not included in Vavr but could be implemented like this:public final class Hashed<K> { private final K key; private final Lazy<Integer> hashCode; public Hashed(K key) { this.key = key; this.hashCode = Lazy.of(() -> Objects.hashCode(key)); } public K key() { return key; } @Override public boolean equals(Object o) { if (o == key) { return true; } else if (key != null && o instanceof Hashed) { final Hashed that = (Hashed) o; return key.equals(that.key); } else { return false; } } @Override public int hashCode() { return hashCode.get(); } @Override public String toString() { return "Hashed(" + (key == null ? "null" : key.toString()) + ")"; } }
- Specified by:
hashCode
in interfaceTraversable<K>
- Specified by:
hashCode
in interfaceValue<K>
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- The hash code of this collection
-
stringPrefix
public java.lang.String stringPrefix()
Description copied from interface:Value
Returns the name of this Value type, which is used by toString().- Specified by:
stringPrefix
in interfaceValue<K>
- Returns:
- This type name.
-
toString
public java.lang.String toString()
Description copied from interface:Value
Clarifies that values have a proper toString() method implemented.See Object.toString().
-
toJavaMap
public java.util.Map<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
).
-
toJavaMap
protected <JM extends java.util.Map<K,java.util.Collection<V>>> JM toJavaMap(JM javaMap)
-
-