com.google.common.io.Closeables Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
The newest version!
/*
 * Copyright (C) 2007 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.common.io;

import com.google.common.annotations.Beta;
import com.google.common.annotations.VisibleForTesting;
import java.io.Closeable;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;

/**
 *  Utility methods for working with {@link Closeable} objects.
 *
 *  @author Michael Lancaster
 *  @since 1.0
 *
 * @deprecated The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
 */
@Beta
@Deprecated(since = "2022-12-01")
public final class Closeables {

    @VisibleForTesting
    static final Logger logger = Logger.getLogger(Closeables.class.getName());

    private Closeables() {
    }

    /**
     * Closes a {@link Closeable}, with control over whether an {@code IOException} may be thrown.
     * This is primarily useful in a finally block, where a thrown exception needs to be logged but
     * not propagated (otherwise the original exception will be lost).
     *
     * If {@code swallowIOException} is true then we never throw {@code IOException} but merely log
     * it.
     *
     * 
Example: 
   {@code
     *
     *   public void useStreamNicely() throws IOException {
     *     SomeStream stream = new SomeStream("foo");
     *     boolean threw = true;
     *     try {
     *       // ... code which does something with the stream ...
     *       threw = false;
     *     } finally {
     *       // If an exception occurs, rethrow it only if threw==false:
     *       Closeables.close(stream, threw);
     *     }
     *   }}
     *
     * @param closeable the {@code Closeable} object to be closed, or null, in which case this method
     *     does nothing
     * @param swallowIOException if true, don't propagate IO exceptions thrown by the {@code close}
     *     methods
     * @throws IOException if {@code swallowIOException} is false and {@code close} throws an
     *     {@code IOException}.
     */
    public static void close(@Nullable Closeable closeable, boolean swallowIOException) throws IOException {
        if (closeable == null) {
            return;
        }
        try {
            closeable.close();
        } catch (IOException e) {
            if (swallowIOException) {
                logger.log(Level.WARNING, "IOException thrown while closing Closeable.", e);
            } else {
                throw e;
            }
        }
    }

    /**
     * Equivalent to calling {@code close(closeable, true)}, but with no IOException in the signature.
     *
     * @param closeable the {@code Closeable} object to be closed, or null, in which case this method
     *     does nothing
     * @deprecated Where possible, use the
     *     
     *     try-with-resources statement if using JDK7 or {@link Closer} on JDK6 to close one or
     *     more {@code Closeable} objects. This method is deprecated because it is easy to misuse and
     *     may swallow IO exceptions that really should be thrown and handled. See
     *     Guava issue
     *     1118 for a more detailed explanation of the reasons for deprecation and see
     *     
     *     Closing Resources for more information on the problems with closing {@code Closeable}
     *     objects and some of the preferred solutions for handling it correctly. This method is
     *     scheduled to be removed in Guava 16.0.
     */
    @Deprecated
    public static void closeQuietly(@Nullable Closeable closeable) {
        try {
            close(closeable, true);
        } catch (IOException e) {
            logger.log(Level.SEVERE, "IOException should not have been thrown.", e);
        }
    }
}