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

Modifier and Type	Field and Description
private final BufferPool	bufferPool
private boolean	closeFrameOnFlush
private final byte[]	dst
private final ByteBuffer	dstByteBuffer
private long	dstPos
private static final int	dstSize
private boolean	frameClosed
private boolean	frameStarted
private boolean	isClosed
private long	srcPos
private final long	stream

Access	Constructor and Description
public	ZstdOutputStreamNoFinalizer(OutputStream the stream to wrap outStream, int the compression level level) create a new compressing OutputStream
public	ZstdOutputStreamNoFinalizer(OutputStream the stream to wrap outStream) create a new compressing OutputStream
public	ZstdOutputStreamNoFinalizer(OutputStream the stream to wrap outStream, BufferPool the pool to fetch and return buffers bufferPool, int level) create a new compressing OutputStream
public	ZstdOutputStreamNoFinalizer(OutputStream the stream to wrap outStream, BufferPool the pool to fetch and return buffers bufferPool) create a new compressing OutputStream

Method Summary

Modifier and Type	Method and Description
public synchronized void	close() Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with the stream.
private void	close(boolean closeParentStream)
public synchronized void	closeWithoutClosingParentStream()
private native int	compressStream(long ctx, byte[] dst, int dst_size, byte[] src, int src_size)
private static native long	createCStream()
private native int	endStream(long ctx, byte[] dst, int dst_size)
public synchronized void	flush() Overrides java.io.FilterOutputStream.flush. Implements java.io.Flushable.flush. Flushes the output
private native int	flushStream(long ctx, byte[] dst, int dst_size)
private static native int	freeCStream(long ctx)
public static native long	recommendedCOutSize()
private native int	resetCStream(long ctx)
public synchronized ZstdOutputStreamNoFinalizer	setChainLog(int chainLog) Advanced Compression Option: Set the maximum number of bits for the secondary search structure.
public synchronized ZstdOutputStreamNoFinalizer	setChecksum(boolean useChecksums) Enable checksums for the compressed stream.
public synchronized ZstdOutputStreamNoFinalizer	setCloseFrameOnFlush(boolean closeOnFlush) Enable closing the frame on flush.
public synchronized ZstdOutputStreamNoFinalizer	setDict(byte[] dict)
public synchronized ZstdOutputStreamNoFinalizer	setDict(ZstdDictCompress dict)
public synchronized ZstdOutputStreamNoFinalizer	setHashLog(int hashLog) Advanced Compression Option: Set the maximum number of bits for a hash table.
public synchronized ZstdOutputStreamNoFinalizer	setJobSize(int jobSize) Advanced Compression Option: Set the size of each compression job.
public synchronized ZstdOutputStreamNoFinalizer	setLevel(int level) Set the compression level.
public synchronized ZstdOutputStreamNoFinalizer	setLong(int windowLog) Enable Long Distance Matching and set the Window size Log.
public synchronized ZstdOutputStreamNoFinalizer	setMinMatch(int minMatch) Advanced Compression Option: Set the minimum match length.
public synchronized ZstdOutputStreamNoFinalizer	setOverlapLog(int overlapLog) Advanced Compression Option: Set the amount of data reloaded from the previous job.
public synchronized ZstdOutputStreamNoFinalizer	setSearchLog(int searchLog) Advanced Compression Option: Set the maximum number of searches in a hash chain or a binary tree using logarithmic scale.
public synchronized ZstdOutputStreamNoFinalizer	setStrategy(int strategy) Advanced Compression Option: Set the strategy used by a match finder.
public synchronized ZstdOutputStreamNoFinalizer	setTargetLength(int targetLength) Advanced Compression Option: Set the target match length.
public synchronized ZstdOutputStreamNoFinalizer	setWindowLog(int windowLog) Advanced Compression Option: Set the maximum number of bits for a match distance.
public synchronized ZstdOutputStreamNoFinalizer	setWorkers(int n) Enable use of worker threads for parallel compression.
public synchronized void	write(byte[] the data. src, int the start offset in the data. offset, int the number of bytes to write. len) Overrides java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream.
public void	write(int the `byte`. i) Overrides java.io.FilterOutputStream.write. Writes the specified `byte` to this output stream.

Inherited from java.io.FilterOutputStream:: write

bufferPool	back to summary
private final BufferPool bufferPool

closeFrameOnFlush	back to summary
private boolean closeFrameOnFlush

dst	back to summary
private final byte[] dst

dstByteBuffer	back to summary
private final ByteBuffer dstByteBuffer

dstPos	back to summary
private long dstPos

dstSize	back to summary
private static final int dstSize

frameClosed	back to summary
private boolean frameClosed

frameStarted	back to summary
private boolean frameStarted

isClosed	back to summary
private boolean isClosed

srcPos	back to summary
private long srcPos

stream	back to summary
private final long stream

ZstdOutputStreamNoFinalizer	back to summary
public ZstdOutputStreamNoFinalizer(OutputStream outStream, int level) throws IOException create a new compressing OutputStream Parameters outStream:OutputStream the stream to wrap level:int the compression level

ZstdOutputStreamNoFinalizer	back to summary
public ZstdOutputStreamNoFinalizer(OutputStream outStream) throws IOException create a new compressing OutputStream Parameters outStream:OutputStream the stream to wrap

ZstdOutputStreamNoFinalizer	back to summary
public ZstdOutputStreamNoFinalizer(OutputStream outStream, BufferPool bufferPool, int level) throws IOException create a new compressing OutputStream Parameters outStream:OutputStream the stream to wrap bufferPool:BufferPool the pool to fetch and return buffers

ZstdOutputStreamNoFinalizer	back to summary
public ZstdOutputStreamNoFinalizer(OutputStream outStream, BufferPool bufferPool) throws IOException create a new compressing OutputStream Parameters outStream:OutputStream the stream to wrap bufferPool:BufferPool the pool to fetch and return buffers

Method Detail

close	back to summary
public synchronized void close() throws IOException Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Doc from java.io.FilterOutputStream.close. Closes this output stream and releases any system resources associated with the stream. Exceptions IOException: if an I/O error occurs.

back to summary

public synchronized void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterOutputStream.close.

Closes this output stream and releases any system resources associated with the stream.

Exceptions

IOException:: if an I/O error occurs.

close	back to summary
private void close(boolean closeParentStream) throws IOException

closeWithoutClosingParentStream	back to summary
public synchronized void closeWithoutClosingParentStream() throws IOException

compressStream	back to summary
private native int compressStream(long ctx, byte[] dst, int dst_size, byte[] src, int src_size)

createCStream	back to summary
private static native long createCStream()

endStream	back to summary
private native int endStream(long ctx, byte[] dst, int dst_size)

flush	back to summary
public synchronized void flush() throws IOException Overrides java.io.FilterOutputStream.flush. Implements java.io.Flushable.flush. Flushes the output Exceptions IOException: Doc from java.io.FilterOutputStream.flush. if an I/O error occurs.

flush

back to summary

public synchronized void flush() throws IOException

Overrides java.io.FilterOutputStream.flush.

Implements java.io.Flushable.flush.

Flushes the output

Exceptions

IOException:

Doc from java.io.FilterOutputStream.flush.

if an I/O error occurs.

flushStream	back to summary
private native int flushStream(long ctx, byte[] dst, int dst_size)

freeCStream	back to summary
private static native int freeCStream(long ctx)

recommendedCOutSize	back to summary
public static native long recommendedCOutSize()

resetCStream	back to summary
private native int resetCStream(long ctx)

setChainLog	back to summary
public synchronized ZstdOutputStreamNoFinalizer setChainLog(int chainLog) throws IOException Advanced Compression Option: Set the maximum number of bits for the secondary search structure. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setChecksum	back to summary
public synchronized ZstdOutputStreamNoFinalizer setChecksum(boolean useChecksums) throws IOException Enable checksums for the compressed stream. Default: false

setCloseFrameOnFlush	back to summary
public synchronized ZstdOutputStreamNoFinalizer setCloseFrameOnFlush(boolean closeOnFlush) Enable closing the frame on flush. This will guarantee that it can be ready fully if the process crashes before closing the stream. On the downside it will negatively affect the compression ratio. Default: false.

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

setDict	back to summary
public synchronized ZstdOutputStreamNoFinalizer setDict(ZstdDictCompress dict) throws IOException

setHashLog	back to summary
public synchronized ZstdOutputStreamNoFinalizer setHashLog(int hashLog) throws IOException Advanced Compression Option: Set the maximum number of bits for a hash table. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setJobSize	back to summary
public synchronized ZstdOutputStreamNoFinalizer setJobSize(int jobSize) throws IOException Advanced Compression Option: Set the size of each compression job. Only applies when multi threaded compression is enabled. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setLevel	back to summary
public synchronized ZstdOutputStreamNoFinalizer setLevel(int level) throws IOException Set the compression level. Default: `Zstd#defaultCompressionLevel()`

setLong	back to summary
public synchronized ZstdOutputStreamNoFinalizer setLong(int windowLog) throws IOException Enable Long Distance Matching and set the Window size Log. Values for windowLog outside the range 10-27 will disable and reset LDM

setMinMatch	back to summary
public synchronized ZstdOutputStreamNoFinalizer setMinMatch(int minMatch) throws IOException Advanced Compression Option: Set the minimum match length. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setOverlapLog	back to summary
public synchronized ZstdOutputStreamNoFinalizer setOverlapLog(int overlapLog) throws IOException Advanced Compression Option: Set the amount of data reloaded from the previous job. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setSearchLog	back to summary
public synchronized ZstdOutputStreamNoFinalizer setSearchLog(int searchLog) throws IOException Advanced Compression Option: Set the maximum number of searches in a hash chain or a binary tree using logarithmic scale. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setStrategy	back to summary
public synchronized ZstdOutputStreamNoFinalizer setStrategy(int strategy) throws IOException Advanced Compression Option: Set the strategy used by a match finder. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setTargetLength	back to summary
public synchronized ZstdOutputStreamNoFinalizer setTargetLength(int targetLength) throws IOException Advanced Compression Option: Set the target match length. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setWindowLog	back to summary
public synchronized ZstdOutputStreamNoFinalizer setWindowLog(int windowLog) throws IOException Advanced Compression Option: Set the maximum number of bits for a match distance. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

setWorkers	back to summary
public synchronized ZstdOutputStreamNoFinalizer setWorkers(int n) throws IOException Enable use of worker threads for parallel compression. Default: no worker threads.

write back to summary

write	back to summary
public synchronized void write(byte[] src, int offset, int len) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream. Parameters src:byte[] the data. offset:int the start offset in the data. len:int the number of bytes to write. Exceptions IOException: if an I/O error occurs.

public synchronized void write(byte[] src, int offset, int len) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Parameters

src:byte[]: the data.
offset:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(int i) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes the specified `byte` to this output stream. The `write` method of `FilterOutputStream` calls the `write` method of its underlying output stream, that is, it performs `out.write(b)`. Implements the abstract `write` method of `OutputStream`. Parameters i:int the `byte`. Exceptions IOException: if an I/O error occurs.

public void write(int i) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes the specified byte to this output stream.

The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b).

Implements the abstract write method of OutputStream.

Parameters

i:int: the byte.

Exceptions

IOException:: if an I/O error occurs.

public Class ZstdOutputStreamNoFinalizer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail