17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.lang; 27 28 /** 29 * A resource that must be closed when it is no longer needed. 30 * 31 * @author Josh Bloch 32 * @since 1.7 33 */ 34 public interface AutoCloseable { 35 /** 36 * Closes this resource, relinquishing any underlying resources. 37 * This method is invoked automatically by the {@code 38 * try}-with-resources statement. 39 * 40 * <p>Classes implementing this method are strongly encouraged to 41 * be declared to throw more specific exceptions (or no exception 42 * at all, if the close cannot fail). 43 * 44 * <p>Note that unlike the {@link java.io.Closeable#close close} 45 * method of {@link java.io.Closeable}, this {@code close} method 46 * is <em>not</em> required to be idempotent. In other words, 47 * calling this {@code close} method more than once may have some 48 * visible side effect, unlike {@code Closeable.close} which is 49 * required to have no effect if called more than once. 50 * 51 * However, while not required to be idempotent, implementers of 52 * this interface are strongly encouraged to make their {@code 53 * close} methods idempotent. 54 * 55 * @throws Exception if this resource cannot be closed 56 */ 57 void close() throws Exception; 58 } | 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.lang; 27 28 /** 29 * A resource that must be closed when it is no longer needed. 30 * 31 * @author Josh Bloch 32 * @since 1.7 33 */ 34 public interface AutoCloseable { 35 /** 36 * Closes this resource, relinquishing any underlying resources. 37 * This method is invoked automatically on objects managed by the 38 * {@code try}-with-resources statement. 39 * 40 * <p>While this interface method is declared to throw {@code 41 * Exception}, implementers are <em>strongly</em> encouraged to 42 * declare concrete implementations of the {@code close} method to 43 * throw more specific exceptions, or to throw no exception at all 44 * if the close operation cannot fail. 45 * 46 * <p><em>Implementers of this interface are also strongly advised 47 * to not have the {@code close} method throw {@link 48 * InterruptedException}.</em> 49 * 50 * This exception interacts with a thread's interrupted status, 51 * and runtime misbehavior is likely to occur if an {@code 52 * InterruptedException} is {@linkplain Throwable#addSuppressed 53 * suppressed}. 54 * 55 * More generally, if it would cause problems for an 56 * exception to be suppressed, the {@code AutoCloseable.close} 57 * method should not throw it. 58 * 59 * <p>Note that unlike the {@link java.io.Closeable#close close} 60 * method of {@link java.io.Closeable}, this {@code close} method 61 * is <em>not</em> required to be idempotent. In other words, 62 * calling this {@code close} method more than once may have some 63 * visible side effect, unlike {@code Closeable.close} which is 64 * required to have no effect if called more than once. 65 * 66 * However, implementers of this interface are strongly encouraged 67 * to make their {@code close} methods idempotent. 68 * 69 * @throws Exception if this resource cannot be closed 70 */ 71 void close() throws Exception; 72 } |