org.omnifaces.utils.function.ThrowingAutoCloseable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of omniutils Show documentation

Java utility library

The newest version!

/*
 * Copyright 2021 OmniFaces
 *
 * 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
 *
 *     https://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 org.omnifaces.utils.function;

/**
 * Functional helper-interface to allow for use of closeable resources that don't implement AutoCloseable in a try-with-resources statement.
 *
 * 
 * This interface can be used with any object instance that doesn't implement AutoCloseable, but does have a close or similar method that needs to be
 * called to free up resources. This functional interface is usable for any close method that throws a more specific exception than AutoCloseable
 * defines. For methods that don't throw any exceptions, see @link{ExceptionLessAutoCloseable}.
 * 
 *
 *
 * Example:
 * 
 *     CloseableResource resource = ...
 *     try (ThrowingAutoCloseable<IOException> eac = resource::close) {
 *         // Use resource
 *     }
 *     catch(IOException e) {
 *         // Handle exception
 *     }
 * 
 *
 */
@FunctionalInterface
public interface ThrowingAutoCloseable extends AutoCloseable {

	@Override
	void close() throws E;

}