Package com.github.luben.zstd

Class ZstdOutputStreamNoFinalizer

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.github.luben.zstd.ZstdOutputStreamNoFinalizer

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ZstdOutputStreamNoFinalizer
extends FilterOutputStream

OutputStream filter that compresses the data using Zstd compression.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
ZstdOutputStreamNoFinalizer(OutputStream outStream)	create a new compressing OutputStream
ZstdOutputStreamNoFinalizer(OutputStream outStream, int level)	create a new compressing OutputStream
ZstdOutputStreamNoFinalizer(OutputStream outStream, BufferPool bufferPool)	create a new compressing OutputStream
ZstdOutputStreamNoFinalizer(OutputStream outStream, BufferPool bufferPool, int level)	create a new compressing OutputStream

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeWithoutClosingParentStream()
void	flush()	Flushes the output
static long	recommendedCOutSize()
ZstdOutputStreamNoFinalizer	setChainLog(int chainLog)	Advanced Compression Option: Set the maximum number of bits for the secondary search structure.
ZstdOutputStreamNoFinalizer	setChecksum(boolean useChecksums)	Enable checksums for the compressed stream.
ZstdOutputStreamNoFinalizer	setCloseFrameOnFlush(boolean closeOnFlush)	Enable closing the frame on flush.
ZstdOutputStreamNoFinalizer	setDict(byte[] dict)
ZstdOutputStreamNoFinalizer	setDict(ZstdDictCompress dict)
ZstdOutputStreamNoFinalizer	setHashLog(int hashLog)	Advanced Compression Option: Set the maximum number of bits for a hash table.
ZstdOutputStreamNoFinalizer	setJobSize(int jobSize)	Advanced Compression Option: Set the size of each compression job.
ZstdOutputStreamNoFinalizer	setLevel(int level)	Set the compression level.
ZstdOutputStreamNoFinalizer	setLong(int windowLog)	Enable Long Distance Matching and set the Window size Log.
ZstdOutputStreamNoFinalizer	setMinMatch(int minMatch)	Advanced Compression Option: Set the minimum match length.
ZstdOutputStreamNoFinalizer	setOverlapLog(int overlapLog)	Advanced Compression Option: Set the amount of data reloaded from the previous job.
ZstdOutputStreamNoFinalizer	setSearchLog(int searchLog)	Advanced Compression Option: Set the maximum number of searches in a hash chain or a binary tree using logarithmic scale.
ZstdOutputStreamNoFinalizer	setStrategy(int strategy)	Advanced Compression Option: Set the strategy used by a match finder.
ZstdOutputStreamNoFinalizer	setTargetLength(int targetLength)	Advanced Compression Option: Set the target match length.
ZstdOutputStreamNoFinalizer	setWindowLog(int windowLog)	Advanced Compression Option: Set the maximum number of bits for a match distance.
ZstdOutputStreamNoFinalizer	setWorkers(int n)	Enable use of worker threads for parallel compression.
void	write(byte[] src, int offset, int len)
void	write(int i)

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Details

ZstdOutputStreamNoFinalizer

public ZstdOutputStreamNoFinalizer(OutputStream outStream,
 int level)
                            throws IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

level - the compression level

Throws:

IOException

ZstdOutputStreamNoFinalizer

public ZstdOutputStreamNoFinalizer(OutputStream outStream)
                            throws IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

Throws:

IOException

ZstdOutputStreamNoFinalizer

public ZstdOutputStreamNoFinalizer(OutputStream outStream,
 BufferPool bufferPool,
 int level)
                            throws IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

bufferPool - the pool to fetch and return buffers

Throws:

IOException

ZstdOutputStreamNoFinalizer

public ZstdOutputStreamNoFinalizer(OutputStream outStream,
 BufferPool bufferPool)
                            throws IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

bufferPool - the pool to fetch and return buffers

Throws:

IOException

Method Details

recommendedCOutSize

public static long recommendedCOutSize()

setChecksum

public ZstdOutputStreamNoFinalizer setChecksum(boolean useChecksums)
                                        throws IOException

Enable checksums for the compressed stream. Default: false

Throws:

IOException

setLevel

public ZstdOutputStreamNoFinalizer setLevel(int level)
                                     throws IOException

Set the compression level. Default: Zstd.defaultCompressionLevel()

Throws:

IOException

setLong

public 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

Throws:

IOException

setWorkers

public ZstdOutputStreamNoFinalizer setWorkers(int n)
                                       throws IOException

Enable use of worker threads for parallel compression. Default: no worker threads.

Throws:

IOException

setOverlapLog

public 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.

Throws:

IOException

setJobSize

public 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.

Throws:

IOException

setTargetLength

public 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.

Throws:

IOException

setMinMatch

public 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.

Throws:

IOException

setSearchLog

public 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.

Throws:

IOException

setChainLog

public 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.

Throws:

IOException

setHashLog

public 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.

Throws:

IOException

setWindowLog

public 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.

Throws:

IOException

setStrategy

public 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.

Throws:

IOException

setCloseFrameOnFlush

public 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

public ZstdOutputStreamNoFinalizer setDict(byte[] dict)
                                    throws IOException

Throws:

IOException

setDict

public ZstdOutputStreamNoFinalizer setDict(ZstdDictCompress dict)
                                    throws IOException

Throws:

IOException

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(int i)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes the output

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

closeWithoutClosingParentStream

public void closeWithoutClosingParentStream()
                                     throws IOException

Throws:

IOException