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