io.delta.kernel.utils

Interface CloseableIterable<T>

Type Parameters:

T - the type of elements returned by this iterator

All Superinterfaces:

AutoCloseable, java.io.Closeable, Iterable<T>

public interface CloseableIterable<T>
extends Iterable<T>, java.io.Closeable

Extend the Java Iterable interface to provide a way to close the iterator.

Method Summary

Modifier and Type	Method and Description
static <T> CloseableIterable<T>	emptyIterable() Return an CloseableIterable object for an empty collection.
default void	forEach(java.util.function.Consumer<? super T> action)
static <T> CloseableIterable<T>	inMemoryIterable(CloseableIterator<T> iterator) Return an CloseableIterable object that is backed by an in-memory collection of given CloseableIterator.
CloseableIterator<T>	iterator() Overrides the default iterator method to return a CloseableIterator.
default java.util.Spliterator<T>	spliterator()

Methods inherited from interface java.io.Closeable

close

Method Detail

iterator

CloseableIterator<T> iterator()

Overrides the default iterator method to return a CloseableIterator.

Specified by:

iterator in interface Iterable<T>

Returns:

a CloseableIterator instance.

forEach

default void forEach(java.util.function.Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T>

spliterator

default java.util.Spliterator<T> spliterator()

Specified by:

spliterator in interface Iterable<T>

inMemoryIterable

static <T> CloseableIterable<T> inMemoryIterable(CloseableIterator<T> iterator)

Return an CloseableIterable object that is backed by an in-memory collection of given CloseableIterator. Users should aware that the returned CloseableIterable will hold the data in memory.

Type Parameters:

T - the type of elements returned by the iterator

Parameters:

iterator - the iterator to be converted to a CloseableIterable. It will be closed by this callee.

Returns:

a CloseableIterable instance.

emptyIterable

static <T> CloseableIterable<T> emptyIterable()

Return an CloseableIterable object for an empty collection.

Type Parameters:

T - the type of elements returned by the iterator

Returns:

a CloseableIterable instance.