de.fhg.fokus.xtensions.iteration

Class PrimitiveIteratorExtensions

java.lang.Object

de.fhg.fokus.xtensions.iteration.PrimitiveIteratorExtensions

public final class PrimitiveIteratorExtensions
extends Object

This class contains static methods for the primitive iterators defined in PrimitiveIterator. The methods are intended to be used as extension methods. The class is not intended to be instantiated.

Since:

1.1.0

Method Summary

Modifier and Type	Method and Description
static DoubleStream	parallelStreamRemaining(PrimitiveIterator.OfDouble wrapped) Convenience method to turn a primitive iterator into a parallel stream.
static IntStream	parallelStreamRemaining(PrimitiveIterator.OfInt wrapped) Convenience method to turn a primitive iterator into a parallel stream.
static LongStream	parallelStreamRemaining(PrimitiveIterator.OfLong wrapped) Convenience method to turn a primitive iterator into a parallel stream.
static DoubleStream	streamRemaining(PrimitiveIterator.OfDouble wrapped) Convenience method to turn a primitive iterator into a stream.
static IntStream	streamRemaining(PrimitiveIterator.OfInt wrapped) Convenience method to turn a primitive iterator into a stream.
static LongStream	streamRemaining(PrimitiveIterator.OfLong wrapped) Convenience method to turn a primitive iterator into a stream.
static DoubleStream	streamRemainingExhaustive(PrimitiveIterator.OfDouble wrapped) Convenience method to turn a primitive iterator into a stream.
static IntStream	streamRemainingExhaustive(PrimitiveIterator.OfInt wrapped) Convenience method to turn a primitive iterator into a stream.
static LongStream	streamRemainingExhaustive(PrimitiveIterator.OfLong wrapped) Convenience method to turn a primitive iterator into a stream.
static DoubleSummaryStatistics	summarize(PrimitiveIterator.OfDouble iterator) This method will read all remaining double values from the given iterator and creates and returns an DoubleSummaryStatistics over all these elements.
static IntSummaryStatistics	summarize(PrimitiveIterator.OfInt iterator) This method will read all remaining int values from the given iterator and creates and returns an IntSummaryStatistics over all these elements.
static LongSummaryStatistics	summarize(PrimitiveIterator.OfLong iterator) This method will read all remaining long values from the given iterator and creates and returns an LongSummaryStatistics over all these elements.

Methods inherited from class java.lang.Object

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

Method Detail

streamRemaining

public static IntStream streamRemaining(PrimitiveIterator.OfInt wrapped)

Convenience method to turn a primitive iterator into a stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null. Note that this method does not guarantee that the given iterator will be exhausted. If the underlying iterator implementation is known the stream may not pull elements from the wrapped iterator.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

See Also:

PrimitiveIteratorExtensions#streamRemainingExhaustive(OfInt)

streamRemainingExhaustive

public static IntStream streamRemainingExhaustive(PrimitiveIterator.OfInt wrapped)

Convenience method to turn a primitive iterator into a stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null. Note that this method does not guarantee that the given iterator will be exhausted. If the underlying iterator implementation is known the stream may not pull elements from the wrapped iterator in order to create a stream that may have better characteristics in some way.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

Since:

1.1.0

See Also:

PrimitiveIteratorExtensions#streamRemaining(OfInt)

parallelStreamRemaining

public static IntStream parallelStreamRemaining(PrimitiveIterator.OfInt wrapped)

Convenience method to turn a primitive iterator into a parallel stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null. Note that this method does not guarantee that the given iterator will be exhausted. If the underlying iterator implementation is known the stream may not pull elements from the wrapped iterator.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

summarize

public static IntSummaryStatistics summarize(PrimitiveIterator.OfInt iterator)

This method will read all remaining int values from the given iterator and creates and returns an IntSummaryStatistics over all these elements.

Parameters:

iterator - primitive iterator over elements to be summarized

Returns:

a statistics object over all elements in iterator

Throws:

NullPointerException - if iterator is null.

Since:

1.1.0

streamRemaining

public static LongStream streamRemaining(PrimitiveIterator.OfLong wrapped)

Convenience method to turn a primitive iterator into a stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null. Note that this method does not guarantee that the given iterator will be exhausted. If the underlying iterator implementation is known the stream may not pull elements from the wrapped iterator in order to create a stream that may have better characteristics in some way.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

See Also:

PrimitiveIteratorExtensions#streamRemainingExhaustive(OfLong)

streamRemainingExhaustive

public static LongStream streamRemainingExhaustive(PrimitiveIterator.OfLong wrapped)

Convenience method to turn a primitive iterator into a stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null. Note that this method does not guarantee that the given iterator will be exhausted. If the underlying iterator implementation is known the stream may not pull elements from the wrapped iterator.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

Since:

1.1.0

See Also:

PrimitiveIteratorExtensions#streamRemaining(OfLong)

parallelStreamRemaining

public static LongStream parallelStreamRemaining(PrimitiveIterator.OfLong wrapped)

Convenience method to turn a primitive iterator into a parallel stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

summarize

public static LongSummaryStatistics summarize(PrimitiveIterator.OfLong iterator)

This method will read all remaining long values from the given iterator and creates and returns an LongSummaryStatistics over all these elements.

Parameters:

iterator - primitive iterator over elements to be summarized

Returns:

a statistics object over all elements in iterator

Throws:

NullPointerException - if iterator is null.

Since:

1.1.0

streamRemaining

public static DoubleStream streamRemaining(PrimitiveIterator.OfDouble wrapped)

Convenience method to turn a primitive iterator into a stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null. Note that this method does not guarantee that the given iterator will be exhausted. If the underlying iterator implementation is known the stream may not pull elements from the wrapped iterator in order to create a stream that may have better characteristics in some way.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

See Also:

PrimitiveIteratorExtensions#streamRemainingExhaustive(OfDouble)

streamRemainingExhaustive

public static DoubleStream streamRemainingExhaustive(PrimitiveIterator.OfDouble wrapped)

Convenience method to turn a primitive iterator into a stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null. Note that this method does guarantee that the given iterator will be exhausted. All elements provided by the stream are taken from the wrapped iterator.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

Since:

1.1.0

See Also:

PrimitiveIteratorExtensions#streamRemaining(OfDouble)

parallelStreamRemaining

public static DoubleStream parallelStreamRemaining(PrimitiveIterator.OfDouble wrapped)

Convenience method to turn a primitive iterator into a parallel stream. Best effort transformation from iterator to stream. Does not make any assumptions, other than that the elements returned by the iterator are not null.

Parameters:

wrapped - the iterator from which the returned stream is created from

Returns:

stream providing the remaining elements from wrapped

summarize

public static DoubleSummaryStatistics summarize(PrimitiveIterator.OfDouble iterator)

This method will read all remaining double values from the given iterator and creates and returns an DoubleSummaryStatistics over all these elements.

Parameters:

iterator - primitive iterator over elements to be summarized

Returns:

a statistics object over all elements in iterator

Throws:

NullPointerException - if iterator is null.

Since:

1.1.0