io.deephaven.engine.table.iterators.ColumnIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-api Show documentation

Engine API: Engine API module, suitable as a compile-time dependency for most queries

The newest version!

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.engine.table.iterators;

import io.deephaven.engine.primitive.iterator.CloseableIterator;
import io.deephaven.util.SafeCloseable;

/**
 * Iteration support for values supplied by a column.
 *
 * @apiNote ColumnIterators must be explicitly {@link #close() closed} or used until exhausted in order to avoid
 *          resource leaks.
 */
public interface ColumnIterator extends CloseableIterator, SafeCloseable {

    @Override
    default void close() {}

    /**
     * @return The number of elements remaining in this ColumnIterator
     */
    long remaining();
}