Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.stream.internal

Class InterleavingSpliterator<T>

java.lang.Object

org.tquadrat.foundation.stream.internal.InterleavingSpliterator<T>

Type Parameters:

T - The type of the values to select from.

All Implemented Interfaces:

Spliterator<T>

@ClassVersion(sourceVersion="$Id: InterleavingSpliterator.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.7")
public final class InterleavingSpliterator<T>
extends Object
implements Spliterator<T>

A selector function takes an array of values and returns the respective array index for the selected value. See Selectors for some implementations of this interface.

Author:

Dominic Fox

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: InterleavingSpliterator.java 1060 2023-09-24 19:21:40Z tquadrat $

Since:

0.0.7

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.stream.internal.InterleavingSpliterator"

⁠

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields

Modifier and Type	Field	Description
private T[]	m_Buffer	The element buffer.
private final Supplier<T[]>	m_BufferSupplier	The supplier for the element buffer.
private final Function<T[],Integer>	m_Selector	The selector function.
private final Spliterator<T>[]	m_Spliterators	The source spliterators.

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InterleavingSpliterator(Spliterator<T>[] spliterators, Supplier<T[]> bufferSupplier, Function<T[],Integer> selector)	Creates a new InterleavingSpliterator instance.

Method Summary

Modifier and Type	Method	Description
final int	characteristics()
final long	estimateSize()
final long	getExactSizeIfKnown()
static final <T> Spliterator<T>	interleaving(Spliterator<T>[] spliterators, Selector<T> selector)	Factory method for instances of InterleavingSpliterator.
final boolean	tryAdvance(Consumer<? super T> action)
final Spliterator<T>	trySplit()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, hasCharacteristics

Field Details

m_Buffer

private T[] m_Buffer

The element buffer.

m_BufferSupplier

private final Supplier<T[]> m_BufferSupplier

The supplier for the element buffer.

m_Selector

private final Function<T[],Integer> m_Selector

The selector function.

m_Spliterators

private final Spliterator<T>[] m_Spliterators

The source spliterators.

Constructor Details

InterleavingSpliterator

private InterleavingSpliterator(Spliterator<T>[] spliterators,
 Supplier<T[]> bufferSupplier,
 Function<T[],Integer> selector)

Creates a new InterleavingSpliterator instance.

Parameters:

spliterators - The source spliterators.

bufferSupplier - The supplier for the element buffer.

selector - The selector function.

Method Details

characteristics

public final int characteristics()

Specified by:

characteristics in interface Spliterator<T>

estimateSize

public final long estimateSize()

Specified by:

estimateSize in interface Spliterator<T>

getExactSizeIfKnown

public final long getExactSizeIfKnown()

Specified by:

getExactSizeIfKnown in interface Spliterator<T>

interleaving

public static final <T> Spliterator<T> interleaving(Spliterator<T>[] spliterators,
 Selector<T> selector)

Factory method for instances of InterleavingSpliterator.

Type Parameters:

T - The type of the values to select from.

Parameters:

spliterators - The source spliterators.

selector - The selector function.

Returns:

The interleaving spliterator.

tryAdvance

public final boolean tryAdvance(Consumer<? super T> action)

Specified by:

tryAdvance in interface Spliterator<T>

trySplit

public final Spliterator<T> trySplit()

Specified by:

trySplit in interface Spliterator<T>