org.neo4j.graphdb.ResourceIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation

Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.

There is a newer version: 5.26.0

Show newest version

/**
 * Copyright (c) 2002-2013 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.graphdb;

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

/**
 * Closeable Iterator with associated resources that needs to be managed.
 * 
 * 
 * However, if your code might not exhaust the iterator, (run until {@link #hasNext()} returns {@code false}),
 * {@link ResourceIterator} provides you with a {@link #close()} method that should be invoked to free its
 * resources, by using a {@code finally}-block, or try-with-resource.
 *
 * @param  type of values returned by this Iterator
 * 
 * @see ResourceIterable
 * @see Transaction
 */
public interface ResourceIterator extends Iterator, Closeable {
    /**
     * Close the iterator early, freeing associated resources
     *
     * It is an error to use the iterator after this has been called.
     */
    @Override
    void close();
}