com.codepoetics.protonpack.maps

Interface MapStream<K,V>

All Superinterfaces:

AutoCloseable, java.util.stream.BaseStream<Map.Entry<K,V>,java.util.stream.Stream<Map.Entry<K,V>>>, java.util.stream.Stream<Map.Entry<K,V>>

public interface MapStream<K,V>
extends java.util.stream.Stream<Map.Entry<K,V>>

A stream of Map.Entry<K, V>.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.stream.Stream

java.util.stream.Stream.Builder<T>

Method Summary

Modifier and Type	Method and Description
default Map<K,V>	collect() Return a Map from the stream.
default Map<K,V>	collect(java.util.function.BinaryOperator<V> mergeFunction) Return a Map from the stream.
MapStream<K,V>	distinct()
MapStream<K,V>	filter(java.util.function.Predicate<? super Map.Entry<K,V>> predicate)
default MapStream<V,K>	inverseMapping() Return a MapStream from which the keys and values are reversed.
MapStream<K,V>	limit(long n)
default <R> java.util.stream.Stream<R>	mapEntries(java.util.function.BiFunction<? super K,? super V,? extends R> mapper) Applies the mapping for each (key, value) pair in the map.
default <K1,V1> MapStream<K1,V1>	mapEntries(java.util.function.Function<? super K,? extends K1> keyMapper, java.util.function.Function<? super V,? extends V1> valueMapper) Applies the mapping for each key and value in the map.
default <R> MapStream<R,V>	mapEntriesToKeys(java.util.function.BiFunction<? super K,? super V,? extends R> mapper) Applies the mapping for each key and value in the map, to produce a new key for each entry.
default <R> MapStream<K,R>	mapEntriesToValues(java.util.function.BiFunction<? super K,? super V,? extends R> mapper) Applies the mapping for each key and value in the map, to produce a new value for each entry.
default <K1> MapStream<K1,V>	mapKeys(java.util.function.Function<? super K,? extends K1> mapper) Applies the mapping for each key in the map.
default <V1> MapStream<K,V1>	mapValues(java.util.function.Function<? super V,? extends V1> mapper) Applies the mapping for each value in the map.
default MapStream<K,List<V>>	mergeKeys() Merge keys of the Stream into a new Stream
default MapStream<K,V>	mergeKeys(java.util.function.BinaryOperator<V> mergeFunction) Merge keys of the Stream into a new Stream with the merge function provided
static <K,V> MapStream<K,V>	of(K key, V value) Construct a MapStream<K, V> from a single key-value pair
static <K,V> MapStream<K,V>	of(K key, V value, K key1, V value1) Construct a MapStream<K, V> from a multiple key-value pairs
static <K,V> MapStream<K,V>	of(K key, V value, K key1, V value1, K key2, V value2) Construct a MapStream<K, V> from a multiple key-value pairs
static <K,V> MapStream<K,V>	of(K key, V value, K key1, V value1, K key2, V value2, K key3, V value3) Construct a MapStream<K, V> from a multiple key-value pairs
static <K,V> MapStream<K,V>	of(K key, V value, K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4) Construct a MapStream<K, V> from a multiple key-value pairs
static <K,V> MapStream<K,V>	of(Map<K,V> map) Construct a MapStream<K, V> from the map
static <K,V> MapStream<K,V>	ofMaps(Map<K,V>... maps) Construct a MapStream<K, V> from the map
MapStream<K,V>	onClose(Runnable closeHandler)
MapStream<K,V>	parallel()
MapStream<K,V>	peek(java.util.function.Consumer<? super Map.Entry<K,V>> action)
MapStream<K,V>	sequential()
MapStream<K,V>	skip(long n)
MapStream<K,V>	sorted()
MapStream<K,V>	sorted(Comparator<? super Map.Entry<K,V>> comparator)
MapStream<K,V>	unordered()

Methods inherited from interface java.util.stream.Stream

allMatch, anyMatch, builder, collect, collect, concat, count, empty, findAny, findFirst, flatMap, flatMapToDouble, flatMapToInt, flatMapToLong, forEach, forEachOrdered, generate, iterate, map, mapToDouble, mapToInt, mapToLong, max, min, noneMatch, reduce, reduce, reduce, toArray, toArray

Methods inherited from interface java.util.stream.BaseStream

close, isParallel, iterator, spliterator

Method Detail

of

static <K,V> MapStream<K,V> of(Map<K,V> map)

Construct a MapStream<K, V> from the map

Specified by:

of in interface java.util.stream.Stream<Map.Entry<K,V>>

Type Parameters:

K - - the type of the map keys

V - - the type of the map values

Parameters:

map - - the map to build the stream from

Returns:

a new MapStream<K, V>

ofMaps

@SafeVarargs
static <K,V> MapStream<K,V> ofMaps(Map<K,V>... maps)

Construct a MapStream<K, V> from the map

Type Parameters:

K - - the type of the map keys

V - - the type of the map values

Parameters:

maps - - the map to build the stream from

Returns:

a new MapStream<K, V>

of

static <K,V> MapStream<K,V> of(K key,
                               V value)

Construct a MapStream<K, V> from a single key-value pair

Type Parameters:

K - - the type of the map keys

V - - the type of the map values

Parameters:

key - - the key

value - - the value

Returns:

a new MapStream<K, V>

of

static <K,V> MapStream<K,V> of(K key,
                               V value,
                               K key1,
                               V value1)

Construct a MapStream<K, V> from a multiple key-value pairs

Type Parameters:

K - - the type of the map keys

V - - the type of the map values

Parameters:

key - - key

value - - value

key1 - - key1

value1 - - value1

Returns:

a new MapStream<K, V>

of

static <K,V> MapStream<K,V> of(K key,
                               V value,
                               K key1,
                               V value1,
                               K key2,
                               V value2)

Construct a MapStream<K, V> from a multiple key-value pairs

Type Parameters:

K - - the type of the map keys

V - - the type of the map values

Parameters:

key - - key

value - - value

key1 - - key1

value1 - - value1

key2 - - key2

value2 - - value2

Returns:

a new MapStream<K, V>

of

static <K,V> MapStream<K,V> of(K key,
                               V value,
                               K key1,
                               V value1,
                               K key2,
                               V value2,
                               K key3,
                               V value3)

Construct a MapStream<K, V> from a multiple key-value pairs

Type Parameters:

K - - the type of the map keys

V - - the type of the map values

Parameters:

key - - key

value - - value

key1 - - key1

value1 - - value1

key2 - - key2

value2 - - value2

key3 - - key3

value3 - - value3

Returns:

a new MapStream<K, V>

of

static <K,V> MapStream<K,V> of(K key,
                               V value,
                               K key1,
                               V value1,
                               K key2,
                               V value2,
                               K key3,
                               V value3,
                               K key4,
                               V value4)

Construct a MapStream<K, V> from a multiple key-value pairs

Type Parameters:

K - - the type of the map keys

V - - the type of the map values

Parameters:

key - - key

value - - value

key1 - - key1

value1 - - value1

key2 - - key2

value2 - - value2

key3 - - key3

value3 - - value3

key4 - - key4

value4 - - value4

Returns:

a new MapStream<K, V>

mapKeys

default <K1> MapStream<K1,V> mapKeys(java.util.function.Function<? super K,? extends K1> mapper)

Applies the mapping for each key in the map. If your mapping function is not injective, make sure you call mergeKeys or that you provide a merge function when calling collect

Type Parameters:

K1 - the type to map the keys into

Parameters:

mapper - - the key mapping to be applied

Returns:

a new MapStream

mapValues

default <V1> MapStream<K,V1> mapValues(java.util.function.Function<? super V,? extends V1> mapper)

Applies the mapping for each value in the map.

Type Parameters:

V1 - the type to map the values into

Parameters:

mapper - - the value mapping to be applied

Returns:

a new MapStream

mapEntries

default <K1,V1> MapStream<K1,V1> mapEntries(java.util.function.Function<? super K,? extends K1> keyMapper,
                                            java.util.function.Function<? super V,? extends V1> valueMapper)

Applies the mapping for each key and value in the map. If your mapping function is not injective for the keys, make sure you call mergeKeys or that you provide a merge function when calling collect.

Type Parameters:

K1 - the type to map the keys into

V1 - the type to map the values into

Parameters:

keyMapper - - the key mapping to be applied

valueMapper - - the value mapping to be applied

Returns:

a new MapStream

mapEntries

default <R> java.util.stream.Stream<R> mapEntries(java.util.function.BiFunction<? super K,? super V,? extends R> mapper)

Applies the mapping for each (key, value) pair in the map.

Type Parameters:

R - the type to map the (key, value) pairs into

Parameters:

mapper - the mapping function to be applied

Returns:

a new Stream

mapEntriesToKeys

default <R> MapStream<R,V> mapEntriesToKeys(java.util.function.BiFunction<? super K,? super V,? extends R> mapper)

Applies the mapping for each key and value in the map, to produce a new key for each entry. If your mapping function is not injective for the keys, make sure you call mergeKeys or that you provide a merge function when calling collect.

Type Parameters:

R - the new key type to map the (key, value) pairs into

Parameters:

mapper - the mapping function to be applied

Returns:

a new MapStream

mapEntriesToValues

default <R> MapStream<K,R> mapEntriesToValues(java.util.function.BiFunction<? super K,? super V,? extends R> mapper)

Applies the mapping for each key and value in the map, to produce a new value for each entry.

Type Parameters:

R - the new value type to map the (key, value) pairs into

Parameters:

mapper - the mapping function to be applied

Returns:

a new MapStream

mergeKeys

default MapStream<K,List<V>> mergeKeys()

Merge keys of the Stream into a new Stream

Returns:

a new MapStream

mergeKeys

default MapStream<K,V> mergeKeys(java.util.function.BinaryOperator<V> mergeFunction)

Merge keys of the Stream into a new Stream with the merge function provided

Parameters:

mergeFunction - The merge function to use

Returns:

a new MapStream

collect

default Map<K,V> collect()

Return a Map from the stream. If you have similar keys in the stream, don't forget to call mergeKeys() or collect (BinaryOperator<V> mergeFunction)

Returns:

a map

collect

default Map<K,V> collect(java.util.function.BinaryOperator<V> mergeFunction)

Return a Map from the stream. If there are similar keys in the stream, the merge function will be applied to merge the values of those keys

Parameters:

mergeFunction - the function to merge the values if the keys are not unique

Returns:

a map

inverseMapping

default MapStream<V,K> inverseMapping()

Return a MapStream from which the keys and values are reversed.

Returns:

a new MapStream

limit

MapStream<K,V> limit(long n)

Specified by:

limit in interface java.util.stream.Stream<Map.Entry<K,V>>

skip

MapStream<K,V> skip(long n)

Specified by:

skip in interface java.util.stream.Stream<Map.Entry<K,V>>

sorted

MapStream<K,V> sorted()

Specified by:

sorted in interface java.util.stream.Stream<Map.Entry<K,V>>

sorted

MapStream<K,V> sorted(Comparator<? super Map.Entry<K,V>> comparator)

Specified by:

sorted in interface java.util.stream.Stream<Map.Entry<K,V>>

peek

MapStream<K,V> peek(java.util.function.Consumer<? super Map.Entry<K,V>> action)

Specified by:

peek in interface java.util.stream.Stream<Map.Entry<K,V>>

onClose

MapStream<K,V> onClose(Runnable closeHandler)

Specified by:

onClose in interface java.util.stream.BaseStream<Map.Entry<K,V>,java.util.stream.Stream<Map.Entry<K,V>>>

filter

MapStream<K,V> filter(java.util.function.Predicate<? super Map.Entry<K,V>> predicate)

Specified by:

filter in interface java.util.stream.Stream<Map.Entry<K,V>>

parallel

MapStream<K,V> parallel()

Specified by:

parallel in interface java.util.stream.BaseStream<Map.Entry<K,V>,java.util.stream.Stream<Map.Entry<K,V>>>

sequential

MapStream<K,V> sequential()

Specified by:

sequential in interface java.util.stream.BaseStream<Map.Entry<K,V>,java.util.stream.Stream<Map.Entry<K,V>>>

unordered

MapStream<K,V> unordered()

Specified by:

unordered in interface java.util.stream.BaseStream<Map.Entry<K,V>,java.util.stream.Stream<Map.Entry<K,V>>>

distinct

MapStream<K,V> distinct()

Specified by:

distinct in interface java.util.stream.Stream<Map.Entry<K,V>>