Class AbstractMultimap<K, V, M extends Multimap<K,V>>
- Type Parameters:
K- Key typeV- Value typeM- Multimap type
- All Implemented Interfaces:
Foldable<Tuple2<K,V>>, Multimap<K, V>, Traversable<Tuple2<K, V>>, Function1<K, Traversable<V>>, PartialFunction<K, Traversable<V>>, Value<Tuple2<K, V>>, Serializable, Iterable<Tuple2<K, V>>, Function<K, Traversable<V>>
- Direct Known Subclasses:
HashMultimap, LinkedHashMultimap, TreeMultimap
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static interfaceNested classes/interfaces inherited from interface Multimap
Multimap.ContainerType -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Map<K, Traversable<V>> private final Multimap.ContainerTypeprotected final AbstractMultimap.SerializableSupplier<Traversable<?>> private static final long -
Constructor Summary
ConstructorsConstructorDescriptionAbstractMultimap(Map<K, Traversable<V>> back, Multimap.ContainerType containerType, AbstractMultimap.SerializableSupplier<Traversable<?>> emptyContainer) -
Method Summary
Modifier and TypeMethodDescriptionMap<K, Traversable<V>> asMap()Converts thisMultimapto aMap<K2,V2> Multimap <K2, V2> Maps thisMultimapto a newMultimapwith different component type by applying a function to its elements.booleancontainsKey(K key) Returnstrueif this multimap contains a mapping for the specified key.private <K2,V2> Multimap <K2, V2> createFromEntries(Iterable<? extends Tuple2<? extends K2, ? extends V2>> entries) protected abstract <K2,V2> Multimap <K2, V2> createFromMap(Map<K2, Traversable<V2>> back) distinct()Returns a new version of this which contains no duplicates.distinctBy(Comparator<? super Tuple2<K, V>> comparator) Returns a new version of this which contains no duplicates.<U> MdistinctBy(Function<? super Tuple2<K, V>, ? extends U> keyExtractor) Returns a new version of this which contains no duplicates.drop(int n) Drops the first n elements of this or all elements, if this length < n.dropRight(int n) Drops the last n elements of this or all elements, if this length < n.Drops elements until the predicate holds for the current element.Drops elements while the predicate holds for the current element.protected abstract <K2,V2> Multimap <K2, V2> protected abstract <K2,V2> Map <K2, V2> booleanIn 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.filter(BiPredicate<? super K, ? super V> predicate) Returns a new Multimap consisting of all elements which satisfy the given predicate.Returns a new traversable consisting of all elements which satisfy the given predicate.filterKeys(Predicate<? super K> predicate) Returns a new Multimap consisting of all elements with keys which satisfy the given predicate.filterValues(Predicate<? super V> predicate) Returns a new Multimap consisting of all elements with values which satisfy the given predicate.<K2,V2> Multimap <K2, V2> FlatMaps thisMultimapto a newMultimapwith different component type.Returns theSomeof value to which the specified key is mapped, orNoneif this multimap contains no mapping for the key.Returns the type of theTraversablevalue container of thisMultiMap.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 mapGroups this elements by classifying the elements.grouped(int size) Groups thisTraversableinto fixed size blocks.inthashCode()Returns the hash code of this collection.head()Returns the first element of a non-empty Traversable.init()Dual of Traversable.tail(), returning all elements except the last.Dual of Traversable.tailOption(), returning all elements except the last asOption.booleanisAsync()Checks if thisValueis asynchronously (short: async) computed.booleanisEmpty()Checks if this Traversable is empty.booleanisLazy()Checks if thisValueis lazily evaluated.iterator()An iterator by means of head() and tail().keySet()Returns the keys contained in this multimap.last()Dual of Traversable.head(), returning the last element.<K2,V2> Multimap <K2, V2> map(BiFunction<? super K, ? super V, Tuple2<K2, V2>> mapper) Maps the entries of thisMultimapto form a newMultimap.Maps the values of thisMultimapwhile preserving the corresponding keys.Creates a new multimap which by merging the entries ofthismultimap andthatmultimap.merge(Multimap<K2, V2> that, BiFunction<Traversable<V>, Traversable<V2>, Traversable<V>> collisionResolution) Creates a new multimap which by merging the entries ofthismultimap andthatmultimap.Returns thisMultimapif it is nonempty, otherwiseMultimapcreated from iterable, using existing multimap properties.Returns thisMultimapif it is nonempty, otherwiseMultimapcreated from result of evaluating supplier, using existing multimap properties.Creates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.Performs the givenactionon the first element if this is an eager implementation.Convenience method forput(entry._1, entry._2).Associates the specified value with the specified key in this multimap.reject(BiPredicate<? super K, ? super V> predicate) Returns a new Multimap consisting of all elements which do not satisfy the given predicate.Returns a new traversable consisting of all elements which do not satisfy the given predicate.rejectKeys(Predicate<? super K> predicate) Returns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.rejectValues(Predicate<? super V> predicate) Returns a new Multimap consisting of all elements with values which do not satisfy the given predicate.Removes the mapping for a key from this multimap if it is present.Removes the key-value pair from this multimap if it is present.Removes the mapping for a key from this multimap if it is present.removeAll(BiPredicate<? super K, ? super V> predicate) Deprecated.removeKeys(Predicate<? super K> predicate) Deprecated.removeValues(Predicate<? super V> predicate) Deprecated.Replaces the first occurrence (if exists) of the given currentElement with newElement.Replaces the entry with the specified key and oldValue.Replaces all occurrences of the given currentElement with newElement.replaceAll(BiFunction<? super K, ? super V, ? extends V> function) Replaces each entry's values with the result of invoking the given function on that each tuple until all entries have been processed or the function throws an exception.replaceValue(K key, V value) Replaces the entry for the specified key only if it is currently mapped to some value.Keeps all occurrences of the given elements from this.scan(Tuple2<K, V> zero, BiFunction<? super Tuple2<K, V>, ? super Tuple2<K, V>, ? extends Tuple2<K, V>> operation) Computes a prefix scan of the elements of the collection.intsize()Computes the number of elements of this Traversable.Slides a non-overlapping window of a variable size over thisTraversable.sliding(int size) Slides a window of a specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int).sliding(int size, int step) Slides a window of a specificsizeandstepsize over thisTraversable.Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicateand the second element is the remainder.Returns the name of this Value type, which is used by toString().tail()Drops the first element of a non-empty Traversable.Drops the first element of a non-empty Traversable and returns anOption.take(int n) Takes the first n elements of this or all elements, if this length < n.takeRight(int n) Takes the last n elements of this or all elements, if this length < n.Takes elements until the predicate holds for the current element.Takes elements while the predicate holds for the current element.Map<K, Collection<V>> Converts this VavrMapto ajava.util.Mapwhile preserving characteristics like insertion order (LinkedHashMultimap) and sort order (SortedMultimap).protected <JM extends Map<K, Collection<V>>>
JMtoJavaMap(JM javaMap) toString()Clarifies that values have a proper toString() method implemented.values()Methods inherited from interface Foldable
fold, reduce, reduceOptionMethods inherited from interface Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupledMethods inherited from interface Multimap
apply, 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, zipWithIndexMethods inherited from interface PartialFunction
liftMethods inherited from interface Traversable
arrangeBy, average, containsAll, count, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, headOption, isOrdered, isSequential, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, single, singleOption, spliterator, sumMethods inherited from interface Value
collect, collect, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, 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 Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
back
-
emptyContainer
-
containerType
-
-
Constructor Details
-
AbstractMultimap
AbstractMultimap(Map<K, Traversable<V>> back, Multimap.ContainerType containerType, AbstractMultimap.SerializableSupplier<Traversable<?>> emptyContainer)
-
-
Method Details
-
emptyMapSupplier
-
emptyInstance
-
createFromMap
-
createFromEntries
-
asMap
-
bimap
public <K2,V2> Multimap<K2,V2> bimap(Function<? super K, ? extends K2> keyMapper, Function<? super V, ? extends V2> valueMapper) Description copied from interface:MultimapMaps thisMultimapto a newMultimapwith different component type by applying a function to its elements.- Specified by:
bimapin interfaceMultimap<K,V> - Type Parameters:
K2- key's component type of the multimap resultV2- value's component type of the multimap result- Parameters:
keyMapper- aFunctionthat maps the keys of typeKto keys of typeK2valueMapper- aFunctionthat the values of typeVto values of typeV2- Returns:
- a new
Multimap
-
containsKey
Description copied from interface:MultimapReturnstrueif this multimap contains a mapping for the specified key.- Specified by:
containsKeyin interfaceMultimap<K,V> - Parameters:
key- key whose presence in this multimap is to be tested- Returns:
trueif this multimap contains a mapping for the specified key
-
getContainerType
Description copied from interface:MultimapReturns the type of theTraversablevalue container of thisMultiMap.- Specified by:
getContainerTypein interfaceMultimap<K,V> - Returns:
- an enum value representing the container type
-
flatMap
-
get
Description copied from interface:MultimapReturns theSomeof value to which the specified key is mapped, orNoneif this multimap contains no mapping for the key. -
getOrElse
Description copied from interface:MultimapReturns the value associated with a key, or a default value if the key is not contained in the map -
keySet
-
map
Description copied from interface:MultimapMaps the entries of thisMultimapto form a newMultimap. -
mapValues
Description copied from interface:MultimapMaps the values of thisMultimapwhile preserving the corresponding keys. -
put
Description copied from interface:MultimapAssociates the specified value with the specified key in this multimap. If the map previously contained a mapping for the key, the old value is replaced by the specified value. -
put
Description copied from interface:MultimapConvenience method forput(entry._1, entry._2). -
remove
Description copied from interface:MultimapRemoves the mapping for a key from this multimap if it is present. -
remove
Description copied from interface:MultimapRemoves the key-value pair from this multimap if it is present. -
removeAll
Description copied from interface:MultimapRemoves the mapping for a key from this multimap if it is present. -
size
public int size()Description copied from interface:TraversableComputes the number of elements of this Traversable.Same as
Traversable.length(). -
values
-
distinct
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared usingequals. -
distinctBy
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared using the givencomparator.- Specified by:
distinctByin interfaceMultimap<K,V> - Specified by:
distinctByin interfaceTraversable<K>- Parameters:
comparator- A comparator- Returns:
- a new
Traversablecontaining this elements without duplicates
-
distinctBy
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements mapped to keys which are compared usingequals.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctByin interfaceMultimap<K,V> - Specified by:
distinctByin interfaceTraversable<K>- Type Parameters:
U- key type- Parameters:
keyExtractor- A key extractor- Returns:
- a new
Traversablecontaining this elements without duplicates
-
drop
Description copied from interface:TraversableDrops the first n elements of this or all elements, if this length < n. -
dropRight
Description copied from interface:TraversableDrops the last n elements of this or all elements, if this length < n. -
dropUntil
Description copied from interface:TraversableDrops elements until the predicate holds for the current element. -
dropWhile
Description copied from interface:TraversableDrops elements while the predicate holds for the current element.Note: This is essentially the same as
dropUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.- Specified by:
dropWhilein interfaceMultimap<K,V> - Specified by:
dropWhilein interfaceTraversable<K>- Parameters:
predicate- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements starting from the first one which does not satisfy the given predicate.
-
filter
Description copied from interface:TraversableReturns a new traversable consisting of all elements which satisfy the given predicate. -
reject
Description copied from interface:TraversableReturns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate() -
filter
Description copied from interface:MultimapReturns a new Multimap consisting of all elements which satisfy the given predicate. -
reject
Description copied from interface:MultimapReturns a new Multimap consisting of all elements which do not satisfy the given predicate. -
filterKeys
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with keys which satisfy the given predicate.- Specified by:
filterKeysin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Multimap
-
rejectKeys
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
rejectKeysin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Multimap
-
filterValues
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with values which satisfy the given predicate.- Specified by:
filterValuesin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Multimap
-
rejectValues
Description copied from interface:MultimapReturns a new Multimap consisting of all elements with values which do not satisfy the given predicate.- Specified by:
rejectValuesin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Multimap
-
removeAll
Deprecated.Description copied from interface:MultimapReturns a new Multimap consisting of all elements which do not satisfy the given predicate. -
removeKeys
Deprecated.Description copied from interface:MultimapReturns a new Multimap consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
removeKeysin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Multimap
-
removeValues
Deprecated.Description copied from interface:MultimapReturns a new Multimap consisting of all elements with values which do not satisfy the given predicate.- Specified by:
removeValuesin interfaceMultimap<K,V> - Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Multimap
-
groupBy
Description copied from interface:TraversableGroups this elements by classifying the elements. -
grouped
Description copied from interface:TraversableGroups thisTraversableinto fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty(), the resultingIteratoris empty. - If
size <= length, the resultingIteratorwill containlength / sizeblocks of sizesizeand maybe a non-empty block of sizelength % size, if there are remaining elements. - If
size > length, the resultingIteratorwill contain one block of sizelength.
Please note that[].grouped(1) = [] [].grouped(0) throws [].grouped(-1) throws [1,2,3,4].grouped(2) = [[1,2],[3,4]] [1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]] [1,2,3,4].grouped(5) = [[1,2,3,4]]grouped(int)is a special case of Traversable.sliding(int, int), i.e.grouped(size)is the same assliding(size, size). - If
-
init
Description copied from interface:TraversableDual of Traversable.tail(), returning all elements except the last. -
head
Description copied from interface:TraversableReturns the first element of a non-empty Traversable.- Specified by:
headin interfaceTraversable<K>- Returns:
- The first element of this Traversable.
-
initOption
Description copied from interface:TraversableDual of Traversable.tailOption(), returning all elements except the last asOption.- Specified by:
initOptionin interfaceMultimap<K,V> - Specified by:
initOptionin interfaceTraversable<K>- Returns:
Some(traversable)orNoneif this is empty.
-
isAsync
public boolean isAsync()Description copied from interface:ValueChecks if thisValueis asynchronously (short: async) computed.Methods of a
Valueinstance 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:TraversableChecks if this Traversable is empty. -
isLazy
-
iterator
Description copied from interface:TraversableAn iterator by means of head() and tail(). Subclasses may want to override this method. -
last
Description copied from interface:TraversableDual of Traversable.head(), returning the last element.- Specified by:
lastin interfaceTraversable<K>- Returns:
- the last element.
-
merge
Description copied from interface:MultimapCreates a new multimap which by merging the entries ofthismultimap andthatmultimap.If collisions occur, the value of
thismultimap is taken. -
merge
public <K2 extends K, V2 extends V> M merge(Multimap<K2, V2> that, BiFunction<Traversable<V>, Traversable<V2>, Traversable<V>> collisionResolution) Description copied from interface:MultimapCreates a new multimap which by merging the entries ofthismultimap andthatmultimap.Uses the specified collision resolution function if two keys are the same. The collision resolution function will always take the first argument from
thismultimap and the second fromthatmultimap. -
orElse
Returns thisMultimapif it is nonempty, otherwiseMultimapcreated from iterable, using existing multimap properties. -
orElse
Returns thisMultimapif it is nonempty, otherwiseMultimapcreated from result of evaluating supplier, using existing multimap properties. -
partition
Description copied from interface:TraversableCreates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partitionin interfaceMultimap<K,V> - Specified by:
partitionin interfaceTraversable<K>- Parameters:
predicate- A predicate which classifies an element if it is in the first or the second traversable.- Returns:
- A disjoint union of two traversables. The first
Traversablecontains all elements that satisfy the givenpredicate, the secondTraversablecontains all elements that don't. The original order of elements is preserved.
-
peek
Description copied from interface:ValuePerforms the givenactionon the first element if this is an eager implementation. Performs the givenactionon all elements (the first immediately, successive deferred), if this is a lazy implementation. -
replace
Description copied from interface:TraversableReplaces the first occurrence (if exists) of the given currentElement with newElement.- Specified by:
replacein interfaceMultimap<K,V> - Specified by:
replacein interfaceTraversable<K>- Parameters:
currentElement- An element to be substituted.newElement- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newElement.
-
replaceAll
Description copied from interface:TraversableReplaces all occurrences of the given currentElement with newElement.- Specified by:
replaceAllin interfaceMultimap<K,V> - Specified by:
replaceAllin interfaceTraversable<K>- Parameters:
currentElement- An element to be substituted.newElement- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where all occurrences of currentElement are replaced with newElement.
-
replaceValue
Description copied from interface:MultimapReplaces the entry for the specified key only if it is currently mapped to some value.- Specified by:
replaceValuein interfaceMultimap<K,V> - Parameters:
key- the key of the element to be substitutedvalue- the new value to be associated with the key- Returns:
- a new map containing key mapped to value if key was contained before. The old map otherwise
-
replace
Description copied from interface:MultimapReplaces the entry with the specified key and oldValue.- Specified by:
replacein interfaceMultimap<K,V> - Parameters:
key- the key of the element to be substitutedoldValue- the expected current value associated with the keynewValue- the new value to be associated with the key- Returns:
- a new map containing key mapped to newValue if key was contained before and oldValue was associated with the key. The old map otherwise.
-
replaceAll
Description copied from interface:MultimapReplaces each entry's values with the result of invoking the given function on that each tuple until all entries have been processed or the function throws an exception.- Specified by:
replaceAllin interfaceMultimap<K,V> - Parameters:
function- function transforming key and current value to a new value- Returns:
- a new map with the same keySet but transformed values
-
retainAll
Description copied from interface:TraversableKeeps all occurrences of the given elements from this. -
scan
public M scan(Tuple2<K, V> zero, BiFunction<? super Tuple2<K, V>, ? super Tuple2<K, V>, ? extends Tuple2<K, V>> operation) Description copied from interface:TraversableComputes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scanin interfaceMultimap<K,V> - Specified by:
scanin interfaceTraversable<K>- Parameters:
zero- neutral element for the operator opoperation- the associative operator for the scan- Returns:
- a new traversable collection containing the prefix scan of the elements in this traversable collection
-
slideBy
Description copied from interface:TraversableSlides a non-overlapping window of a variable size over thisTraversable.Each window contains elements with the same class, as determined by
classifier. Two consecutive values in thisTraversablewill be in the same window only ifclassifierreturns equal values for them. Otherwise, the values will constitute the last element of the previous window and the first element of the next window.Examples:
[].slideBy(Function.identity()) = [] [1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]] [1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]] -
sliding
Description copied from interface:TraversableSlides a window of a specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int). -
sliding
Description copied from interface:TraversableSlides a window of a specificsizeandstepsize over thisTraversable.Examples:
[].sliding(1,1) = [] [1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]] [1,2,3,4,5].sliding(2,4) = [[1,2],[5]] [1,2,3,4,5].sliding(2,5) = [[1,2]] [1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]] -
span
Description copied from interface:TraversableReturns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicateand the second element is the remainder. -
tail
Description copied from interface:TraversableDrops the first element of a non-empty Traversable. -
tailOption
Description copied from interface:TraversableDrops the first element of a non-empty Traversable and returns anOption.- Specified by:
tailOptionin interfaceMultimap<K,V> - Specified by:
tailOptionin interfaceTraversable<K>- Returns:
Some(traversable)orNoneif this is empty.
-
take
Description copied from interface:TraversableTakes the first n elements of this or all elements, if this length < n.The result is equivalent to
sublist(0, max(0, min(length(), n)))but does not throw ifn < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned. -
takeRight
Description copied from interface:TraversableTakes the last n elements of this or all elements, if this length < n.The result is equivalent to
sublist(max(0, min(length(), length() - n)), n), i.e. takeRight will not throw ifn < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned. -
takeUntil
Description copied from interface:TraversableTakes elements until the predicate holds for the current element.Note: This is essentially the same as
takeWhile(predicate.negate()). It is intended to be used with method references, which cannot be negated directly. -
takeWhile
Description copied from interface:TraversableTakes elements while the predicate holds for the current element.- Specified by:
takeWhilein interfaceMultimap<K,V> - Specified by:
takeWhilein interfaceTraversable<K>- Parameters:
predicate- A condition tested subsequently for the contained elements.- Returns:
- a new instance consisting of all elements before the first one which does not satisfy the given predicate.
-
equals
Description copied from interface:TraversableIn 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.
-
hashCode
public int hashCode()Description copied from interface:TraversableReturns 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()) + ")"; } } -
stringPrefix
Description copied from interface:ValueReturns the name of this Value type, which is used by toString().- Specified by:
stringPrefixin interfaceValue<K>- Returns:
- This type name.
-
toString
-
toJavaMap
Description copied from interface:MultimapConverts this VavrMapto ajava.util.Mapwhile preserving characteristics like insertion order (LinkedHashMultimap) and sort order (SortedMultimap). -
toJavaMap
-