org.apache.gobblin.util.io

Class MeteredOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.apache.gobblin.util.io.MeteredOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, MeteredStream

public class MeteredOutputStream
extends FilterOutputStream
implements MeteredStream

A FilterOutputStream that counts the bytes read from the underlying OutputStream.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
MeteredOutputStream(OutputStream out, Meter meter, int updateFrequency) Builds a MeteredOutputStream.

Method Summary

Modifier and Type	Method and Description
static com.google.common.base.Optional<MeteredOutputStream>	findWrappedMeteredOutputStream(OutputStream os) Find the lowest MeteredOutputStream in a chain of FilterOutputStreams.
Meter	getBytesProcessedMeter()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.FilterOutputStream

close, flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

MeteredOutputStream

public MeteredOutputStream(OutputStream out,
                           Meter meter,
                           int updateFrequency)

Builds a MeteredOutputStream.

Parameters:

out - The OutputStream to measure.

meter - A Meter to use for measuring the OutputStream. If null, a new Meter will be created.

updateFrequency - For performance, MeteredInputStream will batch Meter updates to this many bytes.

Method Detail

findWrappedMeteredOutputStream

public static com.google.common.base.Optional<MeteredOutputStream> findWrappedMeteredOutputStream(OutputStream os)

Find the lowest MeteredOutputStream in a chain of FilterOutputStreams.

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

getBytesProcessedMeter

public Meter getBytesProcessedMeter()

Specified by:

getBytesProcessedMeter in interface MeteredStream

Returns:

The Meter measuring the bytes processed.