Class ZstdBufferDecompressingStream

java.lang.Object

com.github.luben.zstd.ZstdBufferDecompressingStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZstdBufferDecompressingStream
extends Object
implements Closeable

Constructor Summary

Constructors

Constructor	Description
ZstdBufferDecompressingStream(@NotNull ByteBuffer source)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
boolean	hasRemaining()
int	read(@NotNull ByteBuffer target)
static int	recommendedTargetBufferSize()
protected @NotNull ByteBuffer	refill(@NotNull ByteBuffer toRefill)	Override this method in case the byte buffer passed to the constructor might not contain the full compressed stream
@NotNull ZstdBufferDecompressingStream	setDict(byte @NotNull [] dict)
@NotNull ZstdBufferDecompressingStream	setDict(@NotNull ZstdDictDecompress dict)
void	setFinalize(boolean finalize)	Enable or disable class finalizers
@NotNull ZstdBufferDecompressingStream	setLongMax(int windowLogMax)

Methods inherited from class Object

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

Constructor Details

ZstdBufferDecompressingStream

public ZstdBufferDecompressingStream(@NotNull
 @NotNull ByteBuffer source)

Method Details

refill

@NotNull
protected @NotNull ByteBuffer refill(@NotNull
 @NotNull ByteBuffer toRefill)

Override this method in case the byte buffer passed to the constructor might not contain the full compressed stream

Parameters:

toRefill - current buffer

Returns:

either the current buffer (but refilled and flipped if there was new content) or a new buffer.

setFinalize

public void setFinalize(boolean finalize)

Enable or disable class finalizers

If finalizers are disabled the responsibility fir calling the `close` method is on the consumer.

Parameters:

finalize - default `true` - finalizers are enabled

hasRemaining

public boolean hasRemaining()

recommendedTargetBufferSize

public static int recommendedTargetBufferSize()

setDict

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

Throws:

IOException

setDict

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

Throws:

IOException

setLongMax

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

Throws:

IOException

read

public int read(@NotNull
 @NotNull ByteBuffer target)
         throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable