uk.co.strangeskies.collection.stream

Interface BaseStreamDecorator<T,S extends java.util.stream.BaseStream<T,S>>

Type Parameters:

T - the type of the elements of the stream

S - the type of the stream

All Superinterfaces:

java.lang.AutoCloseable, java.util.stream.BaseStream<T,S>

All Known Subinterfaces:

DoubleStreamDecorator, IntStreamDecorator, LongStreamDecorator, StreamDecorator<T>

All Known Implementing Classes:

ResourceStream, ResourceStream.DoubleResourceStream, ResourceStream.IntResourceStream, ResourceStream.LongResourceStream, ResourceStream.ReferenceResourceStream

public interface BaseStreamDecorator<T,S extends java.util.stream.BaseStream<T,S>>
extends java.util.stream.BaseStream<T,S>

A decorator for a BaseStream which wraps intermediate and terminal operations such that they can be easily extended.

Intermediate operations will return a wrapper over the result of applying that operation to the component, such that raw references to component streams cannot escape their wrapping.

Method Summary

Modifier and Type	Method and Description
default void	close()
S	decorateIntermediate(java.util.function.Function<? super S,S> transformation)
java.util.stream.DoubleStream	decorateIntermediateDouble(java.util.function.Function<? super S,java.util.stream.DoubleStream> transformation)
java.util.stream.IntStream	decorateIntermediateInt(java.util.function.Function<? super S,java.util.stream.IntStream> transformation)
java.util.stream.LongStream	decorateIntermediateLong(java.util.function.Function<? super S,java.util.stream.LongStream> transformation)
<U> StreamDecorator<U>	decorateIntermediateReference(java.util.function.Function<? super S,java.util.stream.Stream<U>> transformation)
default <U> U	decorateTerminal(java.util.function.Function<? super S,? extends U> termination)
default void	decorateVoidTerminal(java.util.function.Consumer<? super S> termination)
S	getComponent()
default boolean	isParallel()
default java.util.Iterator<T>	iterator()
default S	onClose(java.lang.Runnable closeHandler)
default S	parallel()
default S	sequential()
default java.util.Spliterator<T>	spliterator()
default S	unordered()

Method Detail

getComponent

S getComponent()

Returns:

the component reference

decorateIntermediate

S decorateIntermediate(java.util.function.Function<? super S,S> transformation)

Parameters:

transformation - the intermediate operation as a function on a stream

Returns:

a decorated instance of the result of application of the transformation to the component

decorateIntermediateReference

<U> StreamDecorator<U> decorateIntermediateReference(java.util.function.Function<? super S,java.util.stream.Stream<U>> transformation)

Type Parameters:

U - the type of the resulting stream elements

Parameters:

transformation - the intermediate operation as a function on a stream

Returns:

a decorated instance of the result of application of the transformation to the component

decorateIntermediateInt

java.util.stream.IntStream decorateIntermediateInt(java.util.function.Function<? super S,java.util.stream.IntStream> transformation)

Parameters:

transformation - the intermediate operation as a function on a stream

Returns:

a decorated instance of the result of application of the transformation to the component

decorateIntermediateLong

java.util.stream.LongStream decorateIntermediateLong(java.util.function.Function<? super S,java.util.stream.LongStream> transformation)

Parameters:

transformation - the intermediate operation as a function on a stream

Returns:

a decorated instance of the result of application of the transformation to the component

decorateIntermediateDouble

java.util.stream.DoubleStream decorateIntermediateDouble(java.util.function.Function<? super S,java.util.stream.DoubleStream> transformation)

Parameters:

transformation - the intermediate operation as a function on a stream

Returns:

a decorated instance of the result of application of the transformation to the component

decorateTerminal

default <U> U decorateTerminal(java.util.function.Function<? super S,? extends U> termination)

Type Parameters:

U - the type of the termination result

Parameters:

termination - the terminal operation as a function on a stream

Returns:

the result of application of the termination to the component stream

decorateVoidTerminal

default void decorateVoidTerminal(java.util.function.Consumer<? super S> termination)

Parameters:

termination - the terminal operation as a function on a stream

sequential

default S sequential()

Specified by:

sequential in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>

parallel

default S parallel()

Specified by:

parallel in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>

unordered

default S unordered()

Specified by:

unordered in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>

onClose

default S onClose(java.lang.Runnable closeHandler)

Specified by:

onClose in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>

iterator

default java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>

spliterator

default java.util.Spliterator<T> spliterator()

Specified by:

spliterator in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>

isParallel

default boolean isParallel()

Specified by:

isParallel in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>

close

default void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.util.stream.BaseStream<T,S extends java.util.stream.BaseStream<T,S>>