    001/*
    002 *  Licensed to the Apache Software Foundation (ASF) under one or more
    003 *  contributor license agreements.  See the NOTICE file distributed with
    004 *  this work for additional information regarding copyright ownership.
    005 *  The ASF licenses this file to You under the Apache License, Version 2.0
    006 *  (the "License"); you may not use this file except in compliance with
    007 *  the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 *  Unless required by applicable law or agreed to in writing, software
    012 *  distributed under the License is distributed on an "AS IS" BASIS,
    013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 *  See the License for the specific language governing permissions and
    015 *  limitations under the License.
    016 */
    017
    018package org.apache.commons.compress.utils;
    019
    020/**
    021 * This interface provides statistics on the current decompression stream. The stream consumer can use that statistics to handle abnormal compression ratios,
    022 * i.e. to prevent ZIP bombs.
    023 *
    024 * @since 1.17
    025 */
    026public interface InputStreamStatistics {
    027
    028    /**
    029     * Gets the amount of raw or compressed bytes read by the stream.
    030     *
    031     * @return the amount of raw or compressed bytes read by the stream.
    032     */
    033    long getCompressedCount();
    034
    035    /**
    036     * Gets the amount of decompressed bytes returned by the stream.
    037     *
    038     * @return the amount of decompressed bytes returned by the stream.
    039     */
    040    long getUncompressedCount();
    041}