zstd-jni 1.5.5-11 · com.github.luben.zstd.BaseZstdBufferDecompressingStreamNoFinalizer

Modifier and Type	Field and Description
protected boolean	closed
private int	consumed This field is set by the native call to represent the number of bytes consumed from `source` buffer.
private boolean	finishedFrame
private int	produced This field is set by the native call to represent the number of bytes produced into the target buffer.
protected ByteBuffer	source
protected long	stream
private boolean	streamEnd

Access	Constructor and Description
pack-priv	BaseZstdBufferDecompressingStreamNoFinalizer(ByteBuffer source)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
pack-priv abstract long	createDStream()
pack-priv abstract long	decompressStream(long stream, ByteBuffer dst, int dstOffset, int dstSize, ByteBuffer src, int srcOffset, int srcSize)
pack-priv abstract long	freeDStream(long stream)
public boolean	Returns: false if all data is processed and no more data is available from the `source` hasRemaining()
pack-priv abstract long	initDStream(long stream)
public abstract int	Returns: the number of bytes read into the target buffer. read(ByteBuffer buffer to store the read bytes from uncompressed stream. target) Reads the content of the de-compressed stream into the target buffer.
pack-priv int	readInternal(ByteBuffer target, boolean isDirectBufferRequired)
protected ByteBuffer	Returns: either the current buffer (but refilled and flipped if there was new content) or a new buffer. refill(ByteBuffer current buffer toRefill) Override this method in case the byte buffer passed to the constructor might not contain the full compressed stream
public BaseZstdBufferDecompressingStreamNoFinalizer	setDict(byte[] dict)
public BaseZstdBufferDecompressingStreamNoFinalizer	setDict(ZstdDictDecompress dict)
public BaseZstdBufferDecompressingStreamNoFinalizer	Returns: this instance of `BaseZstdBufferDecompressingStreamNoFinalizer` setLongMax(int window size in bytes windowLogMax) Set the value of zstd parameter `ZSTD_d_windowLogMax`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

closed	back to summary
protected boolean closed

consumed	back to summary
private int consumed This field is set by the native call to represent the number of bytes consumed from `source` buffer.

finishedFrame	back to summary
private boolean finishedFrame

produced	back to summary
private int produced This field is set by the native call to represent the number of bytes produced into the target buffer.

source	back to summary
protected ByteBuffer source

stream	back to summary
protected long stream

streamEnd	back to summary
private boolean streamEnd

BaseZstdBufferDecompressingStreamNoFinalizer	back to summary
pack-priv BaseZstdBufferDecompressingStreamNoFinalizer(ByteBuffer source)

Method Detail

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

createDStream	back to summary
pack-priv abstract long createDStream()

decompressStream	back to summary
pack-priv abstract long decompressStream(long stream, ByteBuffer dst, int dstOffset, int dstSize, ByteBuffer src, int srcOffset, int srcSize)

freeDStream	back to summary
pack-priv abstract long freeDStream(long stream)

hasRemaining	back to summary
public boolean hasRemaining() Returns:boolean false if all data is processed and no more data is available from the `source`

initDStream	back to summary
pack-priv abstract long initDStream(long stream)

read back to summary

read	back to summary
public abstract int read(ByteBuffer target) throws IOException Reads the content of the de-compressed stream into the target buffer. This method will block until the chunk of compressed data stored in `source` has been decompressed and written into the target buffer. After each execution, this method will refill the `source` buffer, using `refill(ByteBuffer)`. To read the full stream of decompressed data, this method should be called in a loop while `hasRemaining()` is `true`. The target buffer will be written starting from `ByteBuffer#position()`. The `ByteBuffer#position()` of source and the target buffers will be modified to represent the data read and written respectively. Parameters target:ByteBuffer buffer to store the read bytes from uncompressed stream. Returns:int the number of bytes read into the target buffer. Exceptions IOException: if the stream is closed before reading. ZstdIOException: if an error occurs while reading. IllegalArgumentException: if provided source or target buffers are incorrectly configured.

public abstract int read(ByteBuffer target) throws IOException

Reads the content of the de-compressed stream into the target buffer.

This method will block until the chunk of compressed data stored in source has been decompressed and written into the target buffer. After each execution, this method will refill the source buffer, using refill(ByteBuffer).

To read the full stream of decompressed data, this method should be called in a loop while hasRemaining() is true.

The target buffer will be written starting from ByteBuffer#position(). The ByteBuffer#position() of source and the target buffers will be modified to represent the data read and written respectively.

Parameters

target:ByteBuffer: buffer to store the read bytes from uncompressed stream.

Returns:int

the number of bytes read into the target buffer.

Exceptions

IOException:: if the stream is closed before reading.
ZstdIOException:: if an error occurs while reading.
IllegalArgumentException:: if provided source or target buffers are incorrectly configured.

readInternal	back to summary
pack-priv int readInternal(ByteBuffer target, boolean isDirectBufferRequired) throws IOException

refill	back to summary
protected ByteBuffer refill(ByteBuffer toRefill) Override this method in case the byte buffer passed to the constructor might not contain the full compressed stream Parameters toRefill:ByteBuffer current buffer Returns:ByteBuffer either the current buffer (but refilled and flipped if there was new content) or a new buffer.

refill

back to summary

protected ByteBuffer refill(ByteBuffer toRefill)

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

Parameters

toRefill:ByteBuffer: current buffer

Returns:ByteBuffer

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

setDict	back to summary
public BaseZstdBufferDecompressingStreamNoFinalizer setDict(byte[] dict) throws IOException

setDict	back to summary
public BaseZstdBufferDecompressingStreamNoFinalizer setDict(ZstdDictDecompress dict) throws IOException

setLongMax back to summary

setLongMax	back to summary
public BaseZstdBufferDecompressingStreamNoFinalizer setLongMax(int windowLogMax) throws IOException Set the value of zstd parameter `ZSTD_d_windowLogMax`. Parameters windowLogMax:int window size in bytes Returns:BaseZstdBufferDecompressingStreamNoFinalizer this instance of `BaseZstdBufferDecompressingStreamNoFinalizer` Exceptions ZstdIOException: if there is an error while setting the configuration natively. See Also Zstd's ZSTD_d_windowLogMax parameter

public BaseZstdBufferDecompressingStreamNoFinalizer setLongMax(int windowLogMax) throws IOException

Set the value of zstd parameter ZSTD_d_windowLogMax.

Parameters

windowLogMax:int: window size in bytes

Returns:BaseZstdBufferDecompressingStreamNoFinalizer

this instance of BaseZstdBufferDecompressingStreamNoFinalizer

Exceptions

ZstdIOException:: if there is an error while setting the configuration natively.

See Also

Zstd's ZSTD_d_windowLogMax parameter

public abstract Class BaseZstdBufferDecompressingStreamNoFinalizer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail