Interface CloseableIterable<T>

  • Type Parameters:
    T - the type of elements returned by the CloseableIterator.
    All Superinterfaces:
    All Known Subinterfaces:
    BlockingIterable<T>, BlockingIterable.Processor<T>
    All Known Implementing Classes:
    AbstractCloseableIterable, TestIterableToBlockingIterable

    public interface CloseableIterable<T>
    extends java.lang.Iterable<T>
    An Iterable which supports generation of CloseableIterators.

    This interface is meant to be used in places where an Iterator returned by an Iterable contains state that is required to be cleared irrespective of whether data from the Iterator is completely consumed (i.e. Iterator.hasNext() is called till it returns false) or not. This interface provides a way for a user of such an Iterable to discard data, by calling AutoCloseable.close(). When using CloseableIterator, it is expected that the user will either consume all the data from the Iterator or explicitly call AutoCloseable.close() to dispose the remaining data.

    • Method Detail

      • iterator

        CloseableIterator<T> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<T>