001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.commons.compress.archivers.examples;
020
021import java.io.Closeable;
022import java.io.IOException;
023
024/**
025 * Callback that is informed about a closable resource that has been
026 * wrapped around a passed in stream or channel by Expander or
027 * Archiver when Expander or Archiver no longer need them.
028 *
029 * <p>This provides a way to close said resources in the calling code.</p>
030 *
031 * @since 1.19
032 */
033public interface CloseableConsumer {
034
035    /**
036     * Closes the passed in Closeable immediately.
037     */
038    CloseableConsumer CLOSING_CONSUMER = Closeable::close;
039
040    /**
041     * Ignores the passed in Closeable.
042     */
043    CloseableConsumer NULL_CONSUMER = c -> { };
044
045    /**
046     * Callback that is informed about a Closeable resource that has
047     * been wrapped around a passed in stream or channel by Expander
048     * or Archiver when Expander or Archiver no longer need them.
049     *
050     * @param c Closeable created by Expander or Archiver that is now
051     * no longer used
052     *
053     * @throws IOException on error
054     */
055    void accept(Closeable c) throws IOException;
056}