jtulach@119: /*
jtulach@119:  * Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
jtulach@119:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jtulach@119:  *
jtulach@119:  * This code is free software; you can redistribute it and/or modify it
jtulach@119:  * under the terms of the GNU General Public License version 2 only, as
jtulach@119:  * published by the Free Software Foundation.  Oracle designates this
jtulach@119:  * particular file as subject to the "Classpath" exception as provided
jtulach@119:  * by Oracle in the LICENSE file that accompanied this code.
jtulach@119:  *
jtulach@119:  * This code is distributed in the hope that it will be useful, but WITHOUT
jtulach@119:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jtulach@119:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jtulach@119:  * version 2 for more details (a copy is included in the LICENSE file that
jtulach@119:  * accompanied this code).
jtulach@119:  *
jtulach@119:  * You should have received a copy of the GNU General Public License version
jtulach@119:  * 2 along with this work; if not, write to the Free Software Foundation,
jtulach@119:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jtulach@119:  *
jtulach@119:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jtulach@119:  * or visit www.oracle.com if you need additional information or have any
jtulach@119:  * questions.
jtulach@119:  */
jtulach@119: 
jtulach@119: package java.lang;
jtulach@119: 
jtulach@119: /**
jtulach@119:  * A resource that must be closed when it is no longer needed.
jtulach@119:  *
jtulach@119:  * @author Josh Bloch
jtulach@119:  * @since 1.7
jtulach@119:  */
jtulach@119: public interface AutoCloseable {
jtulach@119:     /**
jtulach@119:      * Closes this resource, relinquishing any underlying resources.
jtulach@119:      * This method is invoked automatically on objects managed by the
jtulach@119:      * {@code try}-with-resources statement.
jtulach@119:      *
jtulach@119:      * <p>While this interface method is declared to throw {@code
jtulach@119:      * Exception}, implementers are <em>strongly</em> encouraged to
jtulach@119:      * declare concrete implementations of the {@code close} method to
jtulach@119:      * throw more specific exceptions, or to throw no exception at all
jtulach@119:      * if the close operation cannot fail.
jtulach@119:      *
jtulach@119:      * <p><em>Implementers of this interface are also strongly advised
jtulach@119:      * to not have the {@code close} method throw {@link
jtulach@119:      * InterruptedException}.</em>
jtulach@119:      *
jtulach@119:      * This exception interacts with a thread's interrupted status,
jtulach@119:      * and runtime misbehavior is likely to occur if an {@code
jtulach@119:      * InterruptedException} is {@linkplain Throwable#addSuppressed
jtulach@119:      * suppressed}.
jtulach@119:      *
jtulach@119:      * More generally, if it would cause problems for an
jtulach@119:      * exception to be suppressed, the {@code AutoCloseable.close}
jtulach@119:      * method should not throw it.
jtulach@119:      *
jtulach@119:      * <p>Note that unlike the {@link java.io.Closeable#close close}
jtulach@119:      * method of {@link java.io.Closeable}, this {@code close} method
jtulach@119:      * is <em>not</em> required to be idempotent.  In other words,
jtulach@119:      * calling this {@code close} method more than once may have some
jtulach@119:      * visible side effect, unlike {@code Closeable.close} which is
jtulach@119:      * required to have no effect if called more than once.
jtulach@119:      *
jtulach@119:      * However, implementers of this interface are strongly encouraged
jtulach@119:      * to make their {@code close} methods idempotent.
jtulach@119:      *
jtulach@119:      * @throws Exception if this resource cannot be closed
jtulach@119:      */
jtulach@119:     void close() throws Exception;
jtulach@119: }