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.
Modifier and Type | Field and Description |
---|---|
private long |
count
The count of bytes that have passed.
|
Constructor and Description |
---|
CountingOutputStream(java.io.OutputStream out)
Constructs a new CountingOutputStream.
|
Modifier and Type | Method and Description |
---|---|
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.
|
close, flush
public CountingOutputStream(java.io.OutputStream out)
out
- the OutputStream to write topublic void write(byte[] b) throws java.io.IOException
write
in class ProxyOutputStream
b
- the bytes to write, not nulljava.io.IOException
- if an I/O error occursOutputStream.write(byte[])
public void write(byte[] b, int off, int len) throws java.io.IOException
write
in class ProxyOutputStream
b
- the bytes to write, not nulloff
- the start offset in the bufferlen
- the maximum number of bytes to writejava.io.IOException
- if an I/O error occursOutputStream.write(byte[], int, int)
public void write(int b) throws java.io.IOException
write
in class ProxyOutputStream
b
- the byte to writejava.io.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
.
java.lang.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
.
java.lang.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.
Copyright (c) 2002-2015 Apache Software Foundation