View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.hc.core5.io;
29  
30  import java.io.Closeable;
31  import java.io.IOException;
32  
33  /**
34   * Closes resources.
35   *
36   * @since 5.0
37   */
38  public final class Closer {
39  
40      /**
41       * Closes the given Closeable in a null-safe manner.
42       *
43       * @param closeable what to close.
44       * @throws IOException
45       */
46      public static void close(final Closeable closeable) throws IOException {
47          if (closeable != null) {
48              closeable.close();
49          }
50      }
51  
52      /**
53       * Closes the given Closeable in a null-safe manner.
54       *
55       * @param closeable what to close.
56       * @param closeMode How to close the given resource.
57       */
58      public static void close(final ModalCloseable closeable, final CloseMode closeMode) {
59          if (closeable != null) {
60              closeable.close(closeMode);
61          }
62      }
63  
64      /**
65       * Closes the given Closeable quietly in a null-safe manner even in the event of an exception.
66       *
67       * @param closeable what to close.
68       */
69      public static void closeQuietly(final Closeable closeable) {
70          try {
71              close(closeable);
72          } catch (final IOException e) {
73              // Quietly ignore
74          }
75      }
76  }