    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 wrapped around a passed in stream or channel by Expander or Archiver when Expander or
    026 * Archiver no longer need them.
    027 *
    028 * <p>
    029 * This provides a way to close said resources in the calling code.
    030 * </p>
    031 *
    032 * @since 1.19
    033 */
    034public interface CloseableConsumer {
    035
    036    /**
    037     * Closes the passed in Closeable immediately.
    038     */
    039    CloseableConsumer CLOSING_CONSUMER = Closeable::close;
    040
    041    /**
    042     * Ignores the passed in Closeable.
    043     */
    044    CloseableConsumer NULL_CONSUMER = c -> {
    045    };
    046
    047    /**
    048     * Callback that is informed about a Closeable resource that has been wrapped around a passed in stream or channel by Expander or Archiver when Expander or
    049     * Archiver no longer need them.
    050     *
    051     * @param c Closeable created by Expander or Archiver that is now no longer used
    052     *
    053     * @throws IOException on error
    054     */
    055    void accept(Closeable c) throws IOException;
    056}