    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 *   https://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 */
    019
    020package org.apache.commons.compress.utils;
    021
    022/**
    023 * This interface provides statistics on the current decompression stream. The stream consumer can use that statistics to handle abnormal compression ratios,
    024 * i.e. to prevent ZIP bombs.
    025 *
    026 * @since 1.17
    027 */
    028public interface InputStreamStatistics {
    029
    030    /**
    031     * Gets the amount of raw or compressed bytes read by the stream.
    032     *
    033     * @return the amount of raw or compressed bytes read by the stream.
    034     */
    035    long getCompressedCount();
    036
    037    /**
    038     * Gets the amount of decompressed bytes returned by the stream.
    039     *
    040     * @return the amount of decompressed bytes returned by the stream.
    041     */
    042    long getUncompressedCount();
    043}