ru.progrm_jarvis.javacommons.service.NonAutoCloseable Maven / Gradle / Ivy

Go to download
package ru.progrm_jarvis.javacommons.service;

/**
 * A wrapper for {@link AutoCloseable} which disables its {@link AutoCloseable#close()} method
 * instead providing {@link #doClose()} method for explicit closing of this object.
 *
 * This may come in handy when passing {@link AutoCloseable} objects to foreign methods
 * which may close this object although this should happen later
 */
@FunctionalInterface
public interface NonAutoCloseable extends AutoCloseable {

    /**
     * Imitates closing this object not actually doing it.
     *
     * @apiNote this object should be explicitly called using {@link #doClose()}
     */
    @Override
    default void close() {}

    /**
     * Actually closes this object as if it was done by calling {@link AutoCloseable#close()}.
     *
     * @throws Exception if the resource cannot be closed
     * @see AutoCloseable#close() for this method's behaviour
     */
    void doClose() throws Exception;
}