Class CountingOutputStream
- All Implemented Interfaces:
- Closeable,- Flushable,- AutoCloseable
A typical use case would be during debugging, to ensure that data is being written as expected.
- 
Nested Class SummaryNested classes/interfaces inherited from class org.apache.commons.io.output.ProxyOutputStreamProxyOutputStream.Builder
- 
Field SummaryFields inherited from class java.io.FilterOutputStreamout
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a new CountingOutputStream.
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidbeforeWrite(int n) Updates the count with the number of bytes that are being written.longThe number of bytes that have passed through this stream.intgetCount()Gets the number of bytes that have passed through this stream.longSets the byte count back to 0.intSets the byte count back to 0.Methods inherited from class org.apache.commons.io.output.ProxyOutputStreamafterWrite, close, flush, handleIOException, setReference, write, write, write
- 
Constructor Details- 
CountingOutputStreamConstructs a new CountingOutputStream.- Parameters:
- out- the OutputStream to write to
 
 
- 
- 
Method Details- 
beforeWriteUpdates the count with the number of bytes that are being written.- Overrides:
- beforeWritein class- ProxyOutputStream
- Parameters:
- n- number of bytes to be written to the stream
- Since:
- 2.0
 
- 
getByteCountThe number of bytes that have passed through this stream.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:
- 1.3
 
- 
getCountGets 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. SeegetByteCount()for a method using along.- Returns:
- the number of bytes accumulated
- Throws:
- ArithmeticException- if the byte count is too large
 
- 
resetByteCountSets the byte count back to 0.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:
- 1.3
 
- 
resetCountSets 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. SeeresetByteCount()for a method using along.- Returns:
- the count previous to resetting
- Throws:
- ArithmeticException- if the byte count is too large
 
 
-