com.google.common.io

Class CountingOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.google.common.io.CountingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

@Beta
public final class CountingOutputStream
extends FilterOutputStream

An OutputStream that counts the number of bytes written.

Since:

1.0

Author:

Chris Nokleberg

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
CountingOutputStream(OutputStream out) Wraps another output stream, counting the number of bytes written.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this output stream and releases any system resources associated with the stream.
long	getCount() Returns the number of bytes written.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int b) Writes the specified byte to this output stream.

Methods inherited from class java.io.FilterOutputStream

flush, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CountingOutputStream

public CountingOutputStream(@Nullable
                    OutputStream out)

Wraps another output stream, counting the number of bytes written.

Parameters:

out - the output stream to be wrapped

Method Detail

getCount

public long getCount()

Returns the number of bytes written.

write

public void write(byte[] b,
         int off,
         int len)
           throws IOException

Description copied from class: java.io.FilterOutputStream

Writes len bytes from the specified byte array starting at offset off to this output stream.

The write method of FilterOutputStream calls the write method of one argument on each byte to output.

Note that this method does not call the write method of its underlying input stream with the same arguments. Subclasses of FilterOutputStream should provide a more efficient implementation of this method.

Overrides:

write in class FilterOutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

IOException - if an I/O error occurs.

See Also:

FilterOutputStream.write(int)

write

public void write(int b)
           throws IOException

Description copied from class: java.io.FilterOutputStream

Writes the specified byte to this output stream.

The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b).

Implements the abstract write method of OutputStream.

Overrides:

write in class FilterOutputStream

Parameters:

b - the byte.

Throws:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Description copied from class: java.io.FilterOutputStream

Closes this output stream and releases any system resources associated with the stream.

The close method of FilterOutputStream calls its flush method, and then calls the close method of its underlying output stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterOutputStream

Throws:

IOException - if an I/O error occurs.

See Also:

FilterOutputStream.flush(), FilterOutputStream.out