Interface SortedMap<K,V>
-
- Type Parameters:
K
- Key typeV
- Value type
- All Superinterfaces:
Foldable<Tuple2<K,V>>
,java.util.function.Function<K,V>
,Function1<K,V>
,Iterable<Tuple2<K,V>>
,java.lang.Iterable<Tuple2<K,V>>
,Map<K,V>
,Ordered<K>
,PartialFunction<K,V>
,java.io.Serializable
,Traversable<Tuple2<K,V>>
,Value<Tuple2<K,V>>
- All Known Implementing Classes:
TreeMap
public interface SortedMap<K,V> extends Map<K,V>, Ordered<K>
An immutableSortedMap
interface.
-
-
Field Summary
Fields Modifier and Type Field Description static long
serialVersionUID
-
Method Summary
Modifier and Type Method Description <K2,V2>
SortedMap<K2,V2>bimap(java.util.Comparator<? super K2> keyComparator, java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.Function<? super V,? extends V2> valueMapper)
Same asbimap(Function, Function)
, using a specific comparator for keys of the codomain of the givenkeyMapper
.<K2,V2>
SortedMap<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.Tuple2<V,? extends SortedMap<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>,? extends SortedMap<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.SortedMap<K,V>
distinct()
Returns a new version of this which contains no duplicates.SortedMap<K,V>
distinctBy(java.util.Comparator<? super Tuple2<K,V>> comparator)
Returns a new version of this which contains no duplicates.<U> SortedMap<K,V>
distinctBy(java.util.function.Function<? super Tuple2<K,V>,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.SortedMap<K,V>
drop(int n)
Drops the first n elements of this or all elements, if this length < n.SortedMap<K,V>
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.SortedMap<K,V>
dropUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements until the predicate holds for the current element.SortedMap<K,V>
dropWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Drops elements while the predicate holds for the current element.SortedMap<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.SortedMap<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.SortedMap<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.SortedMap<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.SortedMap<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.SortedMap<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.SortedMap<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.SortedMap<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>
SortedMap<K2,V2>flatMap(java.util.Comparator<? super K2> keyComparator, java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
Same asflatMap(BiFunction)
but using a specific comparator for values of the codomain of the givenmapper
.<K2,V2>
SortedMap<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.<C> Map<C,? extends SortedMap<K,V>>
groupBy(java.util.function.Function<? super Tuple2<K,V>,? extends C> classifier)
Groups this elements by classifying the elements.Iterator<? extends SortedMap<K,V>>
grouped(int size)
Groups thisTraversable
into fixed size blocks.SortedMap<K,V>
init()
Dual of Traversable.tail(), returning all elements except the last.Option<? extends SortedMap<K,V>>
initOption()
Dual of Traversable.tailOption(), returning all elements except the last asOption
.default boolean
isOrdered()
Checks if this Traversable is orderedSortedSet<K>
keySet()
Returns the keys contained in this map.default Tuple2<K,V>
last()
Dual of Traversable.head(), returning the last element.<K2,V2>
SortedMap<K2,V2>map(java.util.Comparator<? super K2> keyComparator, java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Same asmap(BiFunction)
, using a specific comparator for keys of the codomain of the givenmapper
.<K2,V2>
SortedMap<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> SortedMap<K2,V>
mapKeys(java.util.function.Function<? super K,? extends K2> keyMapper)
Maps the keys of thisMap
while preserving the corresponding values.<K2> SortedMap<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.<V2> SortedMap<K,V2>
mapValues(java.util.function.Function<? super V,? extends V2> valueMapper)
Maps the values of thisMap
while preserving the corresponding keys.SortedMap<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>
SortedMap<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>
SortedMap<K,V>narrow(SortedMap<? extends K,? extends V> sortedMap)
Narrows a widenedSortedMap<? extends K, ? extends V>
toSortedMap<K, V>
by performing a type-safe cast.SortedMap<K,V>
orElse(java.lang.Iterable<? extends Tuple2<K,V>> other)
Returns thisTraversable
if it is nonempty, otherwise return the alternative.SortedMap<K,V>
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends Tuple2<K,V>>> supplier)
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.Tuple2<? extends SortedMap<K,V>,? extends SortedMap<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.SortedMap<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.SortedMap<K,V>
put(Tuple2<? extends K,? extends V> entry)
Convenience method forput(entry._1, entry._2)
.<U extends V>
SortedMap<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>
SortedMap<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.SortedMap<K,V>
put(K key, V value)
Associates the specified value with the specified key in this map.SortedMap<K,V>
reject(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.SortedMap<K,V>
reject(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Deprecated.SortedMap<K,V>
rejectKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.SortedMap<K,V>
rejectValues(java.util.function.Predicate<? super V> predicate)
Deprecated.SortedMap<K,V>
remove(K key)
Removes the mapping for a key from this map if it is present.SortedMap<K,V>
removeAll(java.lang.Iterable<? extends K> keys)
Removes the mapping for a key from this map if it is present.SortedMap<K,V>
removeAll(java.util.function.BiPredicate<? super K,? super V> predicate)
Deprecated.SortedMap<K,V>
removeKeys(java.util.function.Predicate<? super K> predicate)
Deprecated.SortedMap<K,V>
removeValues(java.util.function.Predicate<? super V> predicate)
Deprecated.SortedMap<K,V>
replace(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.SortedMap<K,V>
replace(K key, V oldValue, V newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.SortedMap<K,V>
replaceAll(Tuple2<K,V> currentElement, Tuple2<K,V> newElement)
Replaces all occurrences of the given currentElement with newElement.SortedMap<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.SortedMap<K,V>
replaceValue(K key, V value)
Replaces the entry for the specified key only if it is currently mapped to some value.SortedMap<K,V>
retainAll(java.lang.Iterable<? extends Tuple2<K,V>> elements)
Keeps all occurrences of the given elements from this.SortedMap<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.Iterator<? extends SortedMap<K,V>>
slideBy(java.util.function.Function<? super Tuple2<K,V>,?> classifier)
Slides a non-overlapping window of a variable size over thisTraversable
.Iterator<? extends SortedMap<K,V>>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.Iterator<? extends SortedMap<K,V>>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.Tuple2<? extends SortedMap<K,V>,? extends SortedMap<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.SortedMap<K,V>
tail()
Drops the first element of a non-empty Traversable.Option<? extends SortedMap<K,V>>
tailOption()
Drops the first element of a non-empty Traversable and returns anOption
.SortedMap<K,V>
take(int n)
Takes the first n elements of this or all elements, if this length < n.SortedMap<K,V>
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.SortedMap<K,V>
takeUntil(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Takes elements until the predicate holds for the current element.SortedMap<K,V>
takeWhile(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
Takes elements while the predicate holds for the current element.java.util.SortedMap<K,V>
toJavaMap()
Converts this VavrMap
to ajava.util.Map
while preserving characteristics like insertion order (LinkedHashMap
) and sort order (SortedMap
).-
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, containsKey, containsValue, flatMap, foldRight, forEach, get, getOrElse, hasDefiniteSize, isDefinedAt, isDistinct, isTraversableAgain, iterator, iterator, keysIterator, length, lift, map, scanLeft, scanRight, size, transform, unzip, unzip, unzip, unzip3, unzip3, values, valuesIterator, withDefault, withDefaultValue, zip, zipAll, zipWith, zipWithIndex, zipWithIndex
-
Methods inherited from interface io.vavr.collection.Ordered
comparator
-
Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, fold, foldLeft, forEachWithIndex, get, hashCode, head, headOption, isEmpty, isSequential, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduce, reduceLeft, reduceLeftOption, reduceOption, reduceRight, reduceRightOption, single, singleOption, spliterator, sum
-
Methods inherited from interface io.vavr.Value
collect, collect, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, isAsync, isLazy, out, out, stderr, stdout, stringPrefix, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toString, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
narrow
static <K,V> SortedMap<K,V> narrow(SortedMap<? extends K,? extends V> sortedMap)
Narrows a widenedSortedMap<? extends K, ? extends V>
toSortedMap<K, V>
by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.CAUTION: If
K
is narrowed, the underlyingComparator
might fail!- Type Parameters:
K
- Key typeV
- Value type- Parameters:
sortedMap
- ASortedMap
.- Returns:
- the given
sortedMap
instance as narrowed typeSortedMap<K, V>
.
-
bimap
<K2,V2> SortedMap<K2,V2> bimap(java.util.Comparator<? super K2> keyComparator, java.util.function.Function<? super K,? extends K2> keyMapper, java.util.function.Function<? super V,? extends V2> valueMapper)
Same asbimap(Function, Function)
, using a specific comparator for keys of the codomain of the givenkeyMapper
.- Type Parameters:
K2
- key's component type of the map resultV2
- value's component type of the map result- Parameters:
keyComparator
- A comparator for keys of type K2keyMapper
- 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
SortedMap
- Throws:
java.lang.NullPointerException
- ifkeyMapper
orvalueMapper
is null
-
flatMap
<K2,V2> SortedMap<K2,V2> flatMap(java.util.Comparator<? super K2> keyComparator, java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
Same asflatMap(BiFunction)
but using a specific comparator for values of the codomain of the givenmapper
.- Type Parameters:
K2
- New key typeV2
- New value type- Parameters:
keyComparator
- A comparator for keys of type Umapper
- A function which maps key/value pairs to Iterables map entries- Returns:
- A new Map instance containing mapped entries
-
map
<K2,V2> SortedMap<K2,V2> map(java.util.Comparator<? super K2> keyComparator, java.util.function.BiFunction<? super K,? super V,Tuple2<K2,V2>> mapper)
Same asmap(BiFunction)
, using a specific comparator for keys of the codomain of the givenmapper
.- Type Parameters:
K2
- key's component type of the map resultV2
- value's component type of the map result- Parameters:
keyComparator
- A comparator for keys of type Umapper
- aFunction
that maps entries of type(K, V)
to entries of type(K2, V2)
- Returns:
- a new
SortedMap
- Throws:
java.lang.NullPointerException
- ifmapper
is null
-
bimap
<K2,V2> SortedMap<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
Tuple2<V,? extends SortedMap<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
Tuple2<Option<V>,? extends SortedMap<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
-
distinct
SortedMap<K,V> distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.
-
distinctBy
SortedMap<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
<U> SortedMap<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
SortedMap<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
SortedMap<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
SortedMap<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
SortedMap<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
SortedMap<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
SortedMap<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 SortedMap<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()
-
filter
SortedMap<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
SortedMap<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 SortedMap<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.
-
filterKeys
SortedMap<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
SortedMap<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 SortedMap<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
SortedMap<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
SortedMap<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 SortedMap<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
-
removeAll
@Deprecated SortedMap<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.
-
removeKeys
@Deprecated SortedMap<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 SortedMap<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
-
flatMap
<K2,V2> SortedMap<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.
-
groupBy
<C> Map<C,? extends SortedMap<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
Iterator<? extends SortedMap<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
-
init
SortedMap<K,V> init()
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last.
-
initOption
Option<? extends SortedMap<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.
-
isOrdered
default boolean isOrdered()
Description copied from interface:Traversable
Checks if this Traversable is ordered- Specified by:
isOrdered
in interfaceTraversable<K>
- Returns:
- true, if this Traversable is ordered, false otherwise.
-
keySet
SortedSet<K> keySet()
Description copied from interface:Map
Returns the keys contained in this map.
-
last
default 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
<K2,V2> SortedMap<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
<K2> SortedMap<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
<K2> SortedMap<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
<V2> SortedMap<K,V2> mapValues(java.util.function.Function<? super V,? extends V2> valueMapper)
Description copied from interface:Map
Maps the values of thisMap
while preserving the corresponding keys.
-
merge
SortedMap<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
<U extends V> SortedMap<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
SortedMap<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
SortedMap<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
Tuple2<? extends SortedMap<K,V>,? extends SortedMap<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
SortedMap<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
SortedMap<K,V> put(K key, V value)
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 old value is replaced by the specified value.
-
put
SortedMap<K,V> put(Tuple2<? extends K,? extends V> entry)
Description copied from interface:Map
Convenience method forput(entry._1, entry._2)
.
-
put
<U extends V> SortedMap<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
<U extends V> SortedMap<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
SortedMap<K,V> remove(K key)
Description copied from interface:Map
Removes the mapping for a key from this map if it is present.
-
removeAll
SortedMap<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.
-
replace
SortedMap<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.
-
replace
SortedMap<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.
-
replaceValue
SortedMap<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.
-
replaceAll
SortedMap<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.
-
replaceAll
SortedMap<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.
-
retainAll
SortedMap<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
SortedMap<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
-
slideBy
Iterator<? extends SortedMap<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
Iterator<? extends SortedMap<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
Iterator<? extends SortedMap<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
Tuple2<? extends SortedMap<K,V>,? extends SortedMap<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
SortedMap<K,V> tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.
-
tailOption
Option<? extends SortedMap<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
SortedMap<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
SortedMap<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
SortedMap<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
SortedMap<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.
-
-