Class LinkedHashMap<K,V>
- java.lang.Object
-
- io.vavr.collection.LinkedHashMap<K,V>
-
- All Implemented Interfaces:
Foldable<Tuple2<K,V>>
,Map<K,V>
,Traversable<Tuple2<K,V>>
,Function1<K,V>
,Iterable<Tuple2<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 immutableLinkedHashMap
implementation that has predictable (insertion-order) iteration.- See Also:
- Serialized Form
-
-
Method Summary
Modifier and Type Method Description <K2,V2>
LinkedHashMap<K2,V2>bimap(java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.Function<? super V,? extends V2> valueMapper)
Maps thisMap
to a newMap
with 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 aCollector
which 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(java.util.function.Function<? super T,? extends K> keyMapper)
Returns aCollector
which 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 aCollector
which may be used in conjunction withStream.collect(java.util.stream.Collector)
to obtain aLinkedHashMap
.Tuple2<V,LinkedHashMap<K,V>>
computeIfAbsent(K key, 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, 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.boolean
containsKey(K key)
Returnstrue
if this map contains a mapping for the specified key.LinkedHashMap<K,V>
distinct()
Returns a new version of this which contains no duplicates.LinkedHashMap<K,V>
distinctBy(java.util.Comparator<? super Tuple2<K,V>> comparator)
Returns a new version of this which contains no duplicates.<U> LinkedHashMap<K,V>
distinctBy(java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.LinkedHashMap<K,V>
drop(int n)
Drops the first n elements of this or all elements, if this length < n.LinkedHashMap<K,V>
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.LinkedHashMap<K,V>
dropUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements until the predicate holds for the current element.LinkedHashMap<K,V>
dropWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements while the predicate holds for the current element.static <K,V>
LinkedHashMap<K,V>empty()
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.static <K,V>
LinkedHashMap<K,V>fill(int n, java.util.function.Supplier<? extends Tuple2<? extends K,? extends V>> s)
Returns a LinkedHashMap containing tuples returned byn
calls to a given Suppliers
.LinkedHashMap<K,V>
filter(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(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.LinkedHashMap<K,V>
filterKeys(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>
filterNot(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>
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.LinkedHashMap<K,V>
filterNotKeys(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>
filterNotValues(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>
filterValues(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(java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
FlatMaps thisMap
to a newMap
with different component type.Option<V>
get(K key)
Returns theSome
of value to which the specified key is mapped, orNone
if this map contains no mapping for the key.V
getOrElse(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(java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)
Groups this elements by classifying the elements.Iterator<LinkedHashMap<K,V>>
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.LinkedHashMap<K,V>
init()
Dual of Traversable.tail(), returning all elements except the last.Option<LinkedHashMap<K,V>>
initOption()
Dual of Traversable.tailOption(), returning all elements except the last asOption
.boolean
isAsync()
AnLinkedHashMap
's value is computed synchronously.boolean
isEmpty()
Checks if this Traversable is empty.boolean
isLazy()
AnLinkedHashMap
's value is computed eagerly.boolean
isSequential()
Checks if the elements of this Traversable appear in encounter order.Iterator<Tuple2<K,V>>
iterator()
An iterator by means of head() and tail().Set<K>
keySet()
Returns the keys contained in this map.Tuple2<K,V>
last()
Dual of Traversable.head(), returning the last element.<K2,V2>
LinkedHashMap<K2,V2>map(java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Maps the entries of thisMap
to form a newMap
.<K2> LinkedHashMap<K2,V>
mapKeys(java.util.function.Function<? super K,? extends K2> keyMapper)
Maps the keys of thisMap
while preserving the corresponding values.<K2> LinkedHashMap<K2,V>
mapKeys(java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.BiFunction<? super V,? super V,? extends V> valueMerge)
Maps the keys of thisMap
while preserving the corresponding values and applying a value merge function on collisions.<W> LinkedHashMap<K,W>
mapValues(java.util.function.Function<? super V,? extends W> mapper)
Maps the values of thisMap
while preserving the corresponding keys.LinkedHashMap<K,V>
merge(Map<? extends K,? extends V> that)
Creates a new map which by merging the entries ofthis
map andthat
map.<U extends V>
LinkedHashMap<K,V>merge(Map<? extends K,U> that, java.util.function.BiFunction<? super V,? super U,? extends V> collisionResolution)
Creates a new map which by merging the entries ofthis
map andthat
map.static <K,V>
LinkedHashMap<K,V>narrow(LinkedHashMap<? extends K,? extends V> linkedHashMap)
Narrows a widenedLinkedHashMap<? extends K, ? extends V>
toLinkedHashMap<K, V>
by performing a type-safe cast.static <K,V>
LinkedHashMap<K,V>of(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(java.util.Map<? extends K,? extends V> map)
Returns aLinkedHashMap
, from a source java.util.Map.static <T,K,V>
LinkedHashMap<K,V>ofAll(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(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(Tuple2<? extends K,? extends V>... entries)
Creates a LinkedHashMap of the given entries.static <K,V>
LinkedHashMap<K,V>ofEntries(java.lang.Iterable<? extends Tuple2<? extends K,? extends V>> entries)
Creates a LinkedHashMap of the given entries.static <K,V>
LinkedHashMap<K,V>ofEntries(java.util.Map.Entry<? extends K,? extends V>... entries)
Creates a LinkedHashMap of the given entries.LinkedHashMap<K,V>
orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Returns thisTraversable
if it is nonempty, otherwise return the alternative.LinkedHashMap<K,V>
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>>
partition(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.LinkedHashMap<K,V>
peek(java.util.function.Consumer<? super Tuple2<K,V>> action)
Performs the givenaction
on the first element if this is an eager implementation.LinkedHashMap<K,V>
put(Tuple2<? extends K,? extends V> entry)
Convenience method forput(entry._1, entry._2)
.<U extends V>
LinkedHashMap<K,V>put(Tuple2<? extends K,U> entry, 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, 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.LinkedHashMap<K,V>
reject(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.LinkedHashMap<K,V>
reject(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Deprecated.LinkedHashMap<K,V>
rejectKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.LinkedHashMap<K,V>
rejectValues(java.util.function.Predicate<? super V> predicate)
Deprecated.LinkedHashMap<K,V>
remove(K key)
Removes the mapping for a key from this map if it is present.LinkedHashMap<K,V>
removeAll(java.lang.Iterable<? extends K> keys)
Removes the mapping for a key from this map if it is present.LinkedHashMap<K,V>
removeAll(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.LinkedHashMap<K,V>
removeKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.LinkedHashMap<K,V>
removeValues(java.util.function.Predicate<? super V> predicate)
Deprecated.LinkedHashMap<K,V>
replace(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.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(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces all occurrences of the given currentElement with newElement.LinkedHashMap<K,V>
replaceAll(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(java.lang.Iterable<? extends Tuple2<K,V>> elements)
Keeps all occurrences of the given elements from this.LinkedHashMap<K,V>
scan(Tuple2<K,V> zero, java.util.function.BiFunction<? super Tuple2<K,V>,? super Tuple2<K,V>,? extends Tuple2<K,V>> operation)
Computes a prefix scan of the elements of the collection.int
size()
Computes the number of elements of this Traversable.Iterator<LinkedHashMap<K,V>>
slideBy(java.util.function.Function<? super Tuple2<K,V>,?> classifier)
Slides a non-overlapping window of a variable size over thisTraversable
.Iterator<LinkedHashMap<K,V>>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.Iterator<LinkedHashMap<K,V>>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>>
span(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder.java.lang.String
stringPrefix()
Returns the name of this Value type, which is used by toString().static <K,V>
LinkedHashMap<K,V>tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends Tuple2<? extends K,? extends V>> f)
Returns a LinkedHashMap containingn
values of a given Functionf
over a range of integer values from 0 ton - 1
.LinkedHashMap<K,V>
tail()
Drops the first element of a non-empty Traversable.Option<LinkedHashMap<K,V>>
tailOption()
Drops the first element of a non-empty Traversable and returns anOption
.LinkedHashMap<K,V>
take(int n)
Takes the first n elements of this or all elements, if this length < n.LinkedHashMap<K,V>
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.LinkedHashMap<K,V>
takeUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Takes elements until the predicate holds for the current element.LinkedHashMap<K,V>
takeWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Takes elements while the predicate holds for the current element.java.util.LinkedHashMap<K,V>
toJavaMap()
Converts this VavrMap
to ajava.util.Map
while preserving characteristics like insertion order (LinkedHashMap
) and sort order (SortedMap
).java.lang.String
toString()
Clarifies that values have a proper toString() method implemented.Seq<V>
values()
Returns a newSeq
that contains the values of thisMap
.-
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.Map
apply, asPartialFunction, collect, contains, containsValue, flatMap, foldRight, forEach, hasDefiniteSize, isDefinedAt, isDistinct, isTraversableAgain, iterator, keysIterator, length, lift, map, 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, fold, foldLeft, forEachWithIndex, get, headOption, isOrdered, 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
-
-
-
-
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 aCollector
which 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
LinkedHashMap
Collector.
-
collector
public static <K,V,T extends V> java.util.stream.Collector<T,java.util.ArrayList<T>,LinkedHashMap<K,V>> collector(java.util.function.Function<? super T,? extends K> keyMapper)
Returns aCollector
which may be used in conjunction withStream.collect(java.util.stream.Collector)
to obtain aLinkedHashMap
.- Type Parameters:
K
- The key typeV
- The value typeT
- InitialStream
elements type- Parameters:
keyMapper
- The key mapper- Returns:
- A
LinkedHashMap
Collector.
-
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 aCollector
which may be used in conjunction withStream.collect(java.util.stream.Collector)
to obtain aLinkedHashMap
.- Type Parameters:
K
- The key typeV
- The value typeT
- InitialStream
elements type- Parameters:
keyMapper
- The key mappervalueMapper
- The value mapper- Returns:
- A
LinkedHashMap
Collector.
-
empty
public static <K,V> LinkedHashMap<K,V> empty()
-
narrow
public static <K,V> LinkedHashMap<K,V> narrow(LinkedHashMap<? extends K,? extends V> linkedHashMap)
Narrows a widenedLinkedHashMap<? extends K, ? extends V>
toLinkedHashMap<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:
linkedHashMap
- ALinkedHashMap
.- Returns:
- the given
linkedHashMap
instance as narrowed typeLinkedHashMap<K, V>
.
-
of
public static <K,V> LinkedHashMap<K,V> of(Tuple2<? extends K,? extends V> entry)
Returns a singletonLinkedHashMap
, i.e. aLinkedHashMap
of 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(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(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(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. aLinkedHashMap
of 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, java.util.function.Function<? super java.lang.Integer,? extends Tuple2<? extends K,? extends V>> f)
Returns a LinkedHashMap containingn
values of a given Functionf
over 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
- iff
is null
-
fill
public static <K,V> LinkedHashMap<K,V> fill(int n, java.util.function.Supplier<? extends Tuple2<? extends K,? extends V>> s)
Returns a LinkedHashMap containing tuples returned byn
calls 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
- ifs
is null
-
ofEntries
public static <K,V> LinkedHashMap<K,V> ofEntries(java.util.Map.Entry<? 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
-
ofEntries
public static <K,V> LinkedHashMap<K,V> ofEntries(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
-
ofEntries
public static <K,V> LinkedHashMap<K,V> ofEntries(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(java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.Function<? super V,? extends V2> valueMapper)
Description copied from interface:Map
Maps thisMap
to a newMap
with different component type by applying a function to its elements.- Specified by:
bimap
in interfaceMap<K,V>
- Type Parameters:
K2
- key's component type of the map resultV2
- value's component type of the map 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
Map
-
computeIfAbsent
public Tuple2<V,LinkedHashMap<K,V>> computeIfAbsent(K key, java.util.function.Function<? super K,? extends V> mappingFunction)
Description copied from interface:Map
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.- Specified by:
computeIfAbsent
in interfaceMap<K,V>
- Parameters:
key
- key whose presence in this map is to be testedmappingFunction
- mapping function- Returns:
- the
Tuple2
of 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, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
Description copied from interface:Map
If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.- Specified by:
computeIfPresent
in interfaceMap<K,V>
- Parameters:
key
- key whose presence in this map is to be testedremappingFunction
- remapping function- Returns:
- the
Tuple2
of current or modified map and theSome
of the value associated with the specified key, orNone
if none
-
containsKey
public boolean containsKey(K key)
Description copied from interface:Map
Returnstrue
if this map contains a mapping for the specified key.- Specified by:
containsKey
in interfaceMap<K,V>
- Parameters:
key
- key whose presence in this map is to be tested- Returns:
true
if this map contains a mapping for the specified key
-
distinct
public LinkedHashMap<K,V> distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.
-
distinctBy
public LinkedHashMap<K,V> distinctBy(java.util.Comparator<? super Tuple2<K,V>> comparator)
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared using the givencomparator
.- Specified by:
distinctBy
in interfaceMap<K,V>
- Specified by:
distinctBy
in interfaceTraversable<K>
- Parameters:
comparator
- A comparator- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
public <U> LinkedHashMap<K,V> distinctBy(java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared usingequals
.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctBy
in interfaceMap<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 LinkedHashMap<K,V> drop(int n)
Description copied from interface:Traversable
Drops the first n elements of this or all elements, if this length < n.
-
dropRight
public LinkedHashMap<K,V> dropRight(int n)
Description copied from interface:Traversable
Drops the last n elements of this or all elements, if this length < n.
-
dropUntil
public LinkedHashMap<K,V> dropUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Drops elements until the predicate holds for the current element.
-
dropWhile
public LinkedHashMap<K,V> dropWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Drops elements while the predicate holds for the current element.Note: This is essentially the same as
dropUntil(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly.
-
filter
public LinkedHashMap<K,V> filter(java.util.function.BiPredicate<? super K,? super V> predicate)
Description copied from interface:Map
Returns a new Map consisting of all elements which satisfy the given predicate.
-
filterNot
public LinkedHashMap<K,V> filterNot(java.util.function.BiPredicate<? super K,? super V> predicate)
Description copied from interface:Map
Returns a new Map consisting of all elements which do not satisfy the given predicate.
-
reject
@Deprecated public LinkedHashMap<K,V> reject(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.Description copied from interface:Map
Returns a new Map consisting of all elements which do not satisfy the given predicate.
-
filter
public LinkedHashMap<K,V> filter(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which satisfy the given predicate.
-
filterNot
public LinkedHashMap<K,V> filterNot(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate()
-
reject
@Deprecated public LinkedHashMap<K,V> reject(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Deprecated.Description copied from interface:Traversable
Returns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate()
-
filterKeys
public LinkedHashMap<K,V> filterKeys(java.util.function.Predicate<? super K> predicate)
Description copied from interface:Map
Returns a new Map consisting of all elements with keys which satisfy the given predicate.- Specified by:
filterKeys
in interfaceMap<K,V>
- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Map
-
filterNotKeys
public LinkedHashMap<K,V> filterNotKeys(java.util.function.Predicate<? super K> predicate)
Description copied from interface:Map
Returns a new Map consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
filterNotKeys
in interfaceMap<K,V>
- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Map
-
rejectKeys
@Deprecated public LinkedHashMap<K,V> rejectKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.Description copied from interface:Map
Returns a new Map consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
rejectKeys
in interfaceMap<K,V>
- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Map
-
filterValues
public LinkedHashMap<K,V> filterValues(java.util.function.Predicate<? super V> predicate)
Description copied from interface:Map
Returns a new Map consisting of all elements with values which satisfy the given predicate.- Specified by:
filterValues
in interfaceMap<K,V>
- Parameters:
predicate
- the predicate used to test values of elements- Returns:
- a new Map
-
filterNotValues
public LinkedHashMap<K,V> filterNotValues(java.util.function.Predicate<? super V> predicate)
Description copied from interface:Map
Returns a new Map consisting of all elements with values which do not satisfy the given predicate.- Specified by:
filterNotValues
in interfaceMap<K,V>
- Parameters:
predicate
- the predicate used to test values of elements- Returns:
- a new Map
-
rejectValues
@Deprecated public LinkedHashMap<K,V> rejectValues(java.util.function.Predicate<? super V> predicate)
Deprecated.Description copied from interface:Map
Returns a new Map consisting of all elements with values which do not satisfy the given predicate.- Specified by:
rejectValues
in 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(java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
Description copied from interface:Map
FlatMaps thisMap
to a newMap
with different component type.
-
get
public Option<V> get(K key)
Description copied from interface:Map
Returns theSome
of value to which the specified key is mapped, orNone
if this map contains no mapping for the key.
-
getOrElse
public V getOrElse(K key, V defaultValue)
Description copied from interface:Map
Returns 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(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 interfaceMap<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<LinkedHashMap<K,V>> grouped(int size)
Description copied from interface:Traversable
Groups thisTraversable
into fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty()
, the resultingIterator
is empty. - If
size <= length
, the resultingIterator
will containlength / size
blocks of sizesize
and maybe a non-empty block of sizelength % size
, if there are remaining elements. - If
size > length
, the resultingIterator
will contain one block of sizelength
.
[].grouped(1) = [] [].grouped(0) throws [].grouped(-1) throws [1,2,3,4].grouped(2) = [[1,2],[3,4]] [1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]] [1,2,3,4].grouped(5) = [[1,2,3,4]]
grouped(int)
is a special case of Traversable.sliding(int, int), i.e.grouped(size)
is the same assliding(size, size)
. - If
-
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.
-
init
public LinkedHashMap<K,V> init()
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last.
-
initOption
public Option<LinkedHashMap<K,V>> initOption()
Description copied from interface:Traversable
Dual of Traversable.tailOption(), returning all elements except the last asOption
.- Specified by:
initOption
in interfaceMap<K,V>
- Specified by:
initOption
in interfaceTraversable<K>
- Returns:
Some(traversable)
orNone
if this is empty.
-
isAsync
public boolean isAsync()
AnLinkedHashMap
's value is computed synchronously.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Traversable
Checks if this Traversable is empty.
-
isLazy
public boolean isLazy()
AnLinkedHashMap
's value is computed eagerly.
-
isSequential
public boolean isSequential()
Description copied from interface:Traversable
Checks if the elements of this Traversable appear in encounter order.- Specified by:
isSequential
in interfaceTraversable<K>
- Returns:
- true, if the insertion order of elements is preserved, false otherwise.
-
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 interfaceMap<K,V>
- Specified by:
iterator
in interfaceTraversable<K>
- Specified by:
iterator
in interfaceValue<K>
- Returns:
- A new Iterator of this Traversable elements.
-
keySet
public Set<K> keySet()
Description copied from interface:Map
Returns the keys contained in this map.
-
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.
-
map
public <K2,V2> LinkedHashMap<K2,V2> map(java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Description copied from interface:Map
Maps the entries of thisMap
to form a newMap
.
-
mapKeys
public <K2> LinkedHashMap<K2,V> mapKeys(java.util.function.Function<? super K,? extends K2> keyMapper)
Description copied from interface:Map
Maps the keys of thisMap
while preserving the corresponding values.The size of the result map may be smaller if
keyMapper
maps two or more distinct keys to the same new key. In this case the value at thelatest
of 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(java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.BiFunction<? super V,? super V,? extends V> valueMerge)
Description copied from interface:Map
Maps the keys of thisMap
while preserving the corresponding values and applying a value merge function on collisions.The size of the result map may be smaller if
keyMapper
maps 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(java.util.function.Function<? super V,? extends W> mapper)
Description copied from interface:Map
Maps the values of thisMap
while preserving the corresponding keys.
-
merge
public LinkedHashMap<K,V> merge(Map<? extends K,? extends V> that)
Description copied from interface:Map
Creates a new map which by merging the entries ofthis
map andthat
map.If collisions occur, the value of
this
map is taken.
-
merge
public <U extends V> LinkedHashMap<K,V> merge(Map<? extends K,U> that, java.util.function.BiFunction<? super V,? super U,? extends V> collisionResolution)
Description copied from interface:Map
Creates a new map which by merging the entries ofthis
map andthat
map.Uses the specified collision resolution function if two keys are the same. The collision resolution function will always take the first argument from
this
map and the second fromthat
map.
-
orElse
public LinkedHashMap<K,V> orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the alternative.
-
orElse
public LinkedHashMap<K,V> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.
-
partition
public Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>> partition(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partition
in interfaceMap<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 LinkedHashMap<K,V> peek(java.util.function.Consumer<? super Tuple2<K,V>> action)
Description copied from interface:Value
Performs the givenaction
on the first element if this is an eager implementation. Performs the givenaction
on all elements (the first immediately, successive deferred), if this is a lazy implementation.
-
put
public <U extends V> LinkedHashMap<K,V> put(K key, U value, java.util.function.BiFunction<? super V,? super U,? extends V> merge)
Description copied from interface:Map
Associates 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:
put
in 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(Tuple2<? extends K,? extends V> entry)
Description copied from interface:Map
Convenience method forput(entry._1, entry._2)
.
-
put
public <U extends V> LinkedHashMap<K,V> put(Tuple2<? extends K,U> entry, java.util.function.BiFunction<? super V,? super U,? extends V> merge)
Description copied from interface:Map
Convenience method forput(entry._1, entry._2, merge)
.
-
remove
public LinkedHashMap<K,V> remove(K key)
Description copied from interface:Map
Removes the mapping for a key from this map if it is present.
-
removeAll
@Deprecated public LinkedHashMap<K,V> removeAll(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.Description copied from interface:Map
Returns a new Map consisting of all elements which do not satisfy the given predicate.
-
removeAll
public LinkedHashMap<K,V> removeAll(java.lang.Iterable<? extends K> keys)
Description copied from interface:Map
Removes the mapping for a key from this map if it is present.
-
removeKeys
@Deprecated public LinkedHashMap<K,V> removeKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.Description copied from interface:Map
Returns a new Map consisting of all elements with keys which do not satisfy the given predicate.- Specified by:
removeKeys
in interfaceMap<K,V>
- Parameters:
predicate
- the predicate used to test keys of elements- Returns:
- a new Map
-
removeValues
@Deprecated public LinkedHashMap<K,V> removeValues(java.util.function.Predicate<? super V> predicate)
Deprecated.Description copied from interface:Map
Returns a new Map consisting of all elements with values which do not satisfy the given predicate.- Specified by:
removeValues
in interfaceMap<K,V>
- Parameters:
predicate
- the predicate used to test values of elements- Returns:
- a new Map
-
replace
public LinkedHashMap<K,V> replace(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Description copied from interface:Traversable
Replaces the first occurrence (if exists) of the given currentElement with newElement.- Specified by:
replace
in interfaceMap<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 LinkedHashMap<K,V> replaceAll(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Description copied from interface:Traversable
Replaces all occurrences of the given currentElement with newElement.- Specified by:
replaceAll
in interfaceMap<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 LinkedHashMap<K,V> replaceValue(K key, V value)
Description copied from interface:Map
Replaces the entry for the specified key only if it is currently mapped to some value.- Specified by:
replaceValue
in 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:Map
Replaces the entry for the specified key only if currently mapped to the specified value.- Specified by:
replace
in 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(java.util.function.BiFunction<? super K,? super V,? extends V> function)
Description copied from interface:Map
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.- Specified by:
replaceAll
in 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(java.lang.Iterable<? extends Tuple2<K,V>> elements)
Description copied from interface:Traversable
Keeps all occurrences of the given elements from this.
-
scan
public LinkedHashMap<K,V> scan(Tuple2<K,V> zero, java.util.function.BiFunction<? super Tuple2<K,V>,? super Tuple2<K,V>,? extends Tuple2<K,V>> operation)
Description copied from interface:Traversable
Computes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scan
in interfaceMap<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
-
size
public int size()
Description copied from interface:Traversable
Computes the number of elements of this Traversable.Same as
Traversable.length()
.
-
slideBy
public Iterator<LinkedHashMap<K,V>> slideBy(java.util.function.Function<? super Tuple2<K,V>,?> classifier)
Description copied from interface:Traversable
Slides a non-overlapping window of a variable size over thisTraversable
.Each window contains elements with the same class, as determined by
classifier
. Two consecutive values in thisTraversable
will be in the same window only ifclassifier
returns equal values for them. Otherwise, the values will constitute the last element of the previous window and the first element of the next window.Examples:
[].slideBy(Function.identity()) = [] [1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]] [1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
-
sliding
public Iterator<LinkedHashMap<K,V>> sliding(int size)
Description copied from interface:Traversable
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.
-
sliding
public Iterator<LinkedHashMap<K,V>> sliding(int size, int step)
Description copied from interface:Traversable
Slides a window of a specificsize
andstep
size over thisTraversable
.Examples:
[].sliding(1,1) = [] [1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]] [1,2,3,4,5].sliding(2,4) = [[1,2],[5]] [1,2,3,4,5].sliding(2,5) = [[1,2]] [1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]]
-
span
public Tuple2<LinkedHashMap<K,V>,LinkedHashMap<K,V>> span(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder.
-
tail
public LinkedHashMap<K,V> tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.
-
tailOption
public Option<LinkedHashMap<K,V>> tailOption()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable and returns anOption
.- Specified by:
tailOption
in interfaceMap<K,V>
- Specified by:
tailOption
in interfaceTraversable<K>
- Returns:
Some(traversable)
orNone
if this is empty.
-
take
public LinkedHashMap<K,V> take(int n)
Description copied from interface:Traversable
Takes the first n elements of this or all elements, if this length < n.The result is equivalent to
sublist(0, max(0, min(length(), n)))
but does not throw ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.
-
takeRight
public LinkedHashMap<K,V> takeRight(int n)
Description copied from interface:Traversable
Takes the last n elements of this or all elements, if this length < n.The result is equivalent to
sublist(max(0, min(length(), length() - n)), n)
, i.e. takeRight will not throw ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.
-
takeUntil
public LinkedHashMap<K,V> takeUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Takes elements until the predicate holds for the current element.Note: This is essentially the same as
takeWhile(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly.
-
takeWhile
public LinkedHashMap<K,V> takeWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Description copied from interface:Traversable
Takes elements while the predicate holds for the current element.
-
toJavaMap
public java.util.LinkedHashMap<K,V> toJavaMap()
Description copied from interface:Map
Converts this VavrMap
to ajava.util.Map
while preserving characteristics like insertion order (LinkedHashMap
) and sort order (SortedMap
).
-
values
public Seq<V> values()
Description copied from interface:Map
Returns a newSeq
that 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: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.
-
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()) + ")"; } }
-
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().
-
-