|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.io.OutputStream java.io.FilterOutputStream org.apache.commons.io.output.ProxyOutputStream org.apache.commons.io.output.CountingOutputStream
public class CountingOutputStream
A decorating output 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 written as expected.
Field Summary |
---|
Fields inherited from class java.io.FilterOutputStream |
---|
out |
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. |
Methods inherited from class org.apache.commons.io.output.ProxyOutputStream |
---|
close, flush |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CountingOutputStream(OutputStream out)
out
- the OutputStream to write toMethod Detail |
---|
public void write(byte[] b) throws IOException
write
in class ProxyOutputStream
b
- the bytes to write, not null
IOException
- if an I/O error occursOutputStream.write(byte[])
public void write(byte[] b, int off, int len) throws IOException
write
in class ProxyOutputStream
b
- the bytes to write, not nulloff
- the start offset in the bufferlen
- the maximum number of bytes to write
IOException
- if an I/O error occursOutputStream.write(byte[], int, int)
public void write(int b) throws IOException
write
in class ProxyOutputStream
b
- the byte to write
IOException
- if an I/O error occursOutputStream.write(int)
public int getCount()
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
.
ArithmeticException
- if the byte count is too largepublic int resetCount()
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
.
ArithmeticException
- if the byte count is too largepublic long getByteCount()
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.
public long resetByteCount()
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |