Class MonitoredInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

ecmwf.common.technical.MonitoredInputStream

All Implemented Interfaces:

ProgressInterface, StreamMonitorInterface, Closeable, AutoCloseable

public class MonitoredInputStream
extends FilterInputStream
implements StreamMonitorInterface, ProgressInterface

The Class MonitoredInputStream.

Field Summary

Fields inherited from class FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
MonitoredInputStream(InputStream in)	Instantiates a new monitored input stream.
MonitoredInputStream(InputStream in, long delta, ProgressHandler handler)	Instantiates a new monitored input 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.
long	getDurationOnClose()	Gets the duration on close.
String	getRate()	Gets the rate.
String	getRateOnClose()	Gets the rate on close.
String	getSimplifiedRate()	Gets the simplified rate.
String	getSimplifiedRateOnClose()	Gets the simplified rate on close.
long	getStartTime()	Gets the start time.
int	read()	Read.
int	read(byte[] b)	Read.
int	read(byte[] b, int off, int len)	Read.
void	setByteSent(long byteCount)	Sets the byte sent.

Methods inherited from class FilterInputStream

available, mark, markSupported, reset, skip

Methods inherited from class InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

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

Constructor Details

MonitoredInputStream

public MonitoredInputStream(InputStream in)

Instantiates a new monitored input stream.

Parameters:

in - the in

MonitoredInputStream

public MonitoredInputStream(InputStream in,
 long delta,
 ProgressHandler handler)

Instantiates a new monitored input stream. If delta is set to -1 then no debug is displayed in the logs.

Parameters:

in - the in

delta - the delta

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 FilterInputStream

Throws:

IOException - Signals that an I/O exception has occurred.

read

public int read()
         throws IOException

Read.

Overrides:

read in class FilterInputStream

Returns:

the int

Throws:

IOException - Signals that an I/O exception has occurred.

read

public int read(byte[] b)
         throws IOException

Read.

Overrides:

read in class FilterInputStream

Parameters:

b - the b

Returns:

the int

Throws:

IOException - Signals that an I/O exception has occurred.

read

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

Read.

Overrides:

read in class FilterInputStream

Parameters:

b - the b

off - the off

len - the len

Returns:

the int

Throws:

IOException - Signals that an I/O exception has occurred.

setByteSent

public void setByteSent(long byteCount)

Sets the byte sent.

Parameters:

byteCount - the new byte sent

getByteSent

public long getByteSent()

Gets the byte sent.

Specified by:

getByteSent in interface ProgressInterface

Specified by:

getByteSent in interface StreamMonitorInterface

Returns:

the byte sent

getStartTime

public long getStartTime()

Gets the start time.

Specified by:

getStartTime in interface ProgressInterface

Returns:

the start time

getRate

public String getRate()

Gets the rate.

Specified by:

getRate in interface StreamMonitorInterface

Returns:

the rate

getRateOnClose

public String getRateOnClose()

Gets the rate on close.

Returns:

the rate on close

getSimplifiedRate

public String getSimplifiedRate()

Gets the simplified rate.

Specified by:

getSimplifiedRate in interface StreamMonitorInterface

Returns:

the simplified rate

getSimplifiedRateOnClose

public String getSimplifiedRateOnClose()

Gets the simplified rate on close.

Returns:

the simplified rate on close

getDuration

public long getDuration()

Gets the duration.

Specified by:

getDuration in interface ProgressInterface

Specified by:

getDuration in interface StreamMonitorInterface

Returns:

the duration

getDurationOnClose

public long getDurationOnClose()

Gets the duration on close.

Returns:

the duration on close

closeAndInterruptIfRequired

public void closeAndInterruptIfRequired()

Close and interrupt if required.

Specified by:

closeAndInterruptIfRequired in interface ProgressInterface