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 * http://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 package org.apache.commons.compress.compressors;
20
21 import java.io.InputStream;
22
23 public abstract class CompressorInputStream extends InputStream {
24
25 private long bytesRead;
26
27 /**
28 * Constructs a new instance.
29 */
30 public CompressorInputStream() {
31 // empty
32 }
33
34 /**
35 * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)
36 *
37 * @param read the number of bytes read
38 *
39 * @since 1.1
40 */
41 protected void count(final int read) {
42 count((long) read);
43 }
44
45 /**
46 * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)
47 *
48 * @param read the number of bytes read
49 */
50 protected void count(final long read) {
51 if (read != -1) {
52 bytesRead += read;
53 }
54 }
55
56 /**
57 * Gets the current number of bytes read from this stream.
58 *
59 * @return the number of read bytes
60 *
61 * @since 1.1
62 */
63 public long getBytesRead() {
64 return bytesRead;
65 }
66
67 /**
68 * Gets the current number of bytes read from this stream.
69 *
70 * @return the number of read bytes
71 * @deprecated this method may yield wrong results for large archives, use #getBytesRead instead
72 */
73 @Deprecated
74 public int getCount() {
75 return (int) bytesRead;
76 }
77
78 /**
79 * Gets the amount of raw or compressed bytes read by the stream.
80 *
81 * <p>
82 * This implementation invokes {@link #getBytesRead}.
83 * </p>
84 *
85 * <p>
86 * Provides half of {@link org.apache.commons.compress.utils.InputStreamStatistics} without forcing subclasses to implement the other half.
87 * </p>
88 *
89 * @return the amount of decompressed bytes returned by the stream
90 * @since 1.17
91 */
92 public long getUncompressedCount() {
93 return getBytesRead();
94 }
95
96 /**
97 * Decrements the counter of already read bytes.
98 *
99 * @param pushedBack the number of bytes pushed back.
100 * @since 1.7
101 */
102 protected void pushedBackBytes(final long pushedBack) {
103 bytesRead -= pushedBack;
104 }
105 }