org.das2.util

Class DasProgressMonitorInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.das2.util.DasProgressMonitorInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DasProgressMonitorInputStream
extends java.io.FilterInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
DasProgressMonitorInputStream(java.io.InputStream in, ProgressMonitor monitor) Creates a new instance of DasProgressMonitorInputStream

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds a PropertyChangeListener to the listener list.
void	addRunWhenClosedRunnable(java.lang.Runnable run) should an action be needed when the transaction is complete, for example closing a network connection, this can be used.
void	close() close resources needed and set the monitor finished flag.
long	getStreamLength() the length of the stream in bytes.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes a PropertyChangeListener from the listener list.
void	setEnableProgressPosition(boolean value) disable/enable setting of progress position, true by default.
void	setStreamLength(long streamLength) set the length of the stream in bytes.

Methods inherited from class java.io.FilterInputStream

available, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

DasProgressMonitorInputStream

public DasProgressMonitorInputStream(java.io.InputStream in,
                                     ProgressMonitor monitor)

Creates a new instance of DasProgressMonitorInputStream

Parameters:

in - the InputStream to monitor as data comes in.

monitor - the monitor to report feedback

Method Detail

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

addRunWhenClosedRunnable

public void addRunWhenClosedRunnable(java.lang.Runnable run)

should an action be needed when the transaction is complete, for example closing a network connection, this can be used.

Parameters:

run -

close

public void close()
           throws java.io.IOException

close resources needed and set the monitor finished flag. If and runWhenClosedRunnables have been added, call them.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

Throws:

java.io.IOException

setEnableProgressPosition

public void setEnableProgressPosition(boolean value)

disable/enable setting of progress position, true by default. Transfer rate will still be reported. This is introduced in case another agent (the das2Stream reader, in particular) can set the progress position more accurately.

Parameters:

value -

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds a PropertyChangeListener to the listener list.

Parameters:

l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes a PropertyChangeListener from the listener list.

Parameters:

l - The listener to remove.

getStreamLength

public long getStreamLength()

the length of the stream in bytes. Note often the length is not known, and it is by default 1000000.

Returns:

length of the stream in bytes, or 10000000.

setStreamLength

public void setStreamLength(long streamLength)

set the length of the stream in bytes.

Parameters:

streamLength - the length of the stream in bytes.