Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.stream.internal

Class TakeWhileSpliterator<T>

java.lang.Object

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

Type Parameters:

T - The type of the stream elements.

All Implemented Interfaces:

Spliterator<T>

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

An implementation of Spliterator that takes elements from a stream while the given Predicate returns true.

Author:

Dominic Fox

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.7

UML Diagram

⁠

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

⁠

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 Predicate<T>	m_Condition	The condition for the spliterator.
private boolean	m_ConditionHolds	Flag that indicates whether the condition still returns true.
private final Spliterator<T>	m_Source	The source.

Fields inherited from interface java.util.Spliterator

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TakeWhileSpliterator(Spliterator<T> source, Predicate<T> condition)	Creates a new TakeWhileSpliterator instance.

Method Summary

Modifier and Type	Method	Description
final int	characteristics()
final long	estimateSize()
static final <T> TakeWhileSpliterator<T>	over(Spliterator<T> source, Predicate<T> condition)	Factory method for instances of TakeWhileSpliterator.
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, getExactSizeIfKnown, hasCharacteristics

Field Details

m_Condition

private final Predicate<T> m_Condition

The condition for the spliterator.

m_ConditionHolds

private boolean m_ConditionHolds

Flag that indicates whether the condition still returns true.

m_Source

private final Spliterator<T> m_Source

The source.

Constructor Details

TakeWhileSpliterator

private TakeWhileSpliterator(Spliterator<T> source,
 Predicate<T> condition)

Creates a new TakeWhileSpliterator instance.

Parameters:

source - The source.

condition - The condition for the new instance.

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>

over

public static final <T> TakeWhileSpliterator<T> over(Spliterator<T> source,
 Predicate<T> condition)

Factory method for instances of TakeWhileSpliterator.

Type Parameters:

T - The type of the stream elements.

Parameters:

source - The source.

condition - The condition for the new instance.

Returns:

The new instance.

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>