Package com.github.tommyettinger.ds.support.util

Interface CharIterator

All Superinterfaces:
Iterator<Character>
All Known Implementing Classes:
CharBitSet.CharBitSetIterator, CharDeque.CharDequeIterator, CharList.CharListIterator, EditingCharIterator, FilteringCharIterator, LimitingCharIterator, StridingCharIterator
public interface CharIterator extends Iterator<Character>
An Iterator specialized for char values. This iterates over primitive chars using nextChar().
This interface is loosely based on a similar interface in OpenJDK 8. This iterator interface is extremely simple and there's no way to implement it in a way that respects compatibility other than the way OpenJDK 8 does. OpenJDK's license is available here, if it applies at all.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    forEachRemaining(com.github.tommyettinger.function.CharConsumer action)
    Performs the given action for each remaining element until all elements have been processed or the action throws an exception.
    default Character
    next()
    char
    nextChar()
    Returns the next char element in the iteration.

    Methods inherited from interface java.util.Iterator

    forEachRemaining, hasNext, remove

  • Method Details

    • nextChar

      char nextChar()
      Returns the next char element in the iteration.
      Returns:
      the next char element in the iteration
      Throws:
      NoSuchElementException - if the iteration has no more elements

    • forEachRemaining

      default void forEachRemaining(com.github.tommyettinger.function.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.
      Parameters:
      action - The action to be performed for each element
      Throws:
      NullPointerException - if the specified action is null
      "Implementation Requirements"

      The default implementation behaves as if: 

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

    • next

      default Character next()
      Specified by:
      next in interface Iterator<Character>
      "Implementation Requirements"
      The default implementation boxes the result of calling nextChar(), and returns that boxed result.