/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.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 <http://www.gnu.org/licenses/>.
 */
package org.neo4j.kernel.api;

public interface ResourceMonitor {
    /**
     * Register a closeable resource that needs to be closed automatically
     * at the end of the scope of the resource.
     * The end of the scope can be closing of a statement or a transaction depending on
     * if the resource tracker has a statement or transaction scope.
     * <p>
     * If the given resource can be closed elsewhere, e.g. by exhausting an iterator,
     * the close() method of the resource should be idempotent.
     */
    void registerCloseableResource(AutoCloseable closeableResource);

    /**
     * @see #registerCloseableResource
     */
    void unregisterCloseableResource(AutoCloseable closeableResource);
}
