net.openhft.chronicle.wire.domestic.stream

Class Streams

java.lang.Object

net.openhft.chronicle.wire.domestic.stream.Streams

public final class Streams
extends Object

Factories to create standard Stream and related objects from Chronicle Queues and other MarshallableIn types.

If the provided extractor is reusing objects, then care must be taken in the returned objects (e.g. Streams, Spliterators and Iterators) to account for this.

Generally, these objects will create underlying objects and should not be used in JVMs running deterministic low-latency code. Instead, they are suitable for convenient off-line analysis of queue content.

Method Summary

Modifier and Type	Method and Description
static <T> @NotNull Iterator<T>	iterator(@NotNull MarshallableIn documentProvider, @NotNull DocumentExtractor<T> extractor) Creates and returns a new Iterator whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.
static PrimitiveIterator.OfDouble	iteratorOfDouble(@NotNull MarshallableIn documentProvider, @NotNull ToDoubleDocumentExtractor extractor) Creates and returns a new PrimitiveIterator.OfDouble whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.
static PrimitiveIterator.OfLong	iteratorOfLong(@NotNull MarshallableIn documentProvider, @NotNull ToLongDocumentExtractor extractor) Creates and returns a new PrimitiveIterator.OfLong whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.
static <T> @NotNull Stream<T>	of(@NotNull MarshallableIn documentProvider, @NotNull DocumentExtractor<T> extractor) Creates and returns a new sequential ordered Stream whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.
static @NotNull DoubleStream	ofDouble(@NotNull MarshallableIn documentProvider, @NotNull ToDoubleDocumentExtractor extractor) Creates and returns a new sequential ordered DoubleStream whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.
static @NotNull LongStream	ofLong(@NotNull MarshallableIn documentProvider, @NotNull ToLongDocumentExtractor extractor) Creates and returns a new sequential ordered LongStream whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.
static <T> @NotNull Spliterator<T>	spliterator(@NotNull MarshallableIn documentProvider, @NotNull DocumentExtractor<T> extractor) Creates and returns a new ordered Spliterator whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider, with no initial size estimate.
static Spliterator.OfDouble	spliteratorOfDouble(@NotNull MarshallableIn documentProvider, @NotNull ToDoubleDocumentExtractor extractor) Creates and returns a new ordered Spliterator.OfDouble whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider, with no initial size estimate.
static Spliterator.OfLong	spliteratorOfLong(@NotNull MarshallableIn documentProvider, @NotNull ToLongDocumentExtractor extractor) Creates and returns a new ordered Spliterator.OfLong whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider, with no initial size estimate.

Methods inherited from class java.lang.Object

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

Method Detail

of

@NotNull
public static <T> @NotNull Stream<T> of(@NotNull
                                                 @NotNull MarshallableIn documentProvider,
                                                 @NotNull
                                                 @NotNull DocumentExtractor<T> extractor)

Creates and returns a new sequential ordered Stream whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.

The Stream does not contain any null elements.

Tailers are handled in a thread-safe way and if a parallel stream is to be used, thread safety checks must be turned off using the ExcerptTailer#disableThreadSafetyCheck(boolean) method or else an Exception might be thrown during Stream evaluation.

Type Parameters:

T - the type of stream elements

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type T from excerpts

Returns:

the new stream

Throws:

NullPointerException - if any of the provided parameters are null

ofLong

@NotNull
public static @NotNull LongStream ofLong(@NotNull
                                                  @NotNull MarshallableIn documentProvider,
                                                  @NotNull
                                                  @NotNull ToLongDocumentExtractor extractor)

Creates and returns a new sequential ordered LongStream whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.

The Stream does not contain any Long.MIN_VALUE elements.

Tailers are handled in a thread-safe way and if a parallel stream is to be used, thread safety checks must be turned off using the ExcerptTailer#disableThreadSafetyCheck(boolean) method or else an Exception might be thrown during Stream evaluation.

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type long from excerpts

Returns:

the new stream

Throws:

NullPointerException - if any of the provided parameters are null

ofDouble

@NotNull
public static @NotNull DoubleStream ofDouble(@NotNull
                                                      @NotNull MarshallableIn documentProvider,
                                                      @NotNull
                                                      @NotNull ToDoubleDocumentExtractor extractor)

Creates and returns a new sequential ordered DoubleStream whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.

The Stream does not contain any Double.NaN elements.

Tailers are handled in a thread-safe way and if a parallel stream is to be used, thread safety checks must be turned off using the ExcerptTailer#disableThreadSafetyCheck(boolean) method or else an Exception might be thrown during Stream evaluation.

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type double from excerpts

Returns:

the new stream

Throws:

NullPointerException - if any of the provided parameters are null

spliterator

@NotNull
public static <T> @NotNull Spliterator<T> spliterator(@NotNull
                                                               @NotNull MarshallableIn documentProvider,
                                                               @NotNull
                                                               @NotNull DocumentExtractor<T> extractor)

Creates and returns a new ordered Spliterator whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider, with no initial size estimate.

The Spliterator does not contain any null elements.

The Spliterator implements trySplit to permit limited parallelism.

Tailers are handled in a thread-safe way and if a Spliterator splits are anticipated, thread safety checks must be turned off using the ExcerptTailer#disableThreadSafetyCheck(boolean) method or else an Exception might be thrown during splits.

Type Parameters:

T - the type of stream elements

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type T from excerpts

Returns:

the new Spliterator

Throws:

NullPointerException - if any of the provided parameters are null

spliteratorOfLong

@NotNull
public static Spliterator.OfLong spliteratorOfLong(@NotNull
                                                            @NotNull MarshallableIn documentProvider,
                                                            @NotNull
                                                            @NotNull ToLongDocumentExtractor extractor)

Creates and returns a new ordered Spliterator.OfLong whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider, with no initial size estimate.

The Spliterator does not contain any Long.MIN_VALUE elements.

The Spliterator implements trySplit to permit limited parallelism.

Tailers are handled in a thread-safe way and if a Spliterator splits are anticipated, thread safety checks must be turned off using the ExcerptTailer#disableThreadSafetyCheck(boolean) method or else an Exception might be thrown during splits.

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type long from excerpts

Returns:

the new Spliterator.OfLong

Throws:

NullPointerException - if any of the provided parameters are null

spliteratorOfDouble

@NotNull
public static Spliterator.OfDouble spliteratorOfDouble(@NotNull
                                                                @NotNull MarshallableIn documentProvider,
                                                                @NotNull
                                                                @NotNull ToDoubleDocumentExtractor extractor)

Creates and returns a new ordered Spliterator.OfDouble whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider, with no initial size estimate.

The Spliterator does not contain any Double.NaN elements.

The Spliterator implements trySplit to permit limited parallelism.

Tailers are handled in a thread-safe way and if a Spliterator splits are anticipated, thread safety checks must be turned off using the ExcerptTailer#disableThreadSafetyCheck(boolean) method or else an Exception might be thrown during splits.

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type double from excerpts

Returns:

the new Spliterator.OfDouble

Throws:

NullPointerException - if any of the provided parameters are null

iterator

@NotNull
public static <T> @NotNull Iterator<T> iterator(@NotNull
                                                         @NotNull MarshallableIn documentProvider,
                                                         @NotNull
                                                         @NotNull DocumentExtractor<T> extractor)

Creates and returns a new Iterator whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.

The Iterator does not contain any null elements.

The returned iterator is confined to a single thread.

Type Parameters:

T - the type of stream elements

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type T from excerpts

Returns:

the new Iterator

Throws:

NullPointerException - if any of the provided parameters are null

iteratorOfLong

@NotNull
public static PrimitiveIterator.OfLong iteratorOfLong(@NotNull
                                                               @NotNull MarshallableIn documentProvider,
                                                               @NotNull
                                                               @NotNull ToLongDocumentExtractor extractor)

Creates and returns a new PrimitiveIterator.OfLong whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.

The Iterator does not contain any Long.MIN_VALUE elements.

The returned iterator is confined to a single thread.

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type long from excerpts

Returns:

the new iterator

Throws:

NullPointerException - if any of the provided parameters are null

iteratorOfDouble

@NotNull
public static PrimitiveIterator.OfDouble iteratorOfDouble(@NotNull
                                                                   @NotNull MarshallableIn documentProvider,
                                                                   @NotNull
                                                                   @NotNull ToDoubleDocumentExtractor extractor)

Creates and returns a new PrimitiveIterator.OfDouble whose elements are obtained by successively applying the provided extractor on excerpts from the provided documentProvider.

The Iterator does not contain any Double.NaN elements.

The returned iterator is confined to a single thread.

Parameters:

documentProvider - from which excerpts are obtained

extractor - used to extract elements of type double from excerpts

Returns:

the new iterator

Throws:

NullPointerException - if any of the provided parameters are null