com.opengamma.strata.collect

Class MapStream<K,V>

java.lang.Object

com.opengamma.strata.collect.MapStream<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

AutoCloseable, BaseStream<Map.Entry<K,V>,Stream<Map.Entry<K,V>>>, Stream<Map.Entry<K,V>>

public final class MapStream<K,V>
extends Object
implements Stream<Map.Entry<K,V>>

A stream implementation based on Map.Entry.

This stream wraps a Stream<Map.Entry>, providing convenient methods for manipulating the keys and values. Unlike a Map, the keys in a MapStream do not have to be unique, although certain methods will fail if they are not unique.

Nested Class Summary

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

Stream.Builder<T>

Method Summary

Modifier and Type	Method and Description
boolean	allMatch(BiPredicate<? super K,? super V> predicate) Returns whether all elements of this stream match the provided predicate.
boolean	allMatch(Predicate<? super Map.Entry<K,V>> predicate)
boolean	anyMatch(BiPredicate<? super K,? super V> predicate) Returns whether any elements of this stream match the provided predicate.
boolean	anyMatch(Predicate<? super Map.Entry<K,V>> predicate)
void	close()
<R,A> R	collect(Collector<? super Map.Entry<K,V>,A,R> collector)
<R> R	collect(Supplier<R> supplier, BiConsumer<R,? super Map.Entry<K,V>> accumulator, BiConsumer<R,R> combiner)
static <K,V> MapStream<K,V>	concat(MapStream<? extends K,? extends V> a, MapStream<? extends K,? extends V> b) Creates a stream of map entries whose elements are those of the first stream followed by those of the second stream.
long	count()
MapStream<K,V>	distinct()
static <K,V> MapStream<K,V>	empty() Returns an empty map stream.
MapStream<K,V>	filter(BiFunction<? super K,? super V,Boolean> predicate) Filters the stream by applying the predicate function to each key and value.
MapStream<K,V>	filter(Predicate<? super Map.Entry<K,V>> predicate)
<R> MapStream<R,V>	filterKeys(Class<R> castToClass) Filters the stream checking the type of each key.
MapStream<K,V>	filterKeys(Predicate<? super K> predicate) Filters the stream by applying the predicate function to each key.
<R> MapStream<K,R>	filterValues(Class<R> castToClass) Filters the stream checking the type of each value.
MapStream<K,V>	filterValues(Predicate<? super V> predicate) Filters the stream by applying the predicate function to each value.
Optional<Map.Entry<K,V>>	findAny()
Optional<Map.Entry<K,V>>	findFirst()
<R> Stream<R>	flatMap(BiFunction<? super K,? super V,Stream<R>> mapper) Transforms the entries in the stream by applying a mapper function to each key and value to produce a stream of elements, and then flattening the resulting stream of streams.
<R> Stream<R>	flatMap(Function<? super Map.Entry<K,V>,? extends Stream<? extends R>> mapper)
<R> MapStream<R,V>	flatMapKeys(BiFunction<? super K,? super V,Stream<R>> mapper) Transforms the keys in the stream by applying a mapper function to each key and value.
<R> MapStream<R,V>	flatMapKeys(Function<? super K,Stream<R>> mapper) Transforms the keys in the stream by applying a mapper function to each key.
DoubleStream	flatMapToDouble(BiFunction<? super K,? super V,? extends DoubleStream> mapper) Transforms the entries in the stream to doubles by applying a mapper function to each key and value to produce a stream of doubles, and then flattening the resulting stream of streams.
DoubleStream	flatMapToDouble(Function<? super Map.Entry<K,V>,? extends DoubleStream> mapper)
IntStream	flatMapToInt(BiFunction<? super K,? super V,? extends IntStream> mapper) Transforms the entries in the stream to integers by applying a mapper function to each key and value to produce a stream of integers, and then flattening the resulting stream of streams.
IntStream	flatMapToInt(Function<? super Map.Entry<K,V>,? extends IntStream> mapper)
LongStream	flatMapToLong(Function<? super Map.Entry<K,V>,? extends LongStream> mapper)
<R> MapStream<K,R>	flatMapValues(BiFunction<? super K,? super V,Stream<R>> mapper) Transforms the values in the stream by applying a mapper function to each key and value.
<R> MapStream<K,R>	flatMapValues(Function<? super V,Stream<R>> mapper) Transforms the values in the stream by applying a mapper function to each value.
void	forEach(BiConsumer<? super K,? super V> action) Performs an action for each entry in the stream, passing the key and value to the action.
void	forEach(Consumer<? super Map.Entry<K,V>> action)
void	forEachOrdered(Consumer<? super Map.Entry<K,V>> action)
boolean	isParallel()
Iterator<Map.Entry<K,V>>	iterator()
Stream<K>	keys() Returns the keys as a stream, dropping the values.
MapStream<K,V>	limit(long maxSize)
<R> Stream<R>	map(BiFunction<? super K,? super V,? extends R> mapper) Transforms the entries in the stream by applying a mapper function to each key and value.
<R> Stream<R>	map(Function<? super Map.Entry<K,V>,? extends R> mapper)
<R> MapStream<R,V>	mapKeys(BiFunction<? super K,? super V,? extends R> mapper) Transforms the keys in the stream by applying a mapper function to each key and value.
<R> MapStream<R,V>	mapKeys(Function<? super K,? extends R> mapper) Transforms the keys in the stream by applying a mapper function to each key.
DoubleStream	mapToDouble(ToDoubleBiFunction<? super K,? super V> mapper) Transforms the entries in the stream to doubles by applying a mapper function to each key and value.
DoubleStream	mapToDouble(ToDoubleFunction<? super Map.Entry<K,V>> mapper)
IntStream	mapToInt(ToIntBiFunction<? super K,? super V> mapper) Transforms the entries in the stream to integers by applying a mapper function to each key and value.
IntStream	mapToInt(ToIntFunction<? super Map.Entry<K,V>> mapper)
LongStream	mapToLong(ToLongFunction<? super Map.Entry<K,V>> mapper)
<R> MapStream<K,R>	mapValues(BiFunction<? super K,? super V,? extends R> mapper) Transforms the values in the stream by applying a mapper function to each key and value.
<R> MapStream<K,R>	mapValues(Function<? super V,? extends R> mapper) Transforms the values in the stream by applying a mapper function to each value.
Optional<Map.Entry<K,V>>	max(Comparator<? super Map.Entry<K,V>> comparator)
Optional<Map.Entry<K,V>>	maxKeys(Comparator<? super K> comparator) Finds the maximum entry in the stream by comparing the keys using the supplied comparator.
Optional<Map.Entry<K,V>>	maxValues(Comparator<? super V> comparator) Finds the maximum entry in the stream by comparing the values using the supplied comparator.
Optional<Map.Entry<K,V>>	min(Comparator<? super Map.Entry<K,V>> comparator)
Optional<Map.Entry<K,V>>	minKeys(Comparator<? super K> comparator) Finds the minimum entry in the stream by comparing the keys using the supplied comparator.
Optional<Map.Entry<K,V>>	minValues(Comparator<? super V> comparator) Finds the minimum entry in the stream by comparing the values using the supplied comparator.
boolean	noneMatch(BiPredicate<? super K,? super V> predicate) Returns whether no elements of this stream match the provided predicate.
boolean	noneMatch(Predicate<? super Map.Entry<K,V>> predicate)
static <T,K,V> MapStream<K,V>	of(Collection<T> collection, Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction) Returns a stream of map entries where the keys and values are extracted from a collection by applying a function to each item in the collection.
static <V> MapStream<V,V>	of(Collection<V> collection) Returns a stream of map entries where the keys and values are taken from a collection.
static <K,V> MapStream<K,V>	of(Collection<V> collection, Function<? super V,? extends K> keyFunction) Returns a stream of map entries where the values are taken from a collection and the keys are created by applying a function to each value.
static <K,V> MapStream<K,V>	of(Map<K,V> map) Returns a stream over the entries in the map.
static <K,V> MapStream<K,V>	of(Multimap<K,V> multimap) Returns a stream over all the entries in the multimap.
static <T,K,V> MapStream<K,V>	of(Stream<T> stream, Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction) Returns a stream of map entries where the keys and values are extracted from a stream by applying a function to each item in the stream.
static <V> MapStream<V,V>	of(Stream<V> stream) Returns a stream of map entries where the keys and values are taken from a stream.
static <K,V> MapStream<K,V>	of(Stream<V> stream, Function<? super V,? extends K> keyFunction) Returns a stream of map entries where the values are taken from a stream and the keys are created by applying a function to each value.
MapStream<K,V>	onClose(Runnable closeHandler)
MapStream<K,V>	parallel()
MapStream<K,V>	peek(Consumer<? super Map.Entry<K,V>> action)
Optional<Map.Entry<K,V>>	reduce(BinaryOperator<Map.Entry<K,V>> accumulator)
Map.Entry<K,V>	reduce(Map.Entry<K,V> identity, BinaryOperator<Map.Entry<K,V>> accumulator)
<U> U	reduce(U identity, BiFunction<U,? super Map.Entry<K,V>,U> accumulator, BinaryOperator<U> combiner)
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>	sortedKeys() Sorts the entries in the stream by comparing the keys using their natural ordering.
MapStream<K,V>	sortedKeys(Comparator<? super K> comparator) Sorts the entries in the stream by comparing the keys using the supplied comparator.
MapStream<K,V>	sortedValues() Sorts the entries in the stream by comparing the values using their natural ordering.
MapStream<K,V>	sortedValues(Comparator<? super V> comparator) Sorts the entries in the stream by comparing the values using the supplied comparator.
Spliterator<Map.Entry<K,V>>	spliterator()
Object[]	toArray()
<A> A[]	toArray(IntFunction<A[]> generator)
ImmutableListMultimap<K,V>	toListMultimap() Returns an immutable list multimap built from the entries in the stream.
ImmutableMap<K,V>	toMap() Returns an immutable map built from the entries in the stream.
ImmutableMap<K,V>	toMap(BiFunction<? super V,? super V,? extends V> mergeFn) Returns an immutable map built from the entries in the stream.
ImmutableMap<K,List<V>>	toMapGrouping() Returns an immutable map built from the entries in the stream, grouping by key.
<A,R> ImmutableMap<K,R>	toMapGrouping(Collector<? super V,A,R> valueCollector) Returns an immutable map built from the entries in the stream, grouping by key.
ImmutableSetMultimap<K,V>	toSetMultimap() Returns an immutable set multimap built from the entries in the stream.
MapStream<K,V>	unordered()
Stream<V>	values() Returns the values as a stream, dropping the keys.
static <K,V> MapStream<K,V>	zip(Stream<K> keyStream, Stream<V> valueStream) Returns a map stream that combines two other streams, continuing until either stream ends.
static <V> MapStream<Integer,V>	zipWithIndex(Stream<V> stream) Returns a stream of map entries where each key is the index of the value in the original stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.stream.Stream

builder, concat, generate, iterate

Method Detail

of

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

Returns a stream over the entries in the map.

Specified by:

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

Type Parameters:

K - the key type

V - the value type

Parameters:

map - the map to wrap

Returns:

a stream over the entries in the map

of

public static <K,V> MapStream<K,V> of(Multimap<K,V> multimap)

Returns a stream over all the entries in the multimap.

This will typically create a stream with duplicate keys.

Specified by:

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

Type Parameters:

K - the key type

V - the value type

Parameters:

multimap - the multimap to wrap

Returns:

a stream over the entries in the multimap

of

public static <V> MapStream<V,V> of(Collection<V> collection)

Returns a stream of map entries where the keys and values are taken from a collection.

Specified by:

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

Type Parameters:

V - the key and value type

Parameters:

collection - the collection

Returns:

a stream of map entries derived from the values in the collection

of

public static <V> MapStream<V,V> of(Stream<V> stream)

Returns a stream of map entries where the keys and values are taken from a stream.

Specified by:

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

Type Parameters:

V - the key and value type

Parameters:

stream - the stream

Returns:

a stream of map entries derived from the values in the stream

of

public static <K,V> MapStream<K,V> of(Collection<V> collection,
                                      Function<? super V,? extends K> keyFunction)

Returns a stream of map entries where the values are taken from a collection and the keys are created by applying a function to each value.

Type Parameters:

K - the key type

V - the value type

Parameters:

collection - the collection of values

keyFunction - a function which returns the key for a value

Returns:

a stream of map entries derived from the values in the collection

of

public static <T,K,V> MapStream<K,V> of(Collection<T> collection,
                                        Function<? super T,? extends K> keyFunction,
                                        Function<? super T,? extends V> valueFunction)

Returns a stream of map entries where the keys and values are extracted from a collection by applying a function to each item in the collection.

Type Parameters:

T - the collection type

K - the key type

V - the value type

Parameters:

collection - the collection of values

keyFunction - a function which returns the key

valueFunction - a function which returns the value

Returns:

a stream of map entries derived from the collection

of

public static <K,V> MapStream<K,V> of(Stream<V> stream,
                                      Function<? super V,? extends K> keyFunction)

Returns a stream of map entries where the values are taken from a stream and the keys are created by applying a function to each value.

Type Parameters:

K - the key type

V - the value type

Parameters:

stream - the stream of values

keyFunction - a function which returns the key for a value

Returns:

a stream of map entries derived from the values in the stream

of

public static <T,K,V> MapStream<K,V> of(Stream<T> stream,
                                        Function<? super T,? extends K> keyFunction,
                                        Function<? super T,? extends V> valueFunction)

Returns a stream of map entries where the keys and values are extracted from a stream by applying a function to each item in the stream.

Type Parameters:

T - the collection type

K - the key type

V - the value type

Parameters:

stream - the stream of values

keyFunction - a function which returns the key for a value

valueFunction - a function which returns the value

Returns:

a stream of map entries derived from the stream

zip

public static <K,V> MapStream<K,V> zip(Stream<K> keyStream,
                                       Stream<V> valueStream)

Returns a map stream that combines two other streams, continuing until either stream ends.

Note that this can produce a stream with non-unique keys.

Type Parameters:

K - the key type

V - the value type

Parameters:

keyStream - the stream of keys

valueStream - the stream of values

Returns:

a stream of map entries derived from the stream

zipWithIndex

public static <V> MapStream<Integer,V> zipWithIndex(Stream<V> stream)

Returns a stream of map entries where each key is the index of the value in the original stream.

Type Parameters:

V - the value type

Parameters:

stream - the stream of values

Returns:

a stream of map entries derived from the stream

empty

public static <K,V> MapStream<K,V> empty()

Returns an empty map stream.

Specified by:

empty in interface Stream<Map.Entry<K,V>>

Type Parameters:

K - the key type

V - the value type

Returns:

an empty map stream

concat

public static <K,V> MapStream<K,V> concat(MapStream<? extends K,? extends V> a,
                                          MapStream<? extends K,? extends V> b)

Creates a stream of map entries whose elements are those of the first stream followed by those of the second stream.

Type Parameters:

K - the key type

V - the value type

Parameters:

a - the first stream of entries

b - the second stream of entries

Returns:

the concatenation of the two input streams

keys

public Stream<K> keys()

Returns the keys as a stream, dropping the values.

A MapStream may contain the same key more than once, so callers may need to call Stream.distinct() on the result.

Returns:

a stream of the keys

values

public Stream<V> values()

Returns the values as a stream, dropping the keys.

Returns:

a stream of the values

filter

public MapStream<K,V> filter(BiFunction<? super K,? super V,Boolean> predicate)

Filters the stream by applying the predicate function to each key and value.

Entries are included in the returned stream if the predicate function returns true.

Parameters:

predicate - a predicate function applied to each key and value in the stream

Returns:

a stream including the entries for which the predicate function returned true

filterKeys

public MapStream<K,V> filterKeys(Predicate<? super K> predicate)

Filters the stream by applying the predicate function to each key.

Entries are included in the returned stream if the predicate function returns true.

Parameters:

predicate - a predicate function applied to each key in the stream

Returns:

a stream including the entries for which the predicate function returned true

filterKeys

public <R> MapStream<R,V> filterKeys(Class<R> castToClass)

Filters the stream checking the type of each key.

Entries are included in the returned stream if the key is an instance of the specified type.

Type Parameters:

R - the type to filter to

Parameters:

castToClass - the class to filter the keys to

Returns:

a stream including only those entries where the key is an instance of the specified type

filterValues

public MapStream<K,V> filterValues(Predicate<? super V> predicate)

Filters the stream by applying the predicate function to each value.

Entries are included in the returned stream if the predicate function returns true.

Parameters:

predicate - a predicate function applied to each value in the stream

Returns:

a stream including the entries for which the predicate function returned true

filterValues

public <R> MapStream<K,R> filterValues(Class<R> castToClass)

Filters the stream checking the type of each value.

Entries are included in the returned stream if the value is an instance of the specified type.

Type Parameters:

R - the type to filter to

Parameters:

castToClass - the class to filter the values to

Returns:

a stream including only those entries where the value is an instance of the specified type

mapKeys

public <R> MapStream<R,V> mapKeys(Function<? super K,? extends R> mapper)

Transforms the keys in the stream by applying a mapper function to each key.

The values are unchanged.

Type Parameters:

R - the type of the new keys

Parameters:

mapper - a mapper function whose return value is used as the new key

Returns:

a stream of entries with the keys transformed and the values unchanged

mapKeys

public <R> MapStream<R,V> mapKeys(BiFunction<? super K,? super V,? extends R> mapper)

Transforms the keys in the stream by applying a mapper function to each key and value.

The values are unchanged.

Type Parameters:

R - the type of the new keys

Parameters:

mapper - a mapper function whose return value is used as the new key

Returns:

a stream of entries with the keys transformed and the values unchanged

mapValues

public <R> MapStream<K,R> mapValues(Function<? super V,? extends R> mapper)

Transforms the values in the stream by applying a mapper function to each value.

The keys are unchanged.

Type Parameters:

R - the type of the new values

Parameters:

mapper - a mapper function whose return value is used as the new value

Returns:

a stream of entries with the values transformed and the keys unchanged

mapValues

public <R> MapStream<K,R> mapValues(BiFunction<? super K,? super V,? extends R> mapper)

Transforms the values in the stream by applying a mapper function to each key and value.

The keys are unchanged.

Type Parameters:

R - the type of the new values

Parameters:

mapper - a mapper function whose return value is used as the new value

Returns:

a stream of entries with the values transformed and the keys unchanged

map

public <R> Stream<R> map(BiFunction<? super K,? super V,? extends R> mapper)

Transforms the entries in the stream by applying a mapper function to each key and value.

Type Parameters:

R - the type of elements in the new stream

Parameters:

mapper - a mapper function whose return values are included in the new stream

Returns:

a stream containing the values returned from the mapper function

mapToDouble

public DoubleStream mapToDouble(ToDoubleBiFunction<? super K,? super V> mapper)

Transforms the entries in the stream to doubles by applying a mapper function to each key and value.

Parameters:

mapper - a mapper function whose return values are included in the new stream

Returns:

a stream containing the double values returned from the mapper function

mapToInt

public IntStream mapToInt(ToIntBiFunction<? super K,? super V> mapper)

Transforms the entries in the stream to integers by applying a mapper function to each key and value.

Parameters:

mapper - a mapper function whose return values are included in the new stream

Returns:

a stream containing the integer values returned from the mapper function

flatMapKeys

public <R> MapStream<R,V> flatMapKeys(Function<? super K,Stream<R>> mapper)

Transforms the keys in the stream by applying a mapper function to each key.

The new keys produced will be associated with the original value.

Type Parameters:

R - the type of the new keys

Parameters:

mapper - a mapper function whose return values are the keys in the new stream

Returns:

a stream of entries with new keys from the mapper function assigned to the values

flatMapKeys

public <R> MapStream<R,V> flatMapKeys(BiFunction<? super K,? super V,Stream<R>> mapper)

Transforms the keys in the stream by applying a mapper function to each key and value.

The new keys produced will be associated with the original value.

For example this could turn a MapStream<List<String>, LocalDate> into a MapStream<String, LocalDate>

Type Parameters:

R - the type of the new keys

Parameters:

mapper - a mapper function whose return values are the keys in the new stream

Returns:

a stream of entries with new keys from the mapper function assigned to the values

flatMapValues

public <R> MapStream<K,R> flatMapValues(Function<? super V,Stream<R>> mapper)

Transforms the values in the stream by applying a mapper function to each value.

The new values produced will be associated with the original key.

For example this could turn a MapStream<LocalDate, List<String>> into a MapStream<LocalDate, String>

Type Parameters:

R - the type of the new values

Parameters:

mapper - a mapper function whose return values are the values in the new stream

Returns:

a stream of entries with new values from the mapper function assigned to the keys

flatMapValues

public <R> MapStream<K,R> flatMapValues(BiFunction<? super K,? super V,Stream<R>> mapper)

Transforms the values in the stream by applying a mapper function to each key and value.

The new values produced will be associated with the original key.

For example this could turn a MapStream<LocalDate, List<String>> into a MapStream<LocalDate, String>

Type Parameters:

R - the type of the new values

Parameters:

mapper - a mapper function whose return values are the values in the new stream

Returns:

a stream of entries with new values from the mapper function assigned to the keys

flatMap

public <R> Stream<R> flatMap(BiFunction<? super K,? super V,Stream<R>> mapper)

Transforms the entries in the stream by applying a mapper function to each key and value to produce a stream of elements, and then flattening the resulting stream of streams.

Type Parameters:

R - the type of the elements in the new stream

Parameters:

mapper - a mapper function whose return values are included in the new stream

Returns:

a stream containing the values returned from the mapper function

flatMapToDouble

public DoubleStream flatMapToDouble(BiFunction<? super K,? super V,? extends DoubleStream> mapper)

Transforms the entries in the stream to doubles by applying a mapper function to each key and value to produce a stream of doubles, and then flattening the resulting stream of streams.

Parameters:

mapper - a mapper function whose return values are included in the new stream

Returns:

a stream containing the double values returned from the mapper function

flatMapToInt

public IntStream flatMapToInt(BiFunction<? super K,? super V,? extends IntStream> mapper)

Transforms the entries in the stream to integers by applying a mapper function to each key and value to produce a stream of integers, and then flattening the resulting stream of streams.

Parameters:

mapper - a mapper function whose return values are included in the new stream

Returns:

a stream containing the integer values returned from the mapper function

sortedKeys

public MapStream<K,V> sortedKeys()

Sorts the entries in the stream by comparing the keys using their natural ordering.

If the keys in this map stream are not Comparable a java.lang.ClassCastException may be thrown. In this case use sortedKeys(Comparator) instead.

Returns:

the sorted stream

sortedKeys

public MapStream<K,V> sortedKeys(Comparator<? super K> comparator)

Sorts the entries in the stream by comparing the keys using the supplied comparator.

Parameters:

comparator - a comparator of keys

Returns:

the sorted stream

sortedValues

public MapStream<K,V> sortedValues()

Sorts the entries in the stream by comparing the values using their natural ordering.

If the values in this map stream are not Comparable a java.lang.ClassCastException may be thrown. In this case use sortedValues(Comparator) instead.

Returns:

the sorted stream

sortedValues

public MapStream<K,V> sortedValues(Comparator<? super V> comparator)

Sorts the entries in the stream by comparing the values using the supplied comparator.

Parameters:

comparator - a comparator of values

Returns:

the sorted stream

minKeys

public Optional<Map.Entry<K,V>> minKeys(Comparator<? super K> comparator)

Finds the minimum entry in the stream by comparing the keys using the supplied comparator.

This is a terminal operation.

Parameters:

comparator - a comparator of keys

Returns:

the minimum entry

minValues

public Optional<Map.Entry<K,V>> minValues(Comparator<? super V> comparator)

Finds the minimum entry in the stream by comparing the values using the supplied comparator.

This is a terminal operation.

Parameters:

comparator - a comparator of values

Returns:

the minimum entry

maxKeys

public Optional<Map.Entry<K,V>> maxKeys(Comparator<? super K> comparator)

Finds the maximum entry in the stream by comparing the keys using the supplied comparator.

This is a terminal operation.

Parameters:

comparator - a comparator of keys

Returns:

the maximum entry

maxValues

public Optional<Map.Entry<K,V>> maxValues(Comparator<? super V> comparator)

Finds the maximum entry in the stream by comparing the values using the supplied comparator.

This is a terminal operation.

Parameters:

comparator - a comparator of values

Returns:

the maximum entry

anyMatch

public boolean anyMatch(BiPredicate<? super K,? super V> predicate)

Returns whether any elements of this stream match the provided predicate.

This is a short-circuiting terminal operation.

Parameters:

predicate - the predicate to apply to the entries

Returns:

whether any of the entries matched the predicate

allMatch

public boolean allMatch(BiPredicate<? super K,? super V> predicate)

Returns whether all elements of this stream match the provided predicate.

This is a short-circuiting terminal operation.

Parameters:

predicate - the predicate to apply to the entries

Returns:

whether all of the entries matched the predicate

noneMatch

public boolean noneMatch(BiPredicate<? super K,? super V> predicate)

Returns whether no elements of this stream match the provided predicate.

This is a short-circuiting terminal operation.

Parameters:

predicate - the predicate to apply to the entries

Returns:

whether none of the entries matched the predicate

toMap

public ImmutableMap<K,V> toMap()

Returns an immutable map built from the entries in the stream.

The keys must be unique or an exception will be thrown. Duplicate keys can be handled using toMap(BiFunction).

This is a terminal operation.

Returns:

an immutable map built from the entries in the stream

Throws:

IllegalArgumentException - if the same key occurs more than once

toMap

public ImmutableMap<K,V> toMap(BiFunction<? super V,? super V,? extends V> mergeFn)

Returns an immutable map built from the entries in the stream.

If the same key maps to multiple values the merge function is invoked with both values and the return value is used in the map.

Can be used with concat(MapStream, MapStream) to merge immutable maps with duplicate keys.

For example, to merge immutable maps with duplicate keys preferring values in the first map:

   MapStream.concat(mapStreamA, mapStreamB).toMap((a,b) -> a);
 

This is a terminal operation.

Parameters:

mergeFn - function used to merge values when the same key appears multiple times in the stream

Returns:

an immutable map built from the entries in the stream

toMapGrouping

public ImmutableMap<K,List<V>> toMapGrouping()

Returns an immutable map built from the entries in the stream, grouping by key.

Entries are grouped based on the equality of the key.

This is a terminal operation.

Returns:

an immutable map built from the entries in the stream

toMapGrouping

public <A,R> ImmutableMap<K,R> toMapGrouping(Collector<? super V,A,R> valueCollector)

Returns an immutable map built from the entries in the stream, grouping by key.

Entries are grouped based on the equality of the key. The collector allows the values to be flexibly combined.

This is a terminal operation.

Type Parameters:

A - the internal collector type

R - the type of the combined values

Parameters:

valueCollector - the collector used to combined the values

Returns:

a stream where the values have been grouped

toListMultimap

public ImmutableListMultimap<K,V> toListMultimap()

Returns an immutable list multimap built from the entries in the stream.

This is a terminal operation.

Returns:

an immutable list multimap built from the entries in the stream

toSetMultimap

public ImmutableSetMultimap<K,V> toSetMultimap()

Returns an immutable set multimap built from the entries in the stream.

This is a terminal operation.

Returns:

an immutable set multimap built from the entries in the stream

forEach

public void forEach(BiConsumer<? super K,? super V> action)

Performs an action for each entry in the stream, passing the key and value to the action.

This is a terminal operation.

Parameters:

action - an action performed for each entry in the stream

filter

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

Specified by:

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

map

public <R> Stream<R> map(Function<? super Map.Entry<K,V>,? extends R> mapper)

Specified by:

map in interface Stream<Map.Entry<K,V>>

mapToInt

public IntStream mapToInt(ToIntFunction<? super Map.Entry<K,V>> mapper)

Specified by:

mapToInt in interface Stream<Map.Entry<K,V>>

mapToLong

public LongStream mapToLong(ToLongFunction<? super Map.Entry<K,V>> mapper)

Specified by:

mapToLong in interface Stream<Map.Entry<K,V>>

mapToDouble

public DoubleStream mapToDouble(ToDoubleFunction<? super Map.Entry<K,V>> mapper)

Specified by:

mapToDouble in interface Stream<Map.Entry<K,V>>

flatMap

public <R> Stream<R> flatMap(Function<? super Map.Entry<K,V>,? extends Stream<? extends R>> mapper)

Specified by:

flatMap in interface Stream<Map.Entry<K,V>>

flatMapToInt

public IntStream flatMapToInt(Function<? super Map.Entry<K,V>,? extends IntStream> mapper)

Specified by:

flatMapToInt in interface Stream<Map.Entry<K,V>>

flatMapToLong

public LongStream flatMapToLong(Function<? super Map.Entry<K,V>,? extends LongStream> mapper)

Specified by:

flatMapToLong in interface Stream<Map.Entry<K,V>>

flatMapToDouble

public DoubleStream flatMapToDouble(Function<? super Map.Entry<K,V>,? extends DoubleStream> mapper)

Specified by:

flatMapToDouble in interface Stream<Map.Entry<K,V>>

distinct

public MapStream<K,V> distinct()

Specified by:

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

sorted

public MapStream<K,V> sorted()

Specified by:

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

sorted

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

Specified by:

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

peek

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

Specified by:

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

limit

public MapStream<K,V> limit(long maxSize)

Specified by:

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

skip

public MapStream<K,V> skip(long n)

Specified by:

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

forEach

public void forEach(Consumer<? super Map.Entry<K,V>> action)

Specified by:

forEach in interface Stream<Map.Entry<K,V>>

forEachOrdered

public void forEachOrdered(Consumer<? super Map.Entry<K,V>> action)

Specified by:

forEachOrdered in interface Stream<Map.Entry<K,V>>

toArray

public Object[] toArray()

Specified by:

toArray in interface Stream<Map.Entry<K,V>>

toArray

public <A> A[] toArray(IntFunction<A[]> generator)

Specified by:

toArray in interface Stream<Map.Entry<K,V>>

reduce

public Map.Entry<K,V> reduce(Map.Entry<K,V> identity,
                             BinaryOperator<Map.Entry<K,V>> accumulator)

Specified by:

reduce in interface Stream<Map.Entry<K,V>>

reduce

public Optional<Map.Entry<K,V>> reduce(BinaryOperator<Map.Entry<K,V>> accumulator)

Specified by:

reduce in interface Stream<Map.Entry<K,V>>

reduce

public <U> U reduce(U identity,
                    BiFunction<U,? super Map.Entry<K,V>,U> accumulator,
                    BinaryOperator<U> combiner)

Specified by:

reduce in interface Stream<Map.Entry<K,V>>

collect

public <R> R collect(Supplier<R> supplier,
                     BiConsumer<R,? super Map.Entry<K,V>> accumulator,
                     BiConsumer<R,R> combiner)

Specified by:

collect in interface Stream<Map.Entry<K,V>>

collect

public <R,A> R collect(Collector<? super Map.Entry<K,V>,A,R> collector)

Specified by:

collect in interface Stream<Map.Entry<K,V>>

min

public Optional<Map.Entry<K,V>> min(Comparator<? super Map.Entry<K,V>> comparator)

Specified by:

min in interface Stream<Map.Entry<K,V>>

max

public Optional<Map.Entry<K,V>> max(Comparator<? super Map.Entry<K,V>> comparator)

Specified by:

max in interface Stream<Map.Entry<K,V>>

count

public long count()

Specified by:

count in interface Stream<Map.Entry<K,V>>

anyMatch

public boolean anyMatch(Predicate<? super Map.Entry<K,V>> predicate)

Specified by:

anyMatch in interface Stream<Map.Entry<K,V>>

allMatch

public boolean allMatch(Predicate<? super Map.Entry<K,V>> predicate)

Specified by:

allMatch in interface Stream<Map.Entry<K,V>>

noneMatch

public boolean noneMatch(Predicate<? super Map.Entry<K,V>> predicate)

Specified by:

noneMatch in interface Stream<Map.Entry<K,V>>

findFirst

public Optional<Map.Entry<K,V>> findFirst()

Specified by:

findFirst in interface Stream<Map.Entry<K,V>>

findAny

public Optional<Map.Entry<K,V>> findAny()

Specified by:

findAny in interface Stream<Map.Entry<K,V>>

iterator

public Iterator<Map.Entry<K,V>> iterator()

Specified by:

iterator in interface BaseStream<Map.Entry<K,V>,Stream<Map.Entry<K,V>>>

spliterator

public Spliterator<Map.Entry<K,V>> spliterator()

Specified by:

spliterator in interface BaseStream<Map.Entry<K,V>,Stream<Map.Entry<K,V>>>

isParallel

public boolean isParallel()

Specified by:

isParallel in interface BaseStream<Map.Entry<K,V>,Stream<Map.Entry<K,V>>>

sequential

public MapStream<K,V> sequential()

Specified by:

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

parallel

public MapStream<K,V> parallel()

Specified by:

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

unordered

public MapStream<K,V> unordered()

Specified by:

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

onClose

public MapStream<K,V> onClose(Runnable closeHandler)

Specified by:

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

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BaseStream<Map.Entry<K,V>,Stream<Map.Entry<K,V>>>