Package com.atlassian.jira.task

Class ProgressMonitoringFileInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.atlassian.jira.task.ProgressMonitoringFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ProgressMonitoringFileInputStream
extends FilterInputStream

A FileInputStream that can log progress when the inputstream is being read. The passed in task progress sink should have been provided with the overall file size to be read already to provide meaningful updates since the underlying inputstream implementation may not return the overall size of the data to be read reliably.

Since:

v4.4

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
ProgressMonitoringFileInputStream(InputStream in, TaskProgressSink taskProgressSink, String subTask, String message)

Method Summary

Modifier and Type	Method	Description
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, reset, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressMonitoringFileInputStream

public ProgressMonitoringFileInputStream(InputStream in,
 TaskProgressSink taskProgressSink,
 String subTask,
 String message)

Method Details

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException