src.it.unimi.dsi.io.SafelyCloseable Maven / Gradle / Ivy
/*
* DSI utilities
*
* Copyright (C) 2006-2023 Sebastiano Vigna
*
* This program and the accompanying materials are made available under the
* terms of the GNU Lesser General Public License v2.1 or later,
* which is available at
* http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html,
* or the Apache Software License 2.0, which is available at
* https://www.apache.org/licenses/LICENSE-2.0.
*
* 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.
*
* SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
*/
package it.unimi.dsi.io;
import java.io.Closeable;
/** A marker interface for a closeable resource that implements safety measures to
* make resource tracking easier.
*
* Classes implementing this interface must provide a safety-net finaliser—a
* finaliser that closes the resource and logs that resource should have been closed.
*
*
When the implementing class is abstract, concrete subclasses must
* call super.close() in their own {@link java.io.Closeable#close()} method
* to let the abstract class track correctly the resource. Moreover,
* they must run super.finalize() in
* their own finaliser (if any), as finalisation chaining is not automatic.
*
*
Note that if a concrete subclass implements readResolve(), it must
* call super.close(), or actually return this (i.e., the deserialised
* instance); otherwise, a spurious log could be generated when the deserialised instance is collected.
*
* @author Sebastiano Vigna
* @since 1.1
*/
public interface SafelyCloseable extends Closeable {}