de.caff.generics

Interface PrimitiveBooleanIterator

All Superinterfaces:

java.util.Iterator<java.lang.Boolean>, java.util.PrimitiveIterator<java.lang.Boolean,BooleanConsumer>

public interface PrimitiveBooleanIterator
extends java.util.PrimitiveIterator<java.lang.Boolean,BooleanConsumer>

An iterator specialized for boolean values.

This is missing in the standard library: an iterator for raw boolean values which does everything what OfInt does for [@code int}s.

Since:

September 27, 2020

Author:

Rammi

Nested Class Summary

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

java.util.PrimitiveIterator.OfDouble, java.util.PrimitiveIterator.OfInt, java.util.PrimitiveIterator.OfLong

Field Summary

Fields

Modifier and Type	Field and Description
static PrimitiveBooleanIterator	EMPTY Empty iterator of primitive boolean values.

Method Summary

Modifier and Type	Method and Description
default void	forEachRemaining(BooleanConsumer action) Performs the given action for each remaining element until all elements have been processed or the action throws an exception.
default void	forEachRemaining(java.util.function.Consumer<? super java.lang.Boolean> action) If the action is an instance of BooleanConsumer then it is cast to BooleanConsumer and passed to forEachRemaining(de.caff.generics.function.BooleanConsumer); otherwise the action is adapted to an instance of BooleanConsumer, by boxing the argument of BooleanConsumer, and then passed to forEachRemaining(de.caff.generics.function.BooleanConsumer).
default java.lang.Boolean	next() The default implementation boxes the result of calling nextBool(), and returns that boxed result.
boolean	nextBool() Returns the next boolean element in the iteration.

Methods inherited from interface java.util.Iterator

hasNext, remove

Field Detail

EMPTY

static final PrimitiveBooleanIterator EMPTY

Empty iterator of primitive boolean values.

Method Detail

nextBool

boolean nextBool()

Returns the next boolean element in the iteration.

Returns:

the next boolean element in the iteration

Throws:

java.util.NoSuchElementException - if the iteration has no more elements

forEachRemaining

default void forEachRemaining(@NotNull
                              BooleanConsumer action)

Performs the given action for each remaining element until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

The default implementation behaves as if:

     while (hasNext())
         action.accept(nextBoolean());
 

Specified by:

forEachRemaining in interface java.util.PrimitiveIterator<java.lang.Boolean,BooleanConsumer>

Parameters:

action - The action to be performed for each element

Throws:

java.lang.NullPointerException - if the specified action is null

next

default java.lang.Boolean next()

The default implementation boxes the result of calling nextBool(), and returns that boxed result.

Specified by:

next in interface java.util.Iterator<java.lang.Boolean>

forEachRemaining

default void forEachRemaining(@NotNull
                              java.util.function.Consumer<? super java.lang.Boolean> action)

If the action is an instance of BooleanConsumer then it is cast to BooleanConsumer and passed to forEachRemaining(de.caff.generics.function.BooleanConsumer); otherwise the action is adapted to an instance of BooleanConsumer, by boxing the argument of BooleanConsumer, and then passed to forEachRemaining(de.caff.generics.function.BooleanConsumer).

Specified by:

forEachRemaining in interface java.util.Iterator<java.lang.Boolean>