com.marklogic.client.eval.EvalResultIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of marklogic-client-api Show documentation

The official MarkLogic Java client API.

The newest version!

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.eval;

import java.io.Closeable;
import java.util.Iterator;

/**
 * An Iterator to walk through all results returned from calls to
 * {@link ServerEvaluationCall#eval()}.
 */
public interface EvalResultIterator extends Iterable, Iterator, Closeable {
	@Override
	Iterator iterator();

	@Override
	boolean hasNext();

	@Override
	EvalResult next();

	/**
	 * As of 7.1.0, this must be called to ensure that the response is closed, as results are now
	 * streamed from MarkLogic instead of being read entirely into memory first.
	 */
	void close();
}