uk.co.strangeskies.collection.stream

Class ResourceStream<T,S extends java.util.stream.BaseStream<T,S>>

java.lang.Object

uk.co.strangeskies.collection.stream.ResourceStream<T,S>

Type Parameters:

T - the type of the elements of the stream

S - the type of the stream

All Implemented Interfaces:

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

Direct Known Subclasses:

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

public abstract class ResourceStream<T,S extends java.util.stream.BaseStream<T,S>>
extends java.lang.Object
implements BaseStreamDecorator<T,S>

A stream decorator over some sort of resource which only opens the resource upon invocation of a terminal operation, and then guarantees resource closure when the operation is complete.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ResourceStream.DoubleResourceStream
protected static class	ResourceStream.IntResourceStream
protected static class	ResourceStream.LongResourceStream
protected static class	ResourceStream.ReferenceResourceStream<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourceStream(S component, java.lang.Runnable openResource, java.lang.Runnable closeResource)

Method Summary

Modifier and Type	Method and Description
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)
<U> U	decorateTerminal(java.util.function.Function<? super S,? extends U> transformation)
void	decorateVoidTerminal(java.util.function.Consumer<? super S> transformation)
S	getComponent()
static java.util.stream.DoubleStream	over(java.util.stream.DoubleStream stream, java.lang.Runnable openResource, java.lang.Runnable closeResource)
static java.util.stream.IntStream	over(java.util.stream.IntStream stream, java.lang.Runnable openResource, java.lang.Runnable closeResource)
static java.util.stream.LongStream	over(java.util.stream.LongStream stream, java.lang.Runnable openResource, java.lang.Runnable closeResource)
static <U> StreamDecorator<U>	over(java.util.stream.Stream<U> stream, java.lang.Runnable openResource, java.lang.Runnable closeResource)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.co.strangeskies.collection.stream.BaseStreamDecorator

close, decorateIntermediate, isParallel, iterator, onClose, parallel, sequential, spliterator, unordered

Constructor Detail

ResourceStream

protected ResourceStream(S component,
                         java.lang.Runnable openResource,
                         java.lang.Runnable closeResource)

Method Detail

over

public static <U> StreamDecorator<U> over(java.util.stream.Stream<U> stream,
                                          java.lang.Runnable openResource,
                                          java.lang.Runnable closeResource)

Type Parameters:

U - the type of the elements of the stream

Parameters:

stream - a reference stream over the given resource strategy

openResource - the strategy to open the resource

closeResource - the strategy to close the resource

Returns:

a suitable implementation of ResourceStream over the given stream

over

public static java.util.stream.IntStream over(java.util.stream.IntStream stream,
                                              java.lang.Runnable openResource,
                                              java.lang.Runnable closeResource)

Parameters:

stream - an integer stream over the given resource strategy

openResource - the strategy to open the resource

closeResource - the strategy to close the resource

Returns:

a suitable implementation of ResourceStream over the given stream

over

public static java.util.stream.LongStream over(java.util.stream.LongStream stream,
                                               java.lang.Runnable openResource,
                                               java.lang.Runnable closeResource)

Parameters:

stream - a long stream over the given resource strategy

openResource - the strategy to open the resource

closeResource - the strategy to close the resource

Returns:

a suitable implementation of ResourceStream over the given stream

over

public static java.util.stream.DoubleStream over(java.util.stream.DoubleStream stream,
                                                 java.lang.Runnable openResource,
                                                 java.lang.Runnable closeResource)

Parameters:

stream - a double stream over the given resource strategy

openResource - the strategy to open the resource

closeResource - the strategy to close the resource

Returns:

a suitable implementation of ResourceStream over the given stream

getComponent

public S getComponent()

Specified by:

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

Returns:

the component reference

decorateIntermediateReference

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

Specified by:

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

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

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

Specified by:

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

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

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

Specified by:

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

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

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

Specified by:

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

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

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

Specified by:

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

Type Parameters:

U - the type of the termination result

Parameters:

transformation - the terminal operation as a function on a stream

Returns:

the result of application of the termination to the component stream

decorateVoidTerminal

public void decorateVoidTerminal(java.util.function.Consumer<? super S> transformation)

Specified by:

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

Parameters:

transformation - the terminal operation as a function on a stream