1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17
18 package org.apache.logging.log4j.core.util;
19
20 import org.apache.logging.log4j.status.StatusLogger;
21
22 /**
23 * Closes resources.
24 */
25 public final class Closer {
26
27 private Closer() {
28 // empty
29 }
30
31 /**
32 * Closes an AutoCloseable or ignores if {@code null}.
33 *
34 * @param closeable the resource to close; may be null
35 * @return Whether the resource was closed.
36 * @throws Exception if the resource cannot be closed
37 * @since 2.8
38 * @since 2.11.2 returns a boolean instead of being a void return type.
39 */
40 public static boolean close(final AutoCloseable closeable) throws Exception {
41 if (closeable != null) {
42 StatusLogger.getLogger().debug("Closing {} {}", closeable.getClass().getSimpleName(), closeable);
43 closeable.close();
44 return true;
45 }
46 return false;
47 }
48
49 /**
50 * Closes an AutoCloseable and returns {@code true} if it closed without exception.
51 *
52 * @param closeable the resource to close; may be null
53 * @return true if resource was closed successfully, or false if an exception was thrown
54 */
55 public static boolean closeSilently(final AutoCloseable closeable) {
56 try {
57 return close(closeable);
58 } catch (final Exception ignored) {
59 return false;
60 }
61 }
62
63 }