org.beryx.streamplify

Interface Streamable<T,S extends Streamable<T,S>>

All Known Implementing Classes:

BigIntegerCartesianProduct, BigIntegerCombinations, BigIntegerDerangements, BigIntegerIndexedSpliterator, BigIntegerPartialPermutations, BigIntegerPermutations, BigIntegerPowerSet, CartesianProduct, Combinations, Derangements, LongCartesianProduct, LongCombinations, LongDerangements, LongIndexedSpliterator, LongPartialPermutations, LongPermutations, LongPowerSet, PartialPermutations, Permutations, PowerSet, StreamableProxy

public interface Streamable<T,S extends Streamable<T,S>>

Objects implementing this interface provide data in form of sequential or parallel Streams.

Method Summary

Modifier and Type	Method and Description
java.math.BigInteger	bigCount()
long	count()
default S	ordered() Convenience method for adding the Spliterator.ORDERED characteristic to the provided streams.
java.util.stream.Stream<T>	parallelStream()
default <Z extends Streamable<T,?>> Z	shuffle() Configure this instance to provide streams that shuffle elements in the data source.
<Z extends Streamable<T,?>> Z	shuffle(java.util.Random random) 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.

Method Detail

stream

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

Returns:

a sequential Stream

parallelStream

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

Returns:

a possibly parallel Stream

count

long count()

Returns:

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

bigCount

java.math.BigInteger bigCount()

Returns:

the number of elements in the data source as BigInteger.

withAdditionalCharacteristics

S withAdditionalCharacteristics(int additionalCharacteristics)

Adds additionalCharacteristics to the provided streams.

Returns:

this instance

ordered

default S ordered()

Convenience method for adding the Spliterator.ORDERED characteristic to the provided streams.

Returns:

this instance

skip

<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. It is usually more efficient to call this method instead of Stream.skip(long).

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

<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.

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

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

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

Parameters:

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

Returns:

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

shuffle

default <Z extends Streamable<T,?>> Z shuffle()

Configure this instance to provide streams that shuffle elements in the data source.
This default implementation calls shuffle(Random) with a random number generator created using the parameterless constructor of Random.

Returns:

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