org.beryx.streamplify

Class StreamableProxy<T,S extends StreamableProxy<T,S>>

java.lang.Object

org.beryx.streamplify.StreamableProxy<T,S>

All Implemented Interfaces:

Streamable<T,S>

Direct Known Subclasses:

CartesianProduct, Combinations, Derangements, PartialPermutations, Permutations, PowerSet

public abstract class StreamableProxy<T,S extends StreamableProxy<T,S>>
extends java.lang.Object
implements Streamable<T,S>

A Streamable that forwards its calls to a delegate

Constructor Summary

Constructors

Constructor and Description
StreamableProxy()

Method Summary

Modifier and Type	Method and Description
java.math.BigInteger	bigCount()
long	count()
protected abstract Streamable<T,?>	getDelegate()
java.util.stream.Stream<T>	parallelStream()
<Z extends Streamable<T,?>> Z	shuffle(java.util.Random rnd) Configure this instance to provide streams that shuffle elements in the data source.
<Z extends Streamable<T,?>> Z	skip(java.math.BigInteger n) Configure this instance to provide streams that skip the first {}@code n} elements in the data source.
<Z extends Streamable<T,?>> Z	skip(long n) Configure this instance to provide streams that skip the first {}@code n} elements in the data source.
java.util.stream.Stream<T>	stream()
S	withAdditionalCharacteristics(int additionalCharacteristics) Adds additionalCharacteristics to the provided streams.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.beryx.streamplify.Streamable

ordered, shuffle

Constructor Detail

StreamableProxy

public StreamableProxy()

Method Detail

getDelegate

protected abstract Streamable<T,?> getDelegate()

Returns:

the delegate to which method calls are forwarded.

withAdditionalCharacteristics

public S withAdditionalCharacteristics(int additionalCharacteristics)

Description copied from interface: Streamable

Adds additionalCharacteristics to the provided streams.

Specified by:

withAdditionalCharacteristics in interface Streamable<T,S extends StreamableProxy<T,S>>

Returns:

this instance

stream

public java.util.stream.Stream<T> stream()

Specified by:

stream in interface Streamable<T,S extends StreamableProxy<T,S>>

Returns:

a sequential Stream

parallelStream

public java.util.stream.Stream<T> parallelStream()

Specified by:

parallelStream in interface Streamable<T,S extends StreamableProxy<T,S>>

Returns:

a possibly parallel Stream

count

public long count()

Specified by:

count in interface Streamable<T,S extends StreamableProxy<T,S>>

Returns:

the number of elements in the data source, or -1 if the number is too big to fit in a long.

bigCount

public java.math.BigInteger bigCount()

Specified by:

bigCount in interface Streamable<T,S extends StreamableProxy<T,S>>

Returns:

the number of elements in the data source as BigInteger.

skip

public <Z extends Streamable<T,?>> Z skip(long n)

Description copied from interface: Streamable

Configure this instance to provide streams that skip the first {}@code n} elements in the data source. It is usually more efficient to call this method instead of Stream.skip(long).

Specified by:

skip in interface Streamable<T,S extends StreamableProxy<T,S>>

Parameters:

n - the number of elements to be skipped (as a long).

Returns:

depending on the implementation, it may return this instance or another Streamable.

skip

public <Z extends Streamable<T,?>> Z skip(java.math.BigInteger n)

Description copied from interface: Streamable

Configure this instance to provide streams that skip the first {}@code n} elements in the data source.

Specified by:

skip in interface Streamable<T,S extends StreamableProxy<T,S>>

Parameters:

n - the number of elements to be skipped (as a BigInteger).

Returns:

depending on the implementation, it may return this instance or another Streamable.

shuffle

public <Z extends Streamable<T,?>> Z shuffle(java.util.Random rnd)

Description copied from interface: Streamable

Configure this instance to provide streams that shuffle elements in the data source.

Specified by:

shuffle in interface Streamable<T,S extends StreamableProxy<T,S>>

Parameters:

rnd - the random number generator to be used to perform the shuffling.

Returns:

depending on the implementation, it may return this instance or another Streamable.