src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.commons.compress.utils;

import java.io.IOException;

/**
 * This interface provides statistics on the current decompression stream. The stream consumer can use that statistics to handle abnormal compression ratios,
 * i.e. to prevent ZIP bombs.
 *
 * @since 1.17
 */
public interface InputStreamStatistics {

    /**
     * Gets the amount of raw or compressed bytes read by the stream.
     *
     * @return the amount of raw or compressed bytes read by the stream.
     * @throws IOException if a formatting error occurs.
     */
    long getCompressedCount() throws IOException;

    /**
     * Gets the amount of decompressed bytes returned by the stream.
     *
     * @return the amount of decompressed bytes returned by the stream.
     */
    long getUncompressedCount();
}