org.apache.commons.compress.utils
Class CountingInputStream

java.lang.Object
  extended by java.io.InputStream
      extended by java.io.FilterInputStream
          extended by org.apache.commons.compress.utils.CountingInputStream
All Implemented Interfaces:
Closeable

public class CountingInputStream
extends FilterInputStream

Stream that tracks the number of bytes read.

Since:
1.3

Field Summary
 
Fields inherited from class java.io.FilterInputStream
in
 
Constructor Summary
CountingInputStream(InputStream in)
           
 
Method Summary
protected  void count(long read)
          Increments the counter of already read bytes.
 long getBytesRead()
          Returns the current number of bytes read from this stream.
 int read()
           
 int read(byte[] b)
           
 int read(byte[] b, int off, int len)
           
 
Methods inherited from class java.io.FilterInputStream
available, close, mark, markSupported, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CountingInputStream

public CountingInputStream(InputStream in)
Method Detail

read

public int read()
         throws IOException
Overrides:
read in class FilterInputStream
Throws:
IOException

read

public int read(byte[] b)
         throws IOException
Overrides:
read in class FilterInputStream
Throws:
IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException
Overrides:
read in class FilterInputStream
Throws:
IOException

count

protected final void count(long read)
Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)

Parameters:
read - the number of bytes read

getBytesRead

public long getBytesRead()
Returns the current number of bytes read from this stream.

Returns:
the number of read bytes


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.