thredds.inventory

Interface CloseableIterator<T>

All Superinterfaces:

AutoCloseable, Closeable, Iterator<T>

All Known Implementing Classes:

MFileIterator

public interface CloseableIterator<T>
extends Iterator<T>, Closeable

An iterator that must be closed.

 void method(CloseableIterable<T> ballotsIterable) {
   try (CloseableIterator<T> ballotsIter = ballotsIterable.iterator()) {
     while (ballotsIter.hasNext()) {
       T ballot = ballotsIter.next();
       // do stuff
     }
   }
 }
 

or

  void method(CloseableIterator<T> ballotsIter) {
     try (Stream<T> ballotsStream = ballotsIter.stream()) {
       ballotsStream.filter(b -> b.state == State.CAST)
                    .forEach(ballot -> {
                       // do stuff
                    });
     }
  }
 

The convention is that if CloseableIterator is passed to a method, it is not already in a try-finally block.

See Also:

Spring CloseableIterator

Method Summary

Modifier and Type	Method and Description
void	close() IOException is converted to RuntimeException.
default Spliterator<T>	spliterator() Could be parallel.
default Stream<T>	stream() Convert to a stream, can be declared as a resource in a try-with-resources statement.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

close

void close()

IOException is converted to RuntimeException.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

spliterator

default Spliterator<T> spliterator()

Could be parallel.

stream

default Stream<T> stream()

Convert to a stream, can be declared as a resource in a try-with-resources statement.