com.blazegraph.gremlin.util

Interface CloseableIterator<E>

All Superinterfaces:

AutoCloseable, Iterator<E>

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

Interface that combines Iterator and AutoCloseable. Why does Java 8 not support this natively?!?

Author:

mikepersonick

Method Summary

Modifier and Type	Method and Description
void	close() You MUST close this iterator or auto-close with a try-with-resources.
default List<E>	collect() Collect the elements into a list.
default long	count() Count the elements.
default long	countDistinct() Count the distinct elements.
static <T> CloseableIterator<T>	emptyIterator() Empty instance.
default void	forEachRemaining(Consumer<? super E> action) Perform some action on each remaining element and then close the itertor.
static <T> CloseableIterator<T>	of(Iterator<T> it, Runnable onClose) Construct an instance from the supplied iterator and the supplied onClose behavior.
static <T> CloseableIterator<T>	of(Stream<T> stream) Construct an instance from a stream using stream.close() as the close behavior for the iterator.
default Stream<E>	stream() You MUST close this stream or auto-close in a try-with-resources.

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

close

void close()

You MUST close this iterator or auto-close with a try-with-resources.

Specified by:

close in interface AutoCloseable

forEachRemaining

default void forEachRemaining(Consumer<? super E> action)

Perform some action on each remaining element and then close the itertor.

Specified by:

forEachRemaining in interface Iterator<E>

stream

default Stream<E> stream()

You MUST close this stream or auto-close in a try-with-resources.

collect

default List<E> collect()

Collect the elements into a list. This will close the iterator.

count

default long count()

Count the elements. This will close the iterator.

countDistinct

default long countDistinct()

Count the distinct elements. This will close the iterator.

of

static <T> CloseableIterator<T> of(Stream<T> stream)

Construct an instance from a stream using stream.close() as the close behavior for the iterator.

of

static <T> CloseableIterator<T> of(Iterator<T> it,
                                   Runnable onClose)

Construct an instance from the supplied iterator and the supplied onClose behavior.

emptyIterator

static <T> CloseableIterator<T> emptyIterator()

Empty instance.