Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.stream.internal

Class MergingSpliterator<T,O>

java.lang.Object

org.tquadrat.foundation.stream.internal.MergingSpliterator<T,O>

Type Parameters:

T - The type over which the merged streams stream.

O - The type of the accumulator, over which the constructed stream streams.

All Implemented Interfaces:

Spliterator<O>

@ClassVersion(sourceVersion="$Id: MergingSpliterator.java 1119 2024-03-16 09:03:57Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.7")
public final class MergingSpliterator<T,O>
extends Object
implements Spliterator<O>

An implementation of Spliterator that merges streams.

Author:

Dominic Fox

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: MergingSpliterator.java 1119 2024-03-16 09:03:57Z tquadrat $

Since:

0.0.7

UML Diagram

⁠

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

⁠

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 final BiFunction<O,T,O>	m_Merger	The merger function.
private final Spliterator<T>[]	m_Sources	The sources.
private final Supplier<O>	m_UnitSupplier	The unit supplier.

Fields inherited from interface java.util.Spliterator

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MergingSpliterator(Spliterator<T>[] sources, Supplier<O> unitSupplier, BiFunction<O,T,O> merger)	Creates a new MergingSpliterator instance.

Method Summary

Modifier and Type	Method	Description
final int	characteristics()
final long	estimateSize()
static final <T, O> Spliterator<O>	merging(Spliterator<T>[] sources, Supplier<O> unitSupplier, BiFunction<O,T,O> merger)	Factory method for instances of MergingSpliterator.
final boolean	tryAdvance(Consumer<? super O> action)
final Spliterator<O>	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, getExactSizeIfKnown, hasCharacteristics

Field Details

m_Merger

private final BiFunction<O,T,O> m_Merger

The merger function.

m_Sources

private final Spliterator<T>[] m_Sources

The sources.

m_UnitSupplier

private final Supplier<O> m_UnitSupplier

The unit supplier.

Constructor Details

MergingSpliterator

private MergingSpliterator(Spliterator<T>[] sources,
 Supplier<O> unitSupplier,
 BiFunction<O,T,O> merger)

Creates a new MergingSpliterator instance.

Parameters:

sources - The sources.

unitSupplier - Supplies the initial "zero" or "unit" value for the accumulator.

merger - Merges each item from the collection of values taken from the source streams into the accumulator value.

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>

merging

public static final <T,
O> Spliterator<O> merging(Spliterator<T>[] sources,
 Supplier<O> unitSupplier,
 BiFunction<O,T,O> merger)

Factory method for instances of MergingSpliterator.

Type Parameters:

T - The type of the elements in the source spliterators.

O - The type of the elements in the resulting spliterator.

Parameters:

sources - The sources.

unitSupplier - Supplies the initial "zero" or "unit" value for the accumulator.

merger - Merges each item from the collection of values taken from the source streams into the accumulator value.

Returns:

The new instance.

tryAdvance

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

Specified by:

tryAdvance in interface Spliterator<T>

trySplit

public final Spliterator<O> trySplit()

Specified by:

trySplit in interface Spliterator<T>