Interface CloseableIterator<E>

  • All Superinterfaces:
    java.lang.AutoCloseable, java.util.Iterator<E>
    All Known Implementing Classes:
    CloseableIteratorMapper, CloseableSuppliedIterator, ConcatIterator, FilterIterator, IteratorMapper, LazyConcatIterator, RemovableCloseableIterator

    public interface CloseableIterator<E>
    extends java.lang.AutoCloseable, java.util.Iterator<E>
    Interface that provides semantics of a Iterator and AutoCloseable interfaces. This is useful when you have data that must be iterated on and may hold resources in the underlying implementation that must be closed.

    Some implementations may close resources automatically when the iterator is finished being iterated on however this is an implementation detail and all callers should call AutoCloseable.close() method to be sure all resources are freed properly.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()  
      • Methods inherited from interface java.util.Iterator

        forEachRemaining, hasNext, next, remove
    • Method Detail

      • close

        void close()
        Specified by:
        close in interface java.lang.AutoCloseable