Package nl.vpro.util

Class FileCachingInputStream

java.lang.Object

java.io.InputStream

nl.vpro.util.FileCachingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class FileCachingInputStream
extends InputStream

When wrapping this around your inputstream, it will be read as fast a possible, but you can consume from it slower.

It will first buffer to an internal byte array (if the initial buffer size > 0, defaults to 2048). If that is too small it will buffer the result to a temporary file.

Use this if you want to consume an inputstream as fast as possible, while handing it at a slower pace. The cost is the creation of the temporary file.

Since:

0.50

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileCachingInputStream.Builder

Method Summary

Modifier and Type	Method	Description
int	available()
static FileCachingInputStream.Builder	builder()
void	close()
protected void	closeTempFile()
void	deleteTempFile()
int	getBufferLength()
long	getCount()	Returns the number of bytes consumed from the input stream so far
Optional<Throwable>	getException()	Returns the exception that may have happened.
Long	getExpectedCount()
CompletableFuture<FileCachingInputStream>	getFuture()
Path	getTempFile()	If a temp file is used for buffering, you may obtain it.
boolean	isClosed()
boolean	isReady()	Returns whether consuming the inputstream is ready.
int	read()
int	read(byte @NonNull [] b, int off, int len)
static Consumer<FileCachingInputStream>	throttle(Duration d)
String	toString()
long	waitForBytesRead(int atLeast)	Wait until the copier thread read at least the number of bytes given.

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Method Details

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

getBufferLength

public int getBufferLength()

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

closeTempFile

protected void closeTempFile()
                      throws IOException

Throws:

IOException

deleteTempFile

public void deleteTempFile()

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

toString

public String toString()

Overrides:

toString in class Object

waitForBytesRead

public long waitForBytesRead(int atLeast)
                      throws InterruptedException

Wait until the copier thread read at least the number of bytes given.

Throws:

InterruptedException

getCount

public long getCount()

Returns the number of bytes consumed from the input stream so far

isReady

public boolean isReady()

Returns whether consuming the inputstream is ready.

getException

public Optional<Throwable> getException()

Returns the exception that may have happened. E.g. for use in the call back.

throttle

public static Consumer<FileCachingInputStream> throttle(Duration d)

builder

public static FileCachingInputStream.Builder builder()

getTempFile

public Path getTempFile()

If a temp file is used for buffering, you may obtain it.

isClosed

public boolean isClosed()

getExpectedCount

public Long getExpectedCount()

getFuture

public CompletableFuture<FileCachingInputStream> getFuture()