Package no.digipost.io

Class ConsumingInputStream

java.lang.Object

java.io.InputStream

no.digipost.io.ConsumingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ConsumingInputStream
extends InputStream

An InputStream getting its contents from consuming an OutputStream. The InputStream will be immediately available for reading after construction, regardless of how much data that will be produced by the OutputStream. This class abstracts the use of a PipedInputStream and a PipedOutputStream, hiding the complexities required to orchestrate this multithreaded combination of streams.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConsumingInputStream.ProducerFailed

Constructor Summary

Constructors

Constructor	Description
ConsumingInputStream(ExecutorService executorService, Consumer<? super OutputStream> write)	Create a new ConsumingInputStream which will provide data once they are written to an OutputStream passed to the given Consumer.
ConsumingInputStream(ExecutorService executorService, Function<OutputStream,S> outputStreamDecorator, Consumer<? super S> write)	Create a new ConsumingInputStream which will provide data once they are written to an OutputStream passed to the given Consumer.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

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

ConsumingInputStream

public ConsumingInputStream(ExecutorService executorService,
                            Consumer<? super OutputStream> write)

Create a new ConsumingInputStream which will provide data once they are written to an OutputStream passed to the given Consumer.

Parameters:

executorService - The executorService to use to start producing data which will be readable by this inputstream.

write - The data producing logic. The Consumer will be given the OutputStream resulting from the outputStreamDecorator.

ConsumingInputStream

public ConsumingInputStream(ExecutorService executorService,
                            Function<OutputStream,S> outputStreamDecorator,
                            Consumer<? super S> write)

Create a new ConsumingInputStream which will provide data once they are written to an OutputStream passed to the given Consumer.

Parameters:

executorService - The executorService to use to start producing data which will be readable by this inputstream.

outputStreamDecorator - A Function to wrap the outputstream to push data to. This Function must always wrap the given OutputStream in the OutputStream returned from this Function, i.e. the resulting OutputStream must be constructed by wrapping the given OutputStream as a constructor argument. (E.g. ZipOutputStream::new.

write - The data producing logic. The Consumer will be given the OutputStream resulting from the outputStreamDecorator.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream