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