Module org.arakhne.afc.core.util

Package org.arakhne.afc.progress

Class ProgressionInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.arakhne.afc.progress.ProgressionInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ProgressionInputStream
extends FilterInputStream

InputStream that is able to notify about the reading progression.

Version:

17.0 2020-01-04 14:41:38

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

util

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
ProgressionInputStream(InputStream in, int totalSize, Progression progression)	Constructor.
ProgressionInputStream(InputStream in, Progression progression)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
Progression	getProgression()	Replies the progression model used by this input stream.
int	read()
int	read(byte[] buffer)
int	read(byte[] buffer, int off, int len)
void	reset()
long	skip(long number)

Methods inherited from class java.io.FilterInputStream

available, mark, markSupported

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressionInputStream

public ProgressionInputStream(InputStream in,
                              Progression progression)

Constructor.

Parameters:

in - is the input to read

progression - is the progression model used to notify on the reading progression.

ProgressionInputStream

public ProgressionInputStream(InputStream in,
                              int totalSize,
                              Progression progression)

Constructor.

Parameters:

in - is the input to read

totalSize - is the total number of bytes to read from the stream.

progression - is the progression model used to notify on the reading progression.

Method Detail

getProgression

public Progression getProgression()

Replies the progression model used by this input stream.

Returns:

the progression model.

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] buffer)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long number)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException