Package nl.vpro.util

Interface CloseableIterator<T>

All Superinterfaces:

AutoCloseable, Iterator<T>

All Known Subinterfaces:

CloseablePeekingIterator<E>, CountedIterator<T>, CountedPeekingIterator<T>

All Known Implementing Classes:

BasicWrappedIterator, CallbackIterator, CloseableIterator.WrappedCloseableIterator, CloseableIterator.WrappedPeekingCloseableIterator, CountedMaxOffsetIterator, FilteringIterator, LazyIterator, MaxOffsetIterator, MergedSortedIterator, TailAdder, TransformingIterator, WrappedIterator

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

An iterator that is also AutoCloseable.

Since:

1.1

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CloseableIterator.WrappedCloseableIterator<S>
static class	CloseableIterator.WrappedPeekingCloseableIterator<S>

Method Summary

Modifier and Type	Method	Description
static void	closeQuietly(AutoCloseable... closeables)
static <T> CloseableIterator<T>	empty()
static <T> CloseableIterator<T>	of(Iterator<T> iterator)	Morphs an existing Iterator into a CloseableIterator.
default CloseablePeekingIterator<T>	peeking()	If you need a guava PeekingIterator, this will make you one.
static <S> CloseablePeekingIterator<S>	peeking(CloseableIterator<S> wrapped)
default Stream<T>	stream()

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Details

closeQuietly

static void closeQuietly(AutoCloseable... closeables)

empty

static <T> CloseableIterator<T> empty()

Since:

2.9

of

static <T> CloseableIterator<T> of(Iterator<T> iterator)

Morphs an existing Iterator into a CloseableIterator.

If it is already a CloseableIterator it will be returned unchanged. If it implements AutoCloseable then its AutoCloseable.close() method will be called. If not then the AutoCloseable.close() method will do nothing.

Since:

2.9

peeking

static <S> CloseablePeekingIterator<S> peeking(CloseableIterator<S> wrapped)

stream

default Stream<T> stream()

peeking

default CloseablePeekingIterator<T> peeking()

If you need a guava PeekingIterator, this will make you one. It remains also a CloseableIterator