Package com.valqueries

Class StreamCloser<T>

java.lang.Object

com.valqueries.StreamCloser<T>

All Implemented Interfaces:

AutoCloseable, BaseStream<T,Stream<T>>, Stream<T>

public class StreamCloser<T>
extends Object
implements Stream<T>

Stream wrapper that calls close() on terminal operations. Mapping to primitive streams causes the underlying stream to collect to a list and close, as we need to ensure that the underlying resource is closed.

Nested Class Summary

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

Stream.Builder<T extends Object>

Constructor Summary

Constructors

Constructor	Description
StreamCloser(Stream<T> stream)

Method Summary

Modifier and Type	Method	Description
boolean	allMatch(Predicate<? super T> predicate)
boolean	anyMatch(Predicate<? super T> predicate)
void	close()
<R> R	collect(Supplier<R> supplier, BiConsumer<R,? super T> biConsumer, BiConsumer<R,R> biConsumer1)
<R, A> R	collect(Collector<? super T,A,R> collector)
long	count()
Stream<T>	distinct()
Stream<T>	dropWhile(Predicate<? super T> predicate)
Stream<T>	filter(Predicate<? super T> predicate)
Optional<T>	findAny()
Optional<T>	findFirst()
<R> Stream<R>	flatMap(Function<? super T,? extends Stream<? extends R>> function)
DoubleStream	flatMapToDouble(Function<? super T,? extends DoubleStream> function)
IntStream	flatMapToInt(Function<? super T,? extends IntStream> function)
LongStream	flatMapToLong(Function<? super T,? extends LongStream> function)
void	forEach(Consumer<? super T> consumer)
void	forEachOrdered(Consumer<? super T> consumer)
boolean	isParallel()
Iterator<T>	iterator()
Stream<T>	limit(long l)
<R> Stream<R>	map(Function<? super T,? extends R> function)
<R> Stream<R>	mapMulti(BiConsumer<? super T,? super Consumer<R>> mapper)
DoubleStream	mapMultiToDouble(BiConsumer<? super T,? super DoubleConsumer> mapper)
IntStream	mapMultiToInt(BiConsumer<? super T,? super IntConsumer> mapper)
LongStream	mapMultiToLong(BiConsumer<? super T,? super LongConsumer> mapper)
DoubleStream	mapToDouble(ToDoubleFunction<? super T> toDoubleFunction)
IntStream	mapToInt(ToIntFunction<? super T> toIntFunction)
LongStream	mapToLong(ToLongFunction<? super T> toLongFunction)
Optional<T>	max(Comparator<? super T> comparator)
Optional<T>	min(Comparator<? super T> comparator)
Iterator<T>	nonClosingIterator()
boolean	noneMatch(Predicate<? super T> predicate)
Stream<T>	onClose(Runnable runnable)	Works the same as the base BaseStream.onClose(Runnable) but note that the `StreamCloser` may in some circumstances close and create a new backing list for some operations.
Stream<T>	parallel()
Stream<T>	peek(Consumer<? super T> consumer)
Optional<T>	reduce(BinaryOperator<T> binaryOperator)
T	reduce(T t, BinaryOperator<T> binaryOperator)
<U> U	reduce(U u, BiFunction<U,? super T,U> biFunction, BinaryOperator<U> binaryOperator)
Stream<T>	sequential()
Stream<T>	skip(long l)
Stream<T>	sorted()
Stream<T>	sorted(Comparator<? super T> comparator)
Spliterator<T>	spliterator()
Stream<T>	takeWhile(Predicate<? super T> predicate)
Object[]	toArray()
<A> A[]	toArray(IntFunction<A[]> intFunction)
List<T>	toList()
Stream<T>	unordered()

Methods inherited from class java.lang.Object

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

Constructor Details

StreamCloser

public StreamCloser(Stream<T> stream)

Method Details

filter

public Stream<T> filter(Predicate<? super T> predicate)

Specified by:

filter in interface Stream<T>

map

public <R> Stream<R> map(Function<? super T,? extends R> function)

Specified by:

map in interface Stream<T>

mapToInt

public IntStream mapToInt(ToIntFunction<? super T> toIntFunction)

Specified by:

mapToInt in interface Stream<T>

mapToLong

public LongStream mapToLong(ToLongFunction<? super T> toLongFunction)

Specified by:

mapToLong in interface Stream<T>

mapToDouble

public DoubleStream mapToDouble(ToDoubleFunction<? super T> toDoubleFunction)

Specified by:

mapToDouble in interface Stream<T>

flatMap

public <R> Stream<R> flatMap(Function<? super T,? extends Stream<? extends R>> function)

Specified by:

flatMap in interface Stream<T>

flatMapToInt

public IntStream flatMapToInt(Function<? super T,? extends IntStream> function)

Specified by:

flatMapToInt in interface Stream<T>

flatMapToLong

public LongStream flatMapToLong(Function<? super T,? extends LongStream> function)

Specified by:

flatMapToLong in interface Stream<T>

flatMapToDouble

public DoubleStream flatMapToDouble(Function<? super T,? extends DoubleStream> function)

Specified by:

flatMapToDouble in interface Stream<T>

mapMulti

public <R> Stream<R> mapMulti(BiConsumer<? super T,? super Consumer<R>> mapper)

Specified by:

mapMulti in interface Stream<T>

mapMultiToInt

public IntStream mapMultiToInt(BiConsumer<? super T,? super IntConsumer> mapper)

Specified by:

mapMultiToInt in interface Stream<T>

mapMultiToLong

public LongStream mapMultiToLong(BiConsumer<? super T,? super LongConsumer> mapper)

Specified by:

mapMultiToLong in interface Stream<T>

mapMultiToDouble

public DoubleStream mapMultiToDouble(BiConsumer<? super T,? super DoubleConsumer> mapper)

Specified by:

mapMultiToDouble in interface Stream<T>

distinct

public Stream<T> distinct()

Specified by:

distinct in interface Stream<T>

sorted

public Stream<T> sorted()

Specified by:

sorted in interface Stream<T>

sorted

public Stream<T> sorted(Comparator<? super T> comparator)

Specified by:

sorted in interface Stream<T>

peek

public Stream<T> peek(Consumer<? super T> consumer)

Specified by:

peek in interface Stream<T>

limit

public Stream<T> limit(long l)

Specified by:

limit in interface Stream<T>

skip

public Stream<T> skip(long l)

Specified by:

skip in interface Stream<T>

takeWhile

public Stream<T> takeWhile(Predicate<? super T> predicate)

Specified by:

takeWhile in interface Stream<T>

dropWhile

public Stream<T> dropWhile(Predicate<? super T> predicate)

Specified by:

dropWhile in interface Stream<T>

forEach

public void forEach(Consumer<? super T> consumer)

Specified by:

forEach in interface Stream<T>

forEachOrdered

public void forEachOrdered(Consumer<? super T> consumer)

Specified by:

forEachOrdered in interface Stream<T>

toArray

@Nonnull
public Object[] toArray()

Specified by:

toArray in interface Stream<T>

toArray

@Nonnull
public <A> A[] toArray(IntFunction<A[]> intFunction)

Specified by:

toArray in interface Stream<T>

reduce

public T reduce(T t,
 BinaryOperator<T> binaryOperator)

Specified by:

reduce in interface Stream<T>

reduce

@Nonnull
public Optional<T> reduce(BinaryOperator<T> binaryOperator)

Specified by:

reduce in interface Stream<T>

reduce

public <U> U reduce(U u,
 BiFunction<U,? super T,U> biFunction,
 BinaryOperator<U> binaryOperator)

Specified by:

reduce in interface Stream<T>

collect

public <R> R collect(Supplier<R> supplier,
 BiConsumer<R,? super T> biConsumer,
 BiConsumer<R,R> biConsumer1)

Specified by:

collect in interface Stream<T>

collect

public <R,
A> R collect(Collector<? super T,A,R> collector)

Specified by:

collect in interface Stream<T>

toList

public List<T> toList()

Specified by:

toList in interface Stream<T>

min

@Nonnull
public Optional<T> min(Comparator<? super T> comparator)

Specified by:

min in interface Stream<T>

max

@Nonnull
public Optional<T> max(Comparator<? super T> comparator)

Specified by:

max in interface Stream<T>

count

public long count()

Specified by:

count in interface Stream<T>

anyMatch

public boolean anyMatch(Predicate<? super T> predicate)

Specified by:

anyMatch in interface Stream<T>

allMatch

public boolean allMatch(Predicate<? super T> predicate)

Specified by:

allMatch in interface Stream<T>

noneMatch

public boolean noneMatch(Predicate<? super T> predicate)

Specified by:

noneMatch in interface Stream<T>

findFirst

@Nonnull
public Optional<T> findFirst()

Specified by:

findFirst in interface Stream<T>

findAny

@Nonnull
public Optional<T> findAny()

Specified by:

findAny in interface Stream<T>

iterator

@Nonnull
public Iterator<T> iterator()

Specified by:

iterator in interface BaseStream<T,Stream<T>>

nonClosingIterator

public Iterator<T> nonClosingIterator()

Returns:

an iterator that does not close the stream. Make sure this stream is closed after the iterator is used.

spliterator

@Nonnull
public Spliterator<T> spliterator()

Specified by:

spliterator in interface BaseStream<T,Stream<T>>

isParallel

public boolean isParallel()

Specified by:

isParallel in interface BaseStream<T,Stream<T>>

sequential

@Nonnull
public Stream<T> sequential()

Specified by:

sequential in interface BaseStream<T,Stream<T>>

parallel

@Nonnull
public Stream<T> parallel()

Specified by:

parallel in interface BaseStream<T,Stream<T>>

unordered

@Nonnull
public Stream<T> unordered()

Specified by:

unordered in interface BaseStream<T,Stream<T>>

onClose

@Nonnull
public Stream<T> onClose(@Nonnull
 Runnable runnable)

Works the same as the base BaseStream.onClose(Runnable) but note that the `StreamCloser` may in some circumstances close and create a new backing list for some operations. As such any runnable bound in this way is only guaranteed to be run after any operations which were specified before it was bound.

E.g. the following code may produce different execution timings for `x`, depending on the underlying stream source:

 stream.onClose(x).mapToInt(mapper);
 
 

compared to

 stream.mapToInt(mapper).onClose(x);
 
 

Specified by:

onClose in interface BaseStream<T,Stream<T>>

Parameters:

runnable - A task to execute when the stream is closed

Returns:

a stream with a handler that is run if the stream is closed

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BaseStream<T,Stream<T>>