1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.commons.compress.utils;
21
22 /**
23 * This interface provides statistics on the current decompression stream. The stream consumer can use that statistics to handle abnormal compression ratios,
24 * i.e. to prevent ZIP bombs.
25 *
26 * @since 1.17
27 */
28 public interface InputStreamStatistics {
29
30 /**
31 * Gets the amount of raw or compressed bytes read by the stream.
32 *
33 * @return the amount of raw or compressed bytes read by the stream.
34 */
35 long getCompressedCount();
36
37 /**
38 * Gets the amount of decompressed bytes returned by the stream.
39 *
40 * @return the amount of decompressed bytes returned by the stream.
41 */
42 long getUncompressedCount();
43 }