Class ZstdInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.github.luben.zstd.ZstdInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZstdInputStream
extends FilterInputStream

InputStream filter that decompresses the data provided by the underlying InputStream using Zstd compression. It does not support mark/reset methods

Field Summary

Fields inherited from class FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
ZstdInputStream(@NotNull InputStream inStream)	create a new decompressing InputStream
ZstdInputStream(@NotNull InputStream inStream, @NotNull BufferPool bufferPool)	create a new decompressing InputStream

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
protected void	finalize()
boolean	getContinuous()
boolean	markSupported()
int	read()
int	read(byte @NotNull [] dst, int offset, int len)
static long	recommendedDInSize()
static long	recommendedDOutSize()
@NotNull ZstdInputStream	setContinuous(boolean b)	Don't break on unfinished frames Use case: decompressing files that are not yet finished writing and compressing
@NotNull ZstdInputStream	setDict(byte @NotNull [] dict)
@NotNull ZstdInputStream	setDict(@NotNull ZstdDictDecompress dict)
void	setFinalize(boolean finalize)	Deprecated. If you don't rely on finalizers, use `ZstdInputStreamNoFinalizer` instead, instances of `ZstdInputStream` will always try to close/release in the finalizer.
@NotNull ZstdInputStream	setLongMax(int windowLogMax)
@NotNull ZstdInputStream	setRefMultipleDDicts(boolean useMultiple)	Enable or disable support for multiple dictionary references
long	skip(long numBytes)

Methods inherited from class FilterInputStream

mark, read, reset

Methods inherited from class InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

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

Constructor Details

ZstdInputStream

public ZstdInputStream(@NotNull
 @NotNull InputStream inStream)
                throws IOException

create a new decompressing InputStream

Parameters:

inStream - the stream to wrap

Throws:

IOException

ZstdInputStream

public ZstdInputStream(@NotNull
 @NotNull InputStream inStream,
 @NotNull
 @NotNull BufferPool bufferPool)
                throws IOException

create a new decompressing InputStream

Parameters:

inStream - the stream to wrap

bufferPool - the pool to fetch and return buffers

Throws:

IOException

Method Details

setFinalize

@Deprecated
public void setFinalize(boolean finalize)

Deprecated.

If you don't rely on finalizers, use `ZstdInputStreamNoFinalizer` instead, instances of `ZstdInputStream` will always try to close/release in the finalizer.

Enable or disable class finalizers

Parameters:

finalize - default `true` - finalizers are enabled

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

recommendedDInSize

public static long recommendedDInSize()

recommendedDOutSize

public static long recommendedDOutSize()

setContinuous

@NotNull
public @NotNull ZstdInputStream setContinuous(boolean b)

Don't break on unfinished frames Use case: decompressing files that are not yet finished writing and compressing

getContinuous

public boolean getContinuous()

setDict

@NotNull
public @NotNull ZstdInputStream setDict(byte @NotNull [] dict)
                                 throws IOException

Throws:

IOException

setDict

@NotNull
public @NotNull ZstdInputStream setDict(@NotNull
 @NotNull ZstdDictDecompress dict)
                                 throws IOException

Throws:

IOException

setLongMax

@NotNull
public @NotNull ZstdInputStream setLongMax(int windowLogMax)
                                    throws IOException

Throws:

IOException

setRefMultipleDDicts

@NotNull
public @NotNull ZstdInputStream setRefMultipleDDicts(boolean useMultiple)
                                              throws IOException

Enable or disable support for multiple dictionary references

Parameters:

useMultiple - Enables references table for DDict, so the DDict used for decompression will be determined per the dictId in the frame, default: false

Throws:

IOException

read

public int read(byte @NotNull [] dst,
 int offset,
 int len)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

skip

public long skip(long numBytes)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterInputStream

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