com.xilinx.rapidwright.util.function

Interface InputStreamSupplier

All Superinterfaces:

org.apache.commons.io.function.IOSupplier<InputStream>

public interface InputStreamSupplier
extends org.apache.commons.io.function.IOSupplier<InputStream>

Method Summary

Modifier and Type	Method and Description
static InputStreamSupplier	fromPath(Path p, boolean decompressToDisk)
static InputStream	getInputStream(Path fileName, boolean decompressToDisk) Gets the InputStream for the provided file path.

Methods inherited from interface org.apache.commons.io.function.IOSupplier

get

Method Detail

fromPath

static InputStreamSupplier fromPath(Path p,
                                    boolean decompressToDisk)

getInputStream

static InputStream getInputStream(Path fileName,
                                  boolean decompressToDisk)

Gets the InputStream for the provided file path. If the file is gzipped (*.gz extension), it will decompress the file alongside the original with the '.gz' extension removed.

Parameters:

fileName - Path to the file or gzipped file from which to get an InputStream.

decompressToDisk - To make certain operations faster, decompress the file to disk first rather than to decompress through the InputStream.

Returns:

An InputStream of the file, or of a decompressed copy of a gzipped file.