org.skife.jdbi.v2.ResultIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdbi Show documentation

jDBI is designed to provide convenient tabular data access in Java(tm). It uses the Java collections framework for query results, provides a convenient means of externalizing sql statements, and provides named parameter support for any database being used.

There is a newer version: 2.78

Show newest version

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.skife.jdbi.v2;

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

/**
 * Represents a forward-only iterator over a result set, which will lazily iterate
 * the results. The underlying ResultSet can be closed by calling the
 * {@link org.skife.jdbi.v2.ResultIterator#close()} method.
 * 
 * The default implementation of ResultIterator will automatically close
 * the result set after the last element has been retrieved via next() and
 * hasNext() is called (which will return false). This allows for iteration
 * over the results with automagic resource cleanup.
 * 
 * The remove() operation is not supported in the default
 * version, and will raise an UnsupportedOperationException
 */
public interface ResultIterator extends Iterator, Closeable
{
    @Override
    /**
     * Close the underlying result set.
     */
    void close();
}