Module org.arakhne.afc.core.util

Package org.arakhne.afc.progress

Class ProgressionOuputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.arakhne.afc.progress.ProgressionOuputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ProgressionOuputStream
extends FilterOutputStream

OutputStream that is able to notify about the writing 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.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
ProgressionOuputStream(OutputStream out, int totalSize, Progression progression)	Construct a progression output stream.

Method Summary

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

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 Detail

ProgressionOuputStream

public ProgressionOuputStream(OutputStream out,
                              int totalSize,
                              Progression progression)

Construct a progression output stream.

Parameters:

out - is the output to write

totalSize - is the total number of bytes to write in 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.

write

public void write(int abyte)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] buffer)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException