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.utils; 20 21 import java.io.FilterInputStream; 22 import java.io.IOException; 23 import java.io.InputStream; 24 25 /** 26 * Input stream that tracks the number of bytes read. 27 * 28 * @since 1.3 29 * @NotThreadSafe 30 * @deprecated Use {@link org.apache.commons.io.input.CountingInputStream}. 31 */ 32 @Deprecated 33 public class CountingInputStream extends FilterInputStream { 34 private long bytesRead; 35 36 public CountingInputStream(final InputStream in) { 37 super(in); 38 } 39 40 /** 41 * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1) 42 * 43 * @param read the number of bytes read 44 */ 45 protected final void count(final long read) { 46 if (read != -1) { 47 bytesRead += read; 48 } 49 } 50 51 /** 52 * Returns the current number of bytes read from this stream. 53 * 54 * @return the number of read bytes 55 */ 56 public long getBytesRead() { 57 return bytesRead; 58 } 59 60 @Override 61 public int read() throws IOException { 62 final int r = in.read(); 63 if (r >= 0) { 64 count(1); 65 } 66 return r; 67 } 68 69 @Override 70 public int read(final byte[] b) throws IOException { 71 return read(b, 0, b.length); 72 } 73 74 @Override 75 public int read(final byte[] b, final int off, final int len) throws IOException { 76 if (len == 0) { 77 return 0; 78 } 79 final int r = in.read(b, off, len); 80 if (r >= 0) { 81 count(r); 82 } 83 return r; 84 } 85 }