speiger.src.collections.booleans.collections

Interface BooleanIterator

All Superinterfaces:

java.util.Iterator<java.lang.Boolean>

All Known Subinterfaces:

BooleanBidirectionalIterator, BooleanListIterator, BooleanSplititerator

public interface BooleanIterator
extends java.util.Iterator<java.lang.Boolean>

A Type-Specific Iterator that reduces (un)boxing

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) Deprecated. Please use the corresponding type-specific function instead.
default <E> void	forEachRemaining(E input, ObjectBooleanConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
default java.lang.Boolean	next() Deprecated. Please use the corresponding type-specific function instead.
boolean	nextBoolean() Returns the next element in the iteration.
default int	skip(int amount) Skips the Given amount of elements if possible.

Methods inherited from interface java.util.Iterator

hasNext, remove

Method Detail

nextBoolean

boolean nextBoolean()

Returns the next element in the iteration.

Returns:

the next element in the iteration

Throws:

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

See Also:

Iterator.next()

next

@Deprecated
default java.lang.Boolean next()

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

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

forEachRemaining

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. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

Parameters:

action - The action to be performed for each element

Throws:

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

See Also:

Iterator.forEachRemaining(Consumer)

ImplSpec:

The default implementation behaves as if:

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

forEachRemaining

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

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

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

forEachRemaining

default <E> void forEachRemaining(E input,
                                  ObjectBooleanConsumer<E> action)

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

Throws:

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

skip

default int skip(int amount)

Skips the Given amount of elements if possible. A Optimization function to skip elements faster if the implementation allows it.

Parameters:

amount - the amount of elements that should be skipped

Returns:

the amount of elements that were skipped