1bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2007 The Guava Authors 3bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 4bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Licensed under the Apache License, Version 2.0 (the "License"); 5bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * you may not use this file except in compliance with the License. 6bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * You may obtain a copy of the License at 7bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 8bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * http://www.apache.org/licenses/LICENSE-2.0 9bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 10bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Unless required by applicable law or agreed to in writing, software 11bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * distributed under the License is distributed on an "AS IS" BASIS, 12bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * See the License for the specific language governing permissions and 14bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * limitations under the License. 15bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor */ 16bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 17bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorpackage com.google.common.io; 18bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.Beta; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.annotations.VisibleForTesting; 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 22bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorimport java.io.Closeable; 23bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorimport java.io.IOException; 24bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorimport java.util.logging.Level; 25bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorimport java.util.logging.Logger; 26bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 27bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorimport javax.annotation.Nullable; 28bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 29bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor/** 30bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Utility methods for working with {@link Closeable} objects. 31bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 32bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @author Michael Lancaster 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @since 1.0 34bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor */ 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@Beta 36bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnorpublic final class Closeables { 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @VisibleForTesting static final Logger logger 38bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor = Logger.getLogger(Closeables.class.getName()); 39bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 40bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor private Closeables() {} 41bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 42bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor /** 43bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Closes a {@link Closeable}, with control over whether an 44bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * {@code IOException} may be thrown. This is primarily useful in a 45bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * finally block, where a thrown exception needs to be logged but not 46bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * propagated (otherwise the original exception will be lost). 47bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 48bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * <p>If {@code swallowIOException} is true then we never throw 49bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * {@code IOException} but merely log it. 50bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 51bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * <p>Example: 52bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 53bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * <p><pre>public void useStreamNicely() throws IOException { 54bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * SomeStream stream = new SomeStream("foo"); 55bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * boolean threw = true; 56bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * try { 57bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * // Some code which does something with the Stream. May throw a 58bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * // Throwable. 59bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * threw = false; // No throwable thrown. 60bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * } finally { 61bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * // Close the stream. 62bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * // If an exception occurs, only rethrow it if (threw==false). 63bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Closeables.close(stream, threw); 64bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * } 65bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * </pre> 66bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * 67bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @param closeable the {@code Closeable} object to be closed, or null, 68bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * in which case this method does nothing 69bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @param swallowIOException if true, don't propagate IO exceptions 70bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * thrown by the {@code close} methods 71bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @throws IOException if {@code swallowIOException} is false and 72bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * {@code close} throws an {@code IOException}. 73bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor */ 74bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor public static void close(@Nullable Closeable closeable, 75bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor boolean swallowIOException) throws IOException { 76bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor if (closeable == null) { 77bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor return; 78bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } 79bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor try { 80bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor closeable.close(); 81bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } catch (IOException e) { 82bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor if (swallowIOException) { 83bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor logger.log(Level.WARNING, 84bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor "IOException thrown while closing Closeable.", e); 85bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } else { 86bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor throw e; 87bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } 88bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } 89bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } 90bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor 91bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor /** 92bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * Equivalent to calling {@code close(closeable, true)}, but with no 93bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * IOException in the signature. 94bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * @param closeable the {@code Closeable} object to be closed, or null, in 95bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor * which case this method does nothing 96bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor */ 97bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor public static void closeQuietly(@Nullable Closeable closeable) { 98bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor try { 99bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor close(closeable, true); 100bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } catch (IOException e) { 101bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor logger.log(Level.SEVERE, "IOException should not have been thrown.", e); 102bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } 103bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor } 104bfe2dd089341dcb4c1fb65a5b6b077ad0ebbf6dcDan Egnor} 105