| org.apache.commons.io.input.ProxyInputStream
 org.apache.commons.io.input.CountingInputStream
| CountingInputStream | | public class CountingInputStream extends ProxyInputStream (Code) | | A decorating input stream that counts the number of bytes that have passed
through the stream so far.
A typical use case would be during debugging, to ensure that data is being
read as expected.
author:
Marcelo Liberato
version:
$Id: CountingInputStream.java 471628 2006-11-06 04:06:45Z bayard $ |
| Method Summary | |
| public synchronized long | getByteCount()
The number of bytes that have passed through this stream. | | public synchronized int | getCount()
The number of bytes that have passed through this stream. | | public int | read(byte[] b)
Reads a number of bytes into the byte array, keeping count of the
number read. | | public int | read(byte[] b, int off, int len)
Reads a number of bytes into the byte array at a specific offset,
keeping count of the number read. | | public int | read()
Reads the next byte of data adding to the count of bytes received
if a byte is successfully read. | | public synchronized long | resetByteCount()
Set the byte count back to 0. | | public synchronized int | resetCount()
Set the byte count back to 0. | | public long | skip(long length)
Skips the stream over the specified number of bytes, adding the skipped
amount to the count. |
| CountingInputStream | | public CountingInputStream(InputStream in)(Code) | | Constructs a new CountingInputStream.
Parameters:
in - the InputStream to delegate to |
| getByteCount | | public synchronized long getByteCount()(Code) | | The number of bytes that have passed through this stream.
NOTE: This method is an alternative for getCount()
and was added because that method returns an integer which will
result in incorrect count for files over 2GB.
the number of bytes accumulated
since:
Commons IO 1.3 |
| getCount | | public synchronized int getCount()(Code) | | The number of bytes that have passed through this stream.
NOTE: From v1.3 this method throws an ArithmeticException if the
count is greater than can be expressed by an int.
See
CountingInputStream.getByteCount() for a method using a long.
the number of bytes accumulated
throws:
ArithmeticException - if the byte count is too large |
| read | | public int read(byte[] b) throws IOException(Code) | | Reads a number of bytes into the byte array, keeping count of the
number read.
Parameters:
b - the buffer into which the data is read, not null the total number of bytes read into the buffer, -1 if end of stream
throws:
IOException - if an I/O error occurs
See Also: java.io.InputStream.read(byte[])
See Also: |
| read | | public int read(byte[] b, int off, int len) throws IOException(Code) | | Reads a number of bytes into the byte array at a specific offset,
keeping count of the number read.
Parameters:
b - the buffer into which the data is read, not null
Parameters:
off - the start offset in the buffer
Parameters:
len - the maximum number of bytes to read the total number of bytes read into the buffer, -1 if end of stream
throws:
IOException - if an I/O error occurs
See Also: java.io.InputStream.read(byte[]intint) |
| resetByteCount | | public synchronized long resetByteCount()(Code) | | Set the byte count back to 0.
NOTE: This method is an alternative for resetCount()
and was added because that method returns an integer which will
result in incorrect count for files over 2GB.
the count previous to resetting
since:
Commons IO 1.3 |
| resetCount | | public synchronized int resetCount()(Code) | | Set the byte count back to 0.
NOTE: From v1.3 this method throws an ArithmeticException if the
count is greater than can be expressed by an int.
See
CountingInputStream.resetByteCount() for a method using a long.
the count previous to resetting
throws:
ArithmeticException - if the byte count is too large |
| skip | | public long skip(long length) throws IOException(Code) | | Skips the stream over the specified number of bytes, adding the skipped
amount to the count.
Parameters:
length - the number of bytes to skip the actual number of bytes skipped
throws:
IOException - if an I/O error occurs
See Also: java.io.InputStream.skip(long) |
|
|