1 /*
2 * Copyright 2021 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty5.util;
17
18 /**
19 * A {@code SafeCloseable} can be safely closed without risk of an exception being thrown.
20 * <p>
21 * This interface extends {@link AutoCloseable} so instances can be used in try-with-resources clauses.
22 *
23 * @implNote Similar to {@link java.io.Closeable}, implementors should make their {@link #close()} idempotent.
24 * In other words, it should be safe to call {@link #close()} multiple times on the same instance.
25 * This is a restriction beyond what {@link AutoCloseable} provides.
26 */
27 public interface SafeCloseable extends AutoCloseable {
28 @Override
29 void close();
30 }