Interface ThrowingIterator<T,​X extends Exception>

  • Type Parameters:
    T - the element's type
    X - the type of the exception that may be thrown
    All Known Implementing Classes:
    AbstractThrowingIterator

    public interface ThrowingIterator<T,​X extends Exception>
    A throwing variant of Iterator.
    See Also:
    Iterator
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void forEachRemaining​(ThrowingConsumer<? super T,​? extends X> action)
      Performs the given action for each remaining element until all elements have been processed or the action throws an exception.
      boolean hasNext()
      Returns true if the iteration has more elements.
      T next()
      Returns the next element in the iteration.
      default void remove()
      Removes from the underlying collection the last element returned by this iterator (optional operation).
    • Method Detail

      • forEachRemaining

        default void forEachRemaining​(ThrowingConsumer<? super T,​? extends X> action)
                               throws X extends Exception
        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
        X - if iteration fails
        X extends Exception
        See Also:
        Iterator.forEachRemaining(java.util.function.Consumer)
      • hasNext

        @CheckReturnValue
        boolean hasNext()
                 throws X extends Exception
        Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.)
        Returns:
        true if the iteration has more elements
        Throws:
        X - if the check for the next value fails
        X extends Exception
        See Also:
        Iterator.hasNext()
      • remove

        default void remove()
                     throws X extends Exception
        Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next(). The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method. The default implementation throws an instance of UnsupportedOperationException and performs no other action.
        Throws:
        UnsupportedOperationException - if the remove operation is not supported by this iterator
        IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method
        X - if the remove operations fails
        X extends Exception
        See Also:
        Iterator.remove()