| Alan Viverette | 3da604b | 2020-06-10 18:34:39 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Oracle designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Oracle in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 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.io; |
| 27 | |
| 28 | import java.io.IOException; |
| 29 | |
| 30 | /** |
| 31 | * A {@code Closeable} is a source or destination of data that can be closed. |
| 32 | * The close method is invoked to release resources that the object is |
| 33 | * holding (such as open files). |
| 34 | * |
| 35 | * @since 1.5 |
| 36 | */ |
| 37 | public interface Closeable extends AutoCloseable { |
| 38 | |
| 39 | /** |
| 40 | * Closes this stream and releases any system resources associated |
| 41 | * with it. If the stream is already closed then invoking this |
| 42 | * method has no effect. |
| 43 | * |
| 44 | * <p> As noted in {@link AutoCloseable#close()}, cases where the |
| 45 | * close may fail require careful attention. It is strongly advised |
| 46 | * to relinquish the underlying resources and to internally |
| 47 | * <em>mark</em> the {@code Closeable} as closed, prior to throwing |
| 48 | * the {@code IOException}. |
| 49 | * |
| 50 | * @throws IOException if an I/O error occurs |
| 51 | */ |
| 52 | public void close() throws IOException; |
| 53 | } |
