Class MonitoredOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

ecmwf.common.technical.MonitoredOutputStream

All Implemented Interfaces:

ProgressInterface, StreamMonitorInterface, Closeable, Flushable, AutoCloseable

public class MonitoredOutputStream
extends FilterOutputStream
implements StreamMonitorInterface, ProgressInterface

The Class MonitoredOutputStream.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
MonitoredOutputStream(OutputStream out)	Instantiates a new monitored output stream.
MonitoredOutputStream(OutputStream out, ProgressHandler handler)	Instantiates a new monitored output stream.

Method Summary

Modifier and Type	Method	Description
void	close()	Close.
void	closeAndInterruptIfRequired()	Close and interrupt if required.
long	getByteSent()	Gets the byte sent.
long	getDuration()	Gets the duration.
String	getRate()	Gets the rate.
String	getSimplifiedRate()	Gets the simplified rate.
long	getStartTime()	Gets the start time.
void	write(byte[] b)	Write.
void	write(byte[] b, int off, int len)	Write.
void	write(int b)	Write.

Methods inherited from class java.io.FilterOutputStream

flush

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

MonitoredOutputStream

public MonitoredOutputStream(OutputStream out)

Instantiates a new monitored output stream.

Parameters:

out - the out

MonitoredOutputStream

public MonitoredOutputStream(OutputStream out,
 ProgressHandler handler)

Instantiates a new monitored output stream.

Parameters:

out - the out

handler - the handler

Method Details

close

public void close()
           throws IOException

Close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Write.

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

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

Write.

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Write.

Overrides:

write in class FilterOutputStream

Throws:

IOException

getByteSent

public long getByteSent()

Gets the byte sent. Gets the byte sent.

Specified by:

getByteSent in interface ProgressInterface

Specified by:

getByteSent in interface StreamMonitorInterface

Returns:

the byte sent

getRate

public String getRate()

Gets the rate. Gets the rate.

Specified by:

getRate in interface StreamMonitorInterface

Returns:

the rate

getSimplifiedRate

public String getSimplifiedRate()

Gets the simplified rate. Gets the simplified rate.

Specified by:

getSimplifiedRate in interface StreamMonitorInterface

Returns:

the simplified rate

getStartTime

public long getStartTime()

Gets the start time. Gets the start time.

Specified by:

getStartTime in interface ProgressInterface

Returns:

the start time

getDuration

public long getDuration()

Gets the duration. Gets the duration.

Specified by:

getDuration in interface ProgressInterface

Specified by:

getDuration in interface StreamMonitorInterface

Returns:

the duration

closeAndInterruptIfRequired

public void closeAndInterruptIfRequired()

Close and interrupt if required. Close and interrupt if required.

Specified by:

closeAndInterruptIfRequired in interface ProgressInterface