org.apache.commons.io.output
public class CountingOutputStream extends ProxyOutputStream
A typical use case would be during debugging, to ensure that data is being written as expected.
Version: $Id: CountingOutputStream.java 471628 2006-11-06 04:06:45Z bayard $
Field Summary | |
---|---|
long | count The count of bytes that have passed. |
Constructor Summary | |
---|---|
CountingOutputStream(OutputStream out)
Constructs a new CountingOutputStream.
|
Method Summary | |
---|---|
long | getByteCount()
The number of bytes that have passed through this stream.
|
int | getCount()
The number of bytes that have passed through this stream.
|
long | resetByteCount()
Set the byte count back to 0.
|
int | resetCount()
Set the byte count back to 0.
|
void | write(byte[] b)
Writes the contents of the specified byte array to this output stream
keeping count of the number of bytes written.
|
void | write(byte[] b, int off, int len)
Writes a portion of the specified byte array to this output stream
keeping count of the number of bytes written.
|
void | write(int b)
Writes a single byte to the output stream adding to the count of the
number of bytes written.
|
Parameters: out the OutputStream to write to
NOTE: This method is an alternative for getCount()
.
It 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: Commons IO 1.3
NOTE: From v1.3 this method throws an ArithmeticException if the
count is greater than can be expressed by an int
.
See getByteCount for a method using a long
.
Returns: the number of bytes accumulated
Throws: ArithmeticException if the byte count is too large
NOTE: This method is an alternative for resetCount()
.
It 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: Commons IO 1.3
NOTE: From v1.3 this method throws an ArithmeticException if the
count is greater than can be expressed by an int
.
See resetByteCount for a method using a long
.
Returns: the count previous to resetting
Throws: ArithmeticException if the byte count is too large
Parameters: b the bytes to write, not null
Throws: IOException if an I/O error occurs
See Also: java.io.OutputStream#write(byte[])
Parameters: b the bytes to write, not null off the start offset in the buffer len the maximum number of bytes to write
Throws: IOException if an I/O error occurs
See Also: java.io.OutputStream#write(byte[], int, int)
Parameters: b the byte to write
Throws: IOException if an I/O error occurs
See Also: java.io.OutputStream#write(int)