org.apache.paimon.utils

Class RecyclableIterator<E>

java.lang.Object

org.apache.paimon.utils.RecyclableIterator<E>

Type Parameters:

E - The type of the records returned by the iterator.

All Implemented Interfaces:

RecordReader.RecordIterator<E>

Direct Known Subclasses:

ColumnarRowIterator, IteratorResultIterator

public abstract class RecyclableIterator<E>
extends Object
implements RecordReader.RecordIterator<E>

Utility base class for iterators that accept a recycler.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecyclableIterator(Runnable recycler) Creates a RecyclableIterator with the given optional recycler.

Method Summary

Modifier and Type	Method and Description
void	releaseBatch() Releases the batch that this iterator iterated over.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.paimon.reader.RecordReader.RecordIterator

filter, next, transform

Constructor Detail

RecyclableIterator

protected RecyclableIterator(@Nullable
                             Runnable recycler)

Creates a RecyclableIterator with the given optional recycler.

Method Detail

releaseBatch

public void releaseBatch()

Description copied from interface: RecordReader.RecordIterator

Releases the batch that this iterator iterated over. This is not supposed to close the reader and its resources, but is simply a signal that this iterator is not used anymore. This method can be used as a hook to recycle/reuse heavyweight object structures.

Specified by:

releaseBatch in interface RecordReader.RecordIterator<E>