de.caff.generics

Interface PrimitiveCharIterator

All Superinterfaces:

java.util.Iterator<java.lang.Character>, java.util.PrimitiveIterator<java.lang.Character,CharConsumer>

public interface PrimitiveCharIterator
extends java.util.PrimitiveIterator<java.lang.Character,CharConsumer>

An iterator specialized for cahr values.

This is missing in the standard library: an iterator for raw char 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 PrimitiveCharIterator	EMPTY Empty iterator of primitive char values.

Method Summary

Modifier and Type	Method and Description
default java.util.PrimitiveIterator.OfInt	asIntIterator() View this char iterator as an int iterator.
default java.util.PrimitiveIterator.OfLong	asLongIterator() View this char iterator as a long iterator.
default void	forEachRemaining(CharConsumer 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.Character> action) If the action is an instance of CharConsumer then it is cast to CharConsumer and passed to forEachRemaining(de.caff.generics.function.CharConsumer); otherwise the action is adapted to an instance of CharConsumer, by boxing the argument of CharConsumer, and then passed to forEachRemaining(de.caff.generics.function.CharConsumer).
default java.lang.Character	next() The default implementation boxes the result of calling nextChar(), and returns that boxed result.
char	nextChar() Returns the next char element in the iteration.

Methods inherited from interface java.util.Iterator

hasNext, remove

Field Detail

EMPTY

static final PrimitiveCharIterator EMPTY

Empty iterator of primitive char values.

Method Detail

nextChar

char nextChar()

Returns the next char element in the iteration.

Returns:

the next char element in the iteration

Throws:

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

forEachRemaining

default void forEachRemaining(@NotNull
                              CharConsumer 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(nextChar());
 

Specified by:

forEachRemaining in interface java.util.PrimitiveIterator<java.lang.Character,CharConsumer>

Parameters:

action - The action to be performed for each element

Throws:

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

next

default java.lang.Character next()

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

Specified by:

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

forEachRemaining

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

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

Specified by:

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

asIntIterator

@NotNull
default java.util.PrimitiveIterator.OfInt asIntIterator()

View this char iterator as an int iterator. Please note that you should use either this iterator of the returned one, but don't mix using both.

Returns:

int iterator view of this iterator

asLongIterator

@NotNull
default java.util.PrimitiveIterator.OfLong asLongIterator()

View this char iterator as a long iterator. Please note that you should use either this iterator of the returned one, but don't mix using both.

Returns:

long iterator view of this iterator