Package org.apache.commons.io.input
Class CountingInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.commons.io.input.ProxyInputStream
org.apache.commons.io.input.CountingInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
ChecksumInputStream
,ThrottledInputStream
Deprecated.
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.
-
Field Summary
Fields inherited from class java.io.FilterInputStream
in
-
Constructor Summary
ConstructorDescriptionDeprecated.Constructs a new CountingInputStream. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
afterRead
(int n) Deprecated.Adds the number of read bytes to the count.long
Deprecated.Gets number of bytes that have passed through this stream.int
getCount()
Deprecated.UsegetByteCount()
.long
Deprecated.Resets the byte count back to 0.int
Deprecated.UseresetByteCount()
.long
skip
(long length) Deprecated.Skips the stream over the specified number of bytes, adding the skipped amount to the count.Methods inherited from class org.apache.commons.io.input.ProxyInputStream
available, beforeRead, close, handleIOException, mark, markSupported, read, read, read, reset, unwrap
-
Constructor Details
-
CountingInputStream
Deprecated.Constructs a new CountingInputStream.- Parameters:
in
- the InputStream to delegate to
-
-
Method Details
-
afterRead
Deprecated.Adds the number of read bytes to the count.- Overrides:
afterRead
in classProxyInputStream
- Parameters:
n
- number of bytes read, or -1 if no more bytes are available- Throws:
IOException
- Not thrown here but subclasses may throw.- Since:
- 2.0
-
getByteCount
Deprecated.Gets 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.- Returns:
- the number of bytes accumulated
- Since:
- 1.3
-
getCount
Deprecated.UsegetByteCount()
.Gets number of bytes that have passed through this stream.This method throws an ArithmeticException if the count is greater than can be expressed by an
int
. SeegetByteCount()
for a method using along
.- Returns:
- the number of bytes accumulated
- Throws:
ArithmeticException
- if the byte count is too large
-
resetByteCount
Deprecated.Resets 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.- Returns:
- the count previous to resetting
- Since:
- 1.3
-
resetCount
Deprecated.UseresetByteCount()
.Resets the byte count back to 0.This method throws an ArithmeticException if the count is greater than can be expressed by an
int
. SeeresetByteCount()
for a method using along
.- Returns:
- the count previous to resetting
- Throws:
ArithmeticException
- if the byte count is too large
-
skip
Deprecated.Skips the stream over the specified number of bytes, adding the skipped amount to the count.- Overrides:
skip
in classProxyInputStream
- Parameters:
length
- the number of bytes to skip- Returns:
- the actual number of bytes skipped
- Throws:
IOException
- if an I/O error occurs.- See Also:
-
BoundedInputStream
(unbounded by default).