Class LinkedHashMap<K,V>
- java.lang.Object
-
- io.vavr.collection.LinkedHashMap<K,V>
-
- Type Parameters:
K- Key typeV- Value type
- All Implemented Interfaces:
Foldable<Tuple2<K,V>>,Map<K,V>,Traversable<Tuple2<K,V>>,Function1<K,V>,PartialFunction<K,V>,Value<Tuple2<K,V>>,java.io.Serializable,java.lang.Iterable<Tuple2<K,V>>,java.util.function.Function<K,V>
public final class LinkedHashMap<K,V> extends java.lang.Object implements Map<K,V>, java.io.Serializable
An immutableLinkedHashMapimplementation that has predictable (insertion-order) iteration.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description <K2,V2>
LinkedHashMap<K2,V2>bimap(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper, @NonNull java.util.function.Function<? super V,? extends V2> valueMapper)Maps thisMapto a newMapwith different component type by applying a function to its elements.static <K,V>
java.util.stream.Collector<Tuple2<K,V>,java.util.ArrayList<Tuple2<K,V>>,LinkedHashMap<K,V>>collector()Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aLinkedHashMap.static <K,V,T extends V>
java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashMap<K,V>>collector(@NonNull java.util.function.Function<? super T,? extends K> keyMapper)Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aLinkedHashMap.static <K,V,T>
java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashMap<K,V>>collector(java.util.function.Function<? super T,? extends K> keyMapper, java.util.function.Function<? super T,? extends V> valueMapper)Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aLinkedHashMap.Tuple2<V,LinkedHashMap<K,V>>computeIfAbsent(K key, @NonNull java.util.function.Function<? super K,? extends V> mappingFunction)If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.Tuple2<Option<V>,LinkedHashMap<K,V>>computeIfPresent(K key, @NonNull java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.booleancontainsKey(K key)Returnstrueif this map contains a mapping for the specified key.private LinkedHashMap<K,V>createFromEntries(java.lang.Iterable<Tuple2<K,V>> tuples)LinkedHashMap<K,V>distinct()Returns a newTraversablecontaining the elements of this instance with all duplicates removed.LinkedHashMap<K,V>distinctBy(@NonNull java.util.Comparator<? super Tuple2<K,V>> comparator)Returns a newTraversablecontaining the elements of this instance without duplicates, as determined by the givencomparator.<U> LinkedHashMap<K,V>distinctBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)Returns a newTraversablecontaining the elements of this instance without duplicates, based on keys extracted from elements usingkeyExtractor.LinkedHashMap<K,V>drop(int n)Returns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.LinkedHashMap<K,V>dropRight(int n)Returns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.LinkedHashMap<K,V>dropUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Returns a newTraversablestarting from the first element that satisfies the givenpredicate, dropping all preceding elements.LinkedHashMap<K,V>dropWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Returns a newTraversablestarting from the first element that does not satisfy the givenpredicate, dropping all preceding elements.static <K,V>
LinkedHashMap<K,V>empty()Returns the empty LinkedHashMap.booleanequals(java.lang.Object o)Determines whether this collection is equal to the given object.static <K,V>
LinkedHashMap<K,V>fill(int n, @NonNull java.util.function.Supplier<? extends Tuple2<? extends K,? extends V>> s)Returns a LinkedHashMap containing tuples returned byncalls to a given Suppliers.LinkedHashMap<K,V>filter(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)Returns a new Map consisting of all elements which satisfy the given predicate.LinkedHashMap<K,V>filter(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Returns a new traversable containing only the elements that satisfy the given predicate.LinkedHashMap<K,V>filterKeys(@NonNull java.util.function.Predicate<? super K> predicate)Returns a new Map consisting of all elements with keys which satisfy the given predicate.LinkedHashMap<K,V>filterValues(@NonNull java.util.function.Predicate<? super V> predicate)Returns a new Map consisting of all elements with values which satisfy the given predicate.<K2,V2>
LinkedHashMap<K2,V2>flatMap(@NonNull java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)FlatMaps thisMapto a newMapwith different component type.Option<V>get(K key)Returns theSomeof value to which the specified key is mapped, orNoneif this map contains no mapping for the key.VgetOrElse(K key, 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,LinkedHashMap<K,V>>groupBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)Groups elements of thisTraversablebased on a classifier function.Iterator<LinkedHashMap<K,V>>grouped(int size)Splits thisTraversableinto consecutive blocks of the given size.inthashCode()Returns the hash code of this collection.Tuple2<K,V>head()Returns the first element of this non-emptyTraversable.LinkedHashMap<K,V>init()Returns all elements of this Traversable except the last one.Option<LinkedHashMap<K,V>>initOption()Returns all elements of this Traversable except the last one, wrapped in anOption.booleanisAsync()AnLinkedHashMap's value is computed synchronously.booleanisEmpty()Checks if this Traversable contains no elements.booleanisLazy()AnLinkedHashMap's value is computed eagerly.booleanisSequential()Indicates whether the elements of this Traversable appear in encounter (insertion) order.@NonNull Iterator<Tuple2<K,V>>iterator()Returns an iterator over the elements of this Traversable, implemented viaTraversable.head()andTraversable.tail().Set<K>keySet()Returns the keys contained in this map.Tuple2<K,V>last()Returns the last element of this Traversable.<K2,V2>
LinkedHashMap<K2,V2>map(@NonNull java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)Maps the entries of thisMapto form a newMap.<K2> LinkedHashMap<K2,V>mapKeys(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper)Maps the keys of thisMapwhile preserving the corresponding values.<K2> LinkedHashMap<K2,V>mapKeys(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper, @NonNull java.util.function.BiFunction<? super V,? super V,? extends V> valueMerge)Maps the keys of thisMapwhile preserving the corresponding values and applying a value merge function on collisions.<W> LinkedHashMap<K,W>mapValues(@NonNull java.util.function.Function<? super V,? extends W> mapper)Maps the values of thisMapwhile preserving the corresponding keys.LinkedHashMap<K,V>merge(@NonNull Map<? extends K,? extends V> that)Creates a new map which by merging the entries ofthismap andthatmap.<U extends V>
LinkedHashMap<K,V>merge(@NonNull Map<? extends K,U> that, @NonNull java.util.function.BiFunction<? super V,? super U,? extends V> collisionResolution)Creates a new map which by merging the entries ofthismap andthatmap.static <K,V>
LinkedHashMap<K,V>narrow(@NonNull LinkedHashMap<? extends K,? extends V> linkedHashMap)Narrows aLinkedHashMap<? extends K, ? extends V>toLinkedHashMap<K, V>via a type-safe cast.static <K,V>
LinkedHashMap<K,V>of(@NonNull Tuple2<? extends K,? extends V> entry)Returns a singletonLinkedHashMap, i.e.static <K,V>
LinkedHashMap<K,V>of(K key, V value)Returns a singletonLinkedHashMap, i.e.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)Creates a LinkedHashMap of the given list of key-value pairs.static <K,V>
LinkedHashMap<K,V>ofAll(@NonNull java.util.Map<? extends K,? extends V> map)Returns aLinkedHashMap, from a source java.util.Map.static <T,K,V>
LinkedHashMap<K,V>ofAll(@NonNull java.util.stream.Stream<? extends T> stream, java.util.function.Function<? super T,? extends K> keyMapper, java.util.function.Function<? super T,? extends V> valueMapper)Returns aLinkedHashMap, from entries mapped from stream.static <T,K,V>
LinkedHashMap<K,V>ofAll(@NonNull java.util.stream.Stream<? extends T> stream, java.util.function.Function<? super T,Tuple2<? extends K,? extends V>> entryMapper)Returns aLinkedHashMap, from entries mapped from stream.static <K,V>
LinkedHashMap<K,V>ofEntries(@NonNull Tuple2<? extends K,? extends V> @NonNull ... entries)Creates a LinkedHashMap of the given entries.static <K,V>
LinkedHashMap<K,V>ofEntries(@NonNull java.lang.Iterable<? extends Tuple2<? extends K,? extends V>> entries)Creates a LinkedHashMap of the given entries.static <K,V>
LinkedHashMap<K,V>ofEntries(@NonNull java.util.Map.Entry<? extends K,? extends V> @NonNull ... entries)Creates a LinkedHashMap of the given entries.LinkedHashMap<K,V>orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)Returns thisTraversableif it is non-empty; otherwise, returns the result of evaluating the given supplier.LinkedHashMap<K,V>orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)Returns thisTraversableif it is non-empty; otherwise, returns the given alternative.Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>>partition(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Splits thisTraversableinto two partitions according to a predicate.LinkedHashMap<K,V>peek(@NonNull java.util.function.Consumer<? super Tuple2<K,V>> action)Performs the givenactionon the first element if this is an eager implementation.LinkedHashMap<K,V>put(@NonNull Tuple2<? extends K,? extends V> entry)Convenience method forput(entry._1, entry._2).<U extends V>
LinkedHashMap<K,V>put(@NonNull Tuple2<? extends K,U> entry, @NonNull java.util.function.BiFunction<? super V,? super U,? extends V> merge)Convenience method forput(entry._1, entry._2, merge).<U extends V>
LinkedHashMap<K,V>put(K key, U value, @NonNull java.util.function.BiFunction<? super V,? super U,? extends V> merge)Associates the specified value with the specified key in this map.LinkedHashMap<K,V>put(K key, V value)Associates the specified value with the specified key in this map.private java.lang.ObjectreadResolve()LinkedHashMap<K,V>reject(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)Returns a new Map consisting of all elements which do not satisfy the given predicate.LinkedHashMap<K,V>reject(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Returns a new traversable containing only the elements that do not satisfy the given predicate.LinkedHashMap<K,V>rejectKeys(@NonNull java.util.function.Predicate<? super K> predicate)Returns a new Map consisting of all elements with keys which do not satisfy the given predicate.LinkedHashMap<K,V>rejectValues(@NonNull java.util.function.Predicate<? super V> predicate)Returns a new Map consisting of all elements with values which do not satisfy the given predicate.LinkedHashMap<K,V>remove(K key)Removes the mapping for a key from this map if it is present.LinkedHashMap<K,V>removeAll(@NonNull java.lang.Iterable<? extends K> keys)Removes the mapping for a key from this map if it is present.LinkedHashMap<K,V>removeAll(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)Deprecated.LinkedHashMap<K,V>removeKeys(@NonNull java.util.function.Predicate<? super K> predicate)Deprecated.LinkedHashMap<K,V>removeValues(@NonNull java.util.function.Predicate<? super V> predicate)Deprecated.LinkedHashMap<K,V>replace(@NonNull Tuple2<K,V> currentElement, @NonNull Tuple2<K,V> newElement)Replaces the first occurrence ofcurrentElementwithnewElement, if it exists.LinkedHashMap<K,V>replace(K key, V oldValue, V newValue)Replaces the entry for the specified key only if currently mapped to the specified value.LinkedHashMap<K,V>replaceAll(@NonNull Tuple2<K,V> currentElement, Tuple2<K,V> newElement)Replaces all occurrences ofcurrentElementwithnewElement.LinkedHashMap<K,V>replaceAll(@NonNull java.util.function.BiFunction<? super K,? super V,? extends V> function)Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception.LinkedHashMap<K,V>replaceValue(K key, V value)Replaces the entry for the specified key only if it is currently mapped to some value.LinkedHashMap<K,V>retainAll(@NonNull java.lang.Iterable<? extends Tuple2<K,V>> elements)Retains only the elements from this Traversable that are contained in the givenelements.LinkedHashMap<K,V>scan(@NonNull Tuple2<K,V> zero, @NonNull 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 this Traversable.intsize()Returns the number of elements in this Traversable.Iterator<LinkedHashMap<K,V>>slideBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,?> classifier)Partitions thisTraversableinto consecutive non-overlapping windows according to a classification function.Iterator<LinkedHashMap<K,V>>sliding(int size)Slides a window of a givensizeover thisTraversablewith a step size of 1.Iterator<LinkedHashMap<K,V>>sliding(int size, int step)Slides a window of a specificsizewith a givenstepover thisTraversable.Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>>span(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Splits thisTraversableinto a prefix and remainder according to the givenpredicate.java.lang.StringstringPrefix()Returns the name of this Value type, which is used by toString().static <K,V>
LinkedHashMap<K,V>tabulate(int n, @NonNull java.util.function.Function<? super java.lang.Integer,? extends Tuple2<? extends K,? extends V>> f)Returns a LinkedHashMap containingnvalues of a given Functionfover a range of integer values from 0 ton - 1.LinkedHashMap<K,V>tail()Returns a newTraversablewithout its first element.Option<LinkedHashMap<K,V>>tailOption()Returns a newTraversablewithout its first element as anOption.LinkedHashMap<K,V>take(int n)Returns the firstnelements of thisTraversable, or all elements ifnexceeds the length.LinkedHashMap<K,V>takeRight(int n)Returns the lastnelements of thisTraversable, or all elements ifnexceeds the length.LinkedHashMap<K,V>takeUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Takes elements from thisTraversableuntil the given predicate holds for an element.LinkedHashMap<K,V>takeWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)Takes elements from thisTraversablewhile the given predicate holds.java.util.LinkedHashMap<K,V>toJavaMap()Converts this VavrMapto ajava.util.Mapwhile preserving characteristics like insertion order (LinkedHashMap) and sort order (SortedMap).java.lang.StringtoString()Clarifies that values have a proper toString() method implemented.Seq<V>values()Returns a newSeqthat contains the values of thisMap.private static <K,V>
LinkedHashMap<K,V>wrap(@NonNull Queue<Tuple2<K,V>> list, HashMap<K,V> map)Construct Map with given values and key order.private static <K,V>
LinkedHashMap<K,V>wrapNonUnique(@NonNull Queue<Tuple2<K,V>> list, HashMap<K,V> map)Construct Map with given values and key order.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface io.vavr.collection.Foldable
fold, reduce, reduceOption
-
Methods inherited from interface io.vavr.Function1
andThen, arity, compose, compose1, curried, isMemoized, memoized, partial, reversed, tupled
-
Methods inherited from interface io.vavr.collection.Map
apply, asPartialFunction, collect, contains, containsValue, flatMap, foldRight, forEach, hasDefiniteSize, isDefinedAt, isDistinct, isTraversableAgain, iterator, keysIterator, length, lift, map, mapTo, mapToVoid, scanLeft, scanRight, transform, unzip, unzip, unzip, unzip3, unzip3, valuesIterator, withDefault, withDefaultValue, zip, zipAll, zipWith, zipWithIndex, zipWithIndex
-
Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, headOption, isOrdered, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduceLeft, reduceLeftOption, 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
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
EMPTY
private static final LinkedHashMap<?,?> EMPTY
-
-
Method Detail
-
collector
public static <K,V> java.util.stream.Collector<Tuple2<K,V>,java.util.ArrayList<Tuple2<K,V>>,LinkedHashMap<K,V>> collector()
Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aLinkedHashMap.- Type Parameters:
K- The key typeV- The value type- Returns:
- A
LinkedHashMapCollector.
-
collector
public static <K,V,T extends V> java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashMap<K,V>> collector(@NonNull java.util.function.Function<? super T,? extends K> keyMapper)
Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aLinkedHashMap.- Type Parameters:
K- The key typeV- The value typeT- InitialStreamelements type- Parameters:
keyMapper- The key mapper- Returns:
- A
LinkedHashMapCollector.
-
collector
public static <K,V,T> java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashMap<K,V>> collector(java.util.function.Function<? super T,? extends K> keyMapper, java.util.function.Function<? super T,? extends V> valueMapper)
Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aLinkedHashMap.- Type Parameters:
K- The key typeV- The value typeT- InitialStreamelements type- Parameters:
keyMapper- The key mappervalueMapper- The value mapper- Returns:
- A
LinkedHashMapCollector.
-
empty
public static <K,V> LinkedHashMap<K,V> empty()
Returns the empty LinkedHashMap.- Type Parameters:
K- The key typeV- The value type- Returns:
- The empty LinkedHashMap.
-
narrow
public static <K,V> LinkedHashMap<K,V> narrow(@NonNull LinkedHashMap<? extends K,? extends V> linkedHashMap)
Narrows aLinkedHashMap<? extends K, ? extends V>toLinkedHashMap<K, V>via a type-safe cast. Safe here because the map is immutable and no elements can be added that would violate the type (covariance)- Type Parameters:
K- the target key typeV- the target value type- Parameters:
linkedHashMap- the map to narrow- Returns:
- the same map viewed as
LinkedHashMap<K, V>
-
of
public static <K,V> LinkedHashMap<K,V> of(@NonNull Tuple2<? extends K,? extends V> entry)
Returns a singletonLinkedHashMap, i.e. aLinkedHashMapof one element.- Type Parameters:
K- The key typeV- The value type- Parameters:
entry- A map entry.- Returns:
- A new Map containing the given entry
-
ofAll
public static <K,V> LinkedHashMap<K,V> ofAll(@NonNull java.util.Map<? extends K,? extends V> map)
Returns aLinkedHashMap, from a source java.util.Map.- Type Parameters:
K- The key typeV- The value type- Parameters:
map- A map- Returns:
- A new Map containing the given map
-
ofAll
public static <T,K,V> LinkedHashMap<K,V> ofAll(@NonNull java.util.stream.Stream<? extends T> stream, java.util.function.Function<? super T,Tuple2<? extends K,? extends V>> entryMapper)
Returns aLinkedHashMap, from entries mapped from stream.- Type Parameters:
T- The stream element typeK- The key typeV- The value type- Parameters:
stream- the source streamentryMapper- the entry mapper- Returns:
- A new Map
-
ofAll
public static <T,K,V> LinkedHashMap<K,V> ofAll(@NonNull java.util.stream.Stream<? extends T> stream, java.util.function.Function<? super T,? extends K> keyMapper, java.util.function.Function<? super T,? extends V> valueMapper)
Returns aLinkedHashMap, from entries mapped from stream.- Type Parameters:
T- The stream element typeK- The key typeV- The value type- Parameters:
stream- the source streamkeyMapper- the key mappervalueMapper- the value mapper- Returns:
- A new Map
-
of
public static <K,V> LinkedHashMap<K,V> of(K key, V value)
Returns a singletonLinkedHashMap, i.e. aLinkedHashMapof one element.- Type Parameters:
K- The key typeV- The value type- Parameters:
key- A singleton map key.value- A singleton map value.- Returns:
- A new Map containing the given entry
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3k4- a key for the mapv4- the value for k4- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3k4- a key for the mapv4- the value for k4k5- a key for the mapv5- the value for k5- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3k4- a key for the mapv4- the value for k4k5- a key for the mapv5- the value for k5k6- a key for the mapv6- the value for k6- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3k4- a key for the mapv4- the value for k4k5- a key for the mapv5- the value for k5k6- a key for the mapv6- the value for k6k7- a key for the mapv7- the value for k7- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3k4- a key for the mapv4- the value for k4k5- a key for the mapv5- the value for k5k6- a key for the mapv6- the value for k6k7- a key for the mapv7- the value for k7k8- a key for the mapv8- the value for k8- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3k4- a key for the mapv4- the value for k4k5- a key for the mapv5- the value for k5k6- a key for the mapv6- the value for k6k7- a key for the mapv7- the value for k7k8- a key for the mapv8- the value for k8k9- a key for the mapv9- the value for k9- Returns:
- A new Map containing the given entries
-
of
public static <K,V> LinkedHashMap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)
Creates a LinkedHashMap of the given list of key-value pairs.- Type Parameters:
K- The key typeV- The value type- Parameters:
k1- a key for the mapv1- the value for k1k2- a key for the mapv2- the value for k2k3- a key for the mapv3- the value for k3k4- a key for the mapv4- the value for k4k5- a key for the mapv5- the value for k5k6- a key for the mapv6- the value for k6k7- a key for the mapv7- the value for k7k8- a key for the mapv8- the value for k8k9- a key for the mapv9- the value for k9k10- a key for the mapv10- the value for k10- Returns:
- A new Map containing the given entries
-
tabulate
public static <K,V> LinkedHashMap<K,V> tabulate(int n, @NonNull java.util.function.Function<? super java.lang.Integer,? extends Tuple2<? extends K,? extends V>> f)
Returns a LinkedHashMap containingnvalues of a given Functionfover a range of integer values from 0 ton - 1.- Type Parameters:
K- The key typeV- The value type- Parameters:
n- The number of elements in the LinkedHashMapf- The Function computing element values- Returns:
- A LinkedHashMap consisting of elements
f(0),f(1), ..., f(n - 1) - Throws:
java.lang.NullPointerException- iffis null
-
fill
public static <K,V> LinkedHashMap<K,V> fill(int n, @NonNull java.util.function.Supplier<? extends Tuple2<? extends K,? extends V>> s)
Returns a LinkedHashMap containing tuples returned byncalls to a given Suppliers.- Type Parameters:
K- The key typeV- The value type- Parameters:
n- The number of elements in the LinkedHashMaps- The Supplier computing element values- Returns:
- A LinkedHashMap of size
n, where each element contains the result supplied bys. - Throws:
java.lang.NullPointerException- ifsis null
-
ofEntries
public static <K,V> LinkedHashMap<K,V> ofEntries(@NonNull java.util.Map.Entry<? extends K,? extends V> @NonNull ... entries)
Creates a LinkedHashMap of the given entries.- Type Parameters:
K- The key typeV- The value type- Parameters:
entries- Map entries- Returns:
- A new Map containing the given entries
-
ofEntries
public static <K,V> LinkedHashMap<K,V> ofEntries(@NonNull Tuple2<? extends K,? extends V> @NonNull ... entries)
Creates a LinkedHashMap of the given entries.- Type Parameters:
K- The key typeV- The value type- Parameters:
entries- Map entries- Returns:
- A new Map containing the given entries
-
ofEntries
public static <K,V> LinkedHashMap<K,V> ofEntries(@NonNull java.lang.Iterable<? extends Tuple2<? extends K,? extends V>> entries)
Creates a LinkedHashMap of the given entries.- Type Parameters:
K- The key typeV- The value type- Parameters:
entries- Map entries- Returns:
- A new Map containing the given entries
-
bimap
public <K2,V2> LinkedHashMap<K2,V2> bimap(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper, @NonNull java.util.function.Function<? super V,? extends V2> valueMapper)
Description copied from interface:MapMaps thisMapto a newMapwith different component type by applying a function to its elements.- Specified by:
bimapin interfaceMap<K,V>- Type Parameters:
K2- key's component type of the map resultV2- value's component type of the map result- Parameters:
keyMapper- aFunctionthat maps the keys of typeKto keys of typeK2valueMapper- aFunctionthat the values of typeVto values of typeV2- Returns:
- a new
Map
-
computeIfAbsent
public Tuple2<V,LinkedHashMap<K,V>> computeIfAbsent(K key, @NonNull java.util.function.Function<? super K,? extends V> mappingFunction)
Description copied from interface:MapIf the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.- Specified by:
computeIfAbsentin interfaceMap<K,V>- Parameters:
key- key whose presence in this map is to be testedmappingFunction- mapping function- Returns:
- the
Tuple2of current or modified map and existing or computed value associated with the specified key
-
computeIfPresent
public Tuple2<Option<V>,LinkedHashMap<K,V>> computeIfPresent(K key, @NonNull java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
Description copied from interface:MapIf the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.- Specified by:
computeIfPresentin interfaceMap<K,V>- Parameters:
key- key whose presence in this map is to be testedremappingFunction- remapping function- Returns:
- the
Tuple2of current or modified map and theSomeof the value associated with the specified key, orNoneif none
-
containsKey
public boolean containsKey(K key)
Description copied from interface:MapReturnstrueif this map contains a mapping for the specified key.- Specified by:
containsKeyin interfaceMap<K,V>- Parameters:
key- key whose presence in this map is to be tested- Returns:
trueif this map contains a mapping for the specified key
-
distinct
public LinkedHashMap<K,V> distinct()
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance with all duplicates removed. Element equality is determined usingequals.
-
distinctBy
public LinkedHashMap<K,V> distinctBy(@NonNull java.util.Comparator<? super Tuple2<K,V>> comparator)
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance without duplicates, as determined by the givencomparator.- Specified by:
distinctByin interfaceMap<K,V>- Specified by:
distinctByin interfaceTraversable<K>- Parameters:
comparator- a comparator used to determine equality of elements- Returns:
- a new
Traversablewith duplicates removed
-
distinctBy
public <U> LinkedHashMap<K,V> distinctBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance without duplicates, based on keys extracted from elements usingkeyExtractor.The first occurrence of each key is retained in the resulting sequence.
- Specified by:
distinctByin interfaceMap<K,V>- Specified by:
distinctByin interfaceTraversable<K>- Type Parameters:
U- the type of key- Parameters:
keyExtractor- a function to extract keys for determining uniqueness- Returns:
- a new
Traversablewith duplicates removed based on keys
-
drop
public LinkedHashMap<K,V> drop(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.
-
dropRight
public LinkedHashMap<K,V> dropRight(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.
-
dropUntil
public LinkedHashMap<K,V> dropUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableReturns a newTraversablestarting from the first element that satisfies the givenpredicate, dropping all preceding elements.
-
dropWhile
public LinkedHashMap<K,V> dropWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableReturns a newTraversablestarting from the first element that does not satisfy the givenpredicate, dropping all preceding elements.This is equivalent to
dropUntil(predicate.negate()), which is useful for method references that cannot be negated directly.
-
filter
public LinkedHashMap<K,V> filter(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)
Description copied from interface:MapReturns a new Map consisting of all elements which satisfy the given predicate.
-
reject
public LinkedHashMap<K,V> reject(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)
Description copied from interface:MapReturns a new Map consisting of all elements which do not satisfy the given predicate.
-
filter
public LinkedHashMap<K,V> filter(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableReturns a new traversable containing only the elements that satisfy the given predicate.
-
reject
public LinkedHashMap<K,V> reject(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableReturns a new traversable containing only the elements that do not satisfy the given predicate.This is equivalent to
filter(predicate.negate()).
-
filterKeys
public LinkedHashMap<K,V> filterKeys(@NonNull java.util.function.Predicate<? super K> predicate)
Description copied from interface:MapReturns a new Map consisting of all elements with keys which satisfy the given predicate.- Specified by:
filterKeysin interfaceMap<K,V>- Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Map
-
rejectKeys
public LinkedHashMap<K,V> rejectKeys(@NonNull java.util.function.Predicate<? super K> predicate)
Description copied from interface:MapReturns a new Map consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
rejectKeysin interfaceMap<K,V>- Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Map
-
filterValues
public LinkedHashMap<K,V> filterValues(@NonNull java.util.function.Predicate<? super V> predicate)
Description copied from interface:MapReturns a new Map consisting of all elements with values which satisfy the given predicate.- Specified by:
filterValuesin interfaceMap<K,V>- Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Map
-
rejectValues
public LinkedHashMap<K,V> rejectValues(@NonNull java.util.function.Predicate<? super V> predicate)
Description copied from interface:MapReturns a new Map consisting of all elements with values which do not satisfy the given predicate.- Specified by:
rejectValuesin interfaceMap<K,V>- Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Map
-
flatMap
public <K2,V2> LinkedHashMap<K2,V2> flatMap(@NonNull java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
Description copied from interface:MapFlatMaps thisMapto a newMapwith different component type.
-
get
public Option<V> get(K key)
Description copied from interface:MapReturns theSomeof value to which the specified key is mapped, orNoneif this map contains no mapping for the key.
-
getOrElse
public V getOrElse(K key, V defaultValue)
Description copied from interface:MapReturns the value associated with a key, or a default value if the key is not contained in the map.
-
groupBy
public <C> Map<C,LinkedHashMap<K,V>> groupBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)
Description copied from interface:TraversableGroups elements of thisTraversablebased on a classifier function.- Specified by:
groupByin interfaceMap<K,V>- Specified by:
groupByin interfaceTraversable<K>- Type Parameters:
C- The type of the group keys- Parameters:
classifier- A function that assigns each element to a group- Returns:
- A map where each key corresponds to a group of elements
- See Also:
Traversable.arrangeBy(Function)
-
grouped
public Iterator<LinkedHashMap<K,V>> grouped(int size)
Description copied from interface:TraversableSplits thisTraversableinto consecutive blocks of the given size.Let
lengthbe the number of elements in thisTraversable:- If empty, the resulting
Iteratoris empty. - If
size <= length, the resultingIteratorcontainslength / sizeblocks of sizesizeand possibly a final smaller block of sizelength % size. - If
size > length, the resultingIteratorcontains a single block of sizelength.
Examples:
[].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]]Note:
grouped(size)is equivalent tosliding(size, size). - If empty, the resulting
-
head
public Tuple2<K,V> head()
Description copied from interface:TraversableReturns the first element of this non-emptyTraversable.- Specified by:
headin interfaceTraversable<K>- Returns:
- the first element
-
init
public LinkedHashMap<K,V> init()
Description copied from interface:TraversableReturns all elements of this Traversable except the last one.This is the dual of
Traversable.tail().
-
initOption
public Option<LinkedHashMap<K,V>> initOption()
Description copied from interface:TraversableReturns all elements of this Traversable except the last one, wrapped in anOption.This is the dual of
Traversable.tailOption().- Specified by:
initOptionin interfaceMap<K,V>- Specified by:
initOptionin interfaceTraversable<K>- Returns:
Some(traversable)if non-empty, orNoneif this Traversable is empty
-
isAsync
public boolean isAsync()
AnLinkedHashMap's value is computed synchronously.
-
isEmpty
public boolean isEmpty()
Description copied from interface:TraversableChecks if this Traversable contains no elements.
-
isLazy
public boolean isLazy()
AnLinkedHashMap's value is computed eagerly.
-
isSequential
public boolean isSequential()
Description copied from interface:TraversableIndicates whether the elements of this Traversable appear in encounter (insertion) order.- Specified by:
isSequentialin interfaceTraversable<K>- Returns:
trueif insertion order is preserved,falseotherwise
-
iterator
public @NonNull Iterator<Tuple2<K,V>> iterator()
Description copied from interface:TraversableReturns an iterator over the elements of this Traversable, implemented viaTraversable.head()andTraversable.tail(). Subclasses may override for a more efficient implementation.
-
keySet
public Set<K> keySet()
Description copied from interface:MapReturns the keys contained in this map.
-
last
public Tuple2<K,V> last()
Description copied from interface:TraversableReturns the last element of this Traversable.- Specified by:
lastin interfaceTraversable<K>- Returns:
- the last element
-
map
public <K2,V2> LinkedHashMap<K2,V2> map(@NonNull java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Description copied from interface:MapMaps the entries of thisMapto form a newMap.
-
mapKeys
public <K2> LinkedHashMap<K2,V> mapKeys(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper)
Description copied from interface:MapMaps the keys of thisMapwhile preserving the corresponding values.The size of the result map may be smaller if
keyMappermaps two or more distinct keys to the same new key. In this case the value at thelatestof the original keys is retained. Order of keys is predictable inTreeMap(by comparator) andLinkedHashMap(insertion-order) and not predictable inHashMap.
-
mapKeys
public <K2> LinkedHashMap<K2,V> mapKeys(@NonNull java.util.function.Function<? super K,? extends K2> keyMapper, @NonNull java.util.function.BiFunction<? super V,? super V,? extends V> valueMerge)
Description copied from interface:MapMaps the keys of thisMapwhile preserving the corresponding values and applying a value merge function on collisions.The size of the result map may be smaller if
keyMappermaps two or more distinct keys to the same new key. In this case the associated values will be combined usingvalueMerge.
-
mapValues
public <W> LinkedHashMap<K,W> mapValues(@NonNull java.util.function.Function<? super V,? extends W> mapper)
Description copied from interface:MapMaps the values of thisMapwhile preserving the corresponding keys.
-
merge
public LinkedHashMap<K,V> merge(@NonNull Map<? extends K,? extends V> that)
Description copied from interface:MapCreates a new map which by merging the entries ofthismap andthatmap.If collisions occur, the value of
thismap is taken.
-
merge
public <U extends V> LinkedHashMap<K,V> merge(@NonNull Map<? extends K,U> that, @NonNull java.util.function.BiFunction<? super V,? super U,? extends V> collisionResolution)
Description copied from interface:MapCreates a new map which by merging the entries ofthismap andthatmap.Uses the specified collision resolution function if two keys are the same. The collision resolution function will always take the first argument from
thismap and the second fromthatmap.
-
orElse
public LinkedHashMap<K,V> orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Description copied from interface:TraversableReturns thisTraversableif it is non-empty; otherwise, returns the given alternative.
-
orElse
public LinkedHashMap<K,V> orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
Description copied from interface:TraversableReturns thisTraversableif it is non-empty; otherwise, returns the result of evaluating the given supplier.
-
partition
public Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>> partition(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableSplits thisTraversableinto two partitions according to a predicate.The first partition contains all elements that satisfy the predicate, and the second contains all elements that do not. The original iteration order is preserved.
-
peek
public LinkedHashMap<K,V> peek(@NonNull java.util.function.Consumer<? super Tuple2<K,V>> action)
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.
-
put
public <U extends V> LinkedHashMap<K,V> put(K key, U value, @NonNull java.util.function.BiFunction<? super V,? super U,? extends V> merge)
Description copied from interface:MapAssociates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the merge function is used to combine the previous value to the value to be inserted, and the result of that call is inserted in the map.- Specified by:
putin interfaceMap<K,V>- Type Parameters:
U- the value type- Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified keymerge- function taking the old and new values and merging them.- Returns:
- A new Map containing these elements and that entry.
-
put
public LinkedHashMap<K,V> put(K key, V value)
Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.Note that this method has a worst-case linear complexity.
-
put
public LinkedHashMap<K,V> put(@NonNull Tuple2<? extends K,? extends V> entry)
Description copied from interface:MapConvenience method forput(entry._1, entry._2).
-
put
public <U extends V> LinkedHashMap<K,V> put(@NonNull Tuple2<? extends K,U> entry, @NonNull java.util.function.BiFunction<? super V,? super U,? extends V> merge)
Description copied from interface:MapConvenience method forput(entry._1, entry._2, merge).
-
remove
public LinkedHashMap<K,V> remove(K key)
Description copied from interface:MapRemoves the mapping for a key from this map if it is present.
-
removeAll
@Deprecated public LinkedHashMap<K,V> removeAll(@NonNull java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.Description copied from interface:MapReturns a new Map consisting of all elements which do not satisfy the given predicate.
-
removeAll
public LinkedHashMap<K,V> removeAll(@NonNull java.lang.Iterable<? extends K> keys)
Description copied from interface:MapRemoves the mapping for a key from this map if it is present.
-
removeKeys
@Deprecated public LinkedHashMap<K,V> removeKeys(@NonNull java.util.function.Predicate<? super K> predicate)
Deprecated.Description copied from interface:MapReturns a new Map consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
removeKeysin interfaceMap<K,V>- Parameters:
predicate- the predicate used to test keys of elements- Returns:
- a new Map
-
removeValues
@Deprecated public LinkedHashMap<K,V> removeValues(@NonNull java.util.function.Predicate<? super V> predicate)
Deprecated.Description copied from interface:MapReturns a new Map consisting of all elements with values which do not satisfy the given predicate.- Specified by:
removeValuesin interfaceMap<K,V>- Parameters:
predicate- the predicate used to test values of elements- Returns:
- a new Map
-
replace
public LinkedHashMap<K,V> replace(@NonNull Tuple2<K,V> currentElement, @NonNull Tuple2<K,V> newElement)
Description copied from interface:TraversableReplaces the first occurrence ofcurrentElementwithnewElement, if it exists.
-
replaceAll
public LinkedHashMap<K,V> replaceAll(@NonNull Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Description copied from interface:TraversableReplaces all occurrences ofcurrentElementwithnewElement.- Specified by:
replaceAllin interfaceMap<K,V>- Specified by:
replaceAllin interfaceTraversable<K>- Parameters:
currentElement- the element to be replacednewElement- the replacement element- Returns:
- a new Traversable with all occurrences of
currentElementreplaced bynewElement
-
replaceValue
public LinkedHashMap<K,V> replaceValue(K key, V value)
Description copied from interface:MapReplaces the entry for the specified key only if it is currently mapped to some value.- Specified by:
replaceValuein interfaceMap<K,V>- Parameters:
key- the key of the element to be substituted.value- 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 LinkedHashMap<K,V> replace(K key, V oldValue, V newValue)
Description copied from interface:MapReplaces the entry for the specified key only if currently mapped to the specified value.- Specified by:
replacein interfaceMap<K,V>- Parameters:
key- the key of the element to be substituted.oldValue- the expected current value that the key is currently mapped tonewValue- 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 matched. The old map otherwise.
-
replaceAll
public LinkedHashMap<K,V> replaceAll(@NonNull java.util.function.BiFunction<? super K,? super V,? extends V> function)
Description copied from interface:MapReplaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception.- Specified by:
replaceAllin interfaceMap<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 LinkedHashMap<K,V> retainAll(@NonNull java.lang.Iterable<? extends Tuple2<K,V>> elements)
Description copied from interface:TraversableRetains only the elements from this Traversable that are contained in the givenelements.
-
scan
public LinkedHashMap<K,V> scan(@NonNull Tuple2<K,V> zero, @NonNull java.util.function.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 this Traversable.The neutral element
zeromay be applied more than once.
-
size
public int size()
Description copied from interface:TraversableReturns the number of elements in this Traversable.Alias for
Traversable.length().
-
slideBy
public Iterator<LinkedHashMap<K,V>> slideBy(@NonNull java.util.function.Function<? super Tuple2<K,V>,?> classifier)
Description copied from interface:TraversablePartitions thisTraversableinto consecutive non-overlapping windows according to a classification function.Each window contains elements with the same class, as determined by
classifier. Two consecutive elements belong to the same window only ifclassifierreturns equal values for both. Otherwise, the current window ends and a new window begins with the next element.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
public Iterator<LinkedHashMap<K,V>> sliding(int size)
Description copied from interface:TraversableSlides a window of a givensizeover thisTraversablewith a step size of 1.This is equivalent to calling
Traversable.sliding(int, int)with a step size of 1.
-
sliding
public Iterator<LinkedHashMap<K,V>> sliding(int size, int step)
Description copied from interface:TraversableSlides a window of a specificsizewith a givenstepover 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
public Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>> span(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableSplits thisTraversableinto a prefix and remainder according to the givenpredicate.The first element of the returned
Tupleis the longest prefix of elements satisfyingpredicate, and the second element is the remaining elements.
-
tail
public LinkedHashMap<K,V> tail()
Description copied from interface:TraversableReturns a newTraversablewithout its first element.
-
tailOption
public Option<LinkedHashMap<K,V>> tailOption()
Description copied from interface:TraversableReturns a newTraversablewithout its first element as anOption.- Specified by:
tailOptionin interfaceMap<K,V>- Specified by:
tailOptionin interfaceTraversable<K>- Returns:
Some(traversable)if non-empty, otherwiseNone
-
take
public LinkedHashMap<K,V> take(int n)
Description copied from interface:TraversableReturns the firstnelements of thisTraversable, or all elements ifnexceeds the length.Equivalent to
sublist(0, max(0, min(length(), n))), but safe forn < 0orn > length().If
n < 0, an empty instance is returned. Ifn > length(), the full instance is returned.
-
takeRight
public LinkedHashMap<K,V> takeRight(int n)
Description copied from interface:TraversableReturns the lastnelements of thisTraversable, or all elements ifnexceeds the length.Equivalent to
sublist(max(0, length() - n), length()), but safe forn < 0orn > length().If
n < 0, an empty instance is returned. Ifn > length(), the full instance is returned.
-
takeUntil
public LinkedHashMap<K,V> takeUntil(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableTakes elements from thisTraversableuntil the given predicate holds for an element.Equivalent to
takeWhile(predicate.negate()), but useful when using method references that cannot be negated directly.
-
takeWhile
public LinkedHashMap<K,V> takeWhile(@NonNull java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:TraversableTakes elements from thisTraversablewhile the given predicate holds.
-
toJavaMap
public java.util.LinkedHashMap<K,V> toJavaMap()
Description copied from interface:MapConverts this VavrMapto ajava.util.Mapwhile preserving characteristics like insertion order (LinkedHashMap) and sort order (SortedMap).
-
values
public Seq<V> values()
Description copied from interface:MapReturns a newSeqthat contains the values of thisMap.// = Seq("a", "b", "c") HashMap.of(1, "a", 2, "b", 3, "c").values()
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:TraversableDetermines whether this collection is equal to the given object.In Vavr, there are four basic collection types:
Seq– sequential elementsSet– distinct elementsMap– key-value pairsMultimap– keys mapped to multiple values
- They are of the same collection type (Seq, Set, Map, Multimap)
- They contain the same elements
- For
Seq, the element order is the same
For
MapandMultimap, two entries(key1, value1)and(key2, value2)are equal if both their keys and values are equal.Additional notes:
- No collection equals
null(e.g.,Queue(1) != null) - Null elements are allowed and treated as expected
(e.g.,
List(null, 1) == Stream(null, 1),HashMap((null,1)) == LinkedHashMap((null,1))) - Element order matters only for
Seq - Other collection classes are equal if their types and elements (in iteration order) are equal
- Iterators are compared by reference only
-
hashCode
public int hashCode()
Description copied from interface:TraversableReturns the hash code of this collection.Vavr distinguishes between collections with predictable iteration order (like
Seq) and collections with arbitrary iteration order (likeSet,Map, andMultimap). In all cases, the hash of an empty collection is defined as1.For collections with predictable iteration order, the hash is computed as:
int hash = 1; for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }For collections with arbitrary iteration order, the hash is computed to be independent of element order:
int hash = 1; for (T t : this) { hash += Objects.hashCode(t); }Note that these algorithms may change in future Vavr versions. Hash codes are generally not cached, unlike size/length, because caching would increase memory usage due to persistent tree-based structures. Computing the hash code is linear in time, O(n). For frequently re-used collections (e.g., as
HashMapkeys), caching can be done externally using a wrapper, for example:{@code public final class Hashed{ private final K key; private final Lazy hashCode; public Hashed(K key) { this.key = key; this.hashCode = Lazy.of(() -> Objects.hashCode(key)); } public K key() { return key; }
-
readResolve
private java.lang.Object readResolve()
-
stringPrefix
public java.lang.String 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
public java.lang.String toString()
Description copied from interface:ValueClarifies that values have a proper toString() method implemented.See Object.toString().
-
wrap
private static <K,V> LinkedHashMap<K,V> wrap(@NonNull Queue<Tuple2<K,V>> list, HashMap<K,V> map)
Construct Map with given values and key order.- Type Parameters:
K- The key typeV- The value type- Parameters:
list- The list of key-value tuples with unique keys.map- The map of key-value tuples.- Returns:
- A new Map containing the given map with given key order
-
wrapNonUnique
private static <K,V> LinkedHashMap<K,V> wrapNonUnique(@NonNull Queue<Tuple2<K,V>> list, HashMap<K,V> map)
Construct Map with given values and key order.- Type Parameters:
K- The key typeV- The value type- Parameters:
list- The list of key-value tuples with non-unique keys.map- The map of key-value tuples.- Returns:
- A new Map containing the given map with given key order
-
-