com.j256.ormlite.dao.CloseableWrappedIterable Maven / Gradle / Ivy

package com.j256.ormlite.dao;

import java.io.Closeable;
import java.io.IOException;

/**
 * Extension to CloseableIterable which defines a class which has an iterator() method that returns a
 * {@link CloseableIterator} but also can be closed itself. This allows us to do something like this pattern:
 * 
 *  * CloseableWrappedIterable<Foo> wrapperIterable = fooDao.getCloseableIterable();
 * try {
 *   for (Foo foo : wrapperIterable) {
 *       ...
 *   }
 * } finally {
 *   wrapperIterable.close();
 * }
 * 
 * 
 * @author graywatson
 */
public interface CloseableWrappedIterable extends CloseableIterable, Closeable {

	/**
	 * This will close the last iterator returned by the {@link #iterator()} method.
	 */
	@Override
	public void close() throws IOException;
}