Package com.github.luben.zstd

Class ZstdOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.github.luben.zstd.ZstdOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class ZstdOutputStream
extends java.io.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
ZstdOutputStream(@NotNull java.io.OutputStream outStream)	create a new compressing OutputStream
ZstdOutputStream(@NotNull java.io.OutputStream outStream, int level)	create a new compressing OutputStream
ZstdOutputStream(@NotNull java.io.OutputStream outStream, int level, boolean closeFrameOnFlush)	Deprecated. Use ZstdOutputStream() or ZstdOutputStream(level) and set the other params with the setters
ZstdOutputStream(@NotNull java.io.OutputStream outStream, int level, boolean closeFrameOnFlush, boolean useChecksums)	Deprecated. Use ZstdOutputStream() or ZstdOutputStream(level) and set the other params with the setters
ZstdOutputStream(@NotNull java.io.OutputStream outStream, @NotNull BufferPool bufferPool)	create a new compressing OutputStream
ZstdOutputStream(@NotNull java.io.OutputStream outStream, @NotNull BufferPool bufferPool, int level)	create a new compressing OutputStream

Method Summary

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

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

ZstdOutputStream

@Deprecated
public ZstdOutputStream(@NotNull
                        @NotNull java.io.OutputStream outStream,
                        int level,
                        boolean closeFrameOnFlush,
                        boolean useChecksums)
                 throws java.io.IOException

Deprecated.

Use ZstdOutputStream() or ZstdOutputStream(level) and set the other params with the setters

Throws:

java.io.IOException

ZstdOutputStream

@Deprecated
public ZstdOutputStream(@NotNull
                        @NotNull java.io.OutputStream outStream,
                        int level,
                        boolean closeFrameOnFlush)
                 throws java.io.IOException

Deprecated.

Use ZstdOutputStream() or ZstdOutputStream(level) and set the other params with the setters

Throws:

java.io.IOException

ZstdOutputStream

public ZstdOutputStream(@NotNull
                        @NotNull java.io.OutputStream outStream,
                        int level)
                 throws java.io.IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

level - the compression level

Throws:

java.io.IOException

ZstdOutputStream

public ZstdOutputStream(@NotNull
                        @NotNull java.io.OutputStream outStream)
                 throws java.io.IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

Throws:

java.io.IOException

ZstdOutputStream

public ZstdOutputStream(@NotNull
                        @NotNull java.io.OutputStream outStream,
                        @NotNull
                        @NotNull BufferPool bufferPool,
                        int level)
                 throws java.io.IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

bufferPool - the pool to fetch and return buffers

Throws:

java.io.IOException

ZstdOutputStream

public ZstdOutputStream(@NotNull
                        @NotNull java.io.OutputStream outStream,
                        @NotNull
                        @NotNull BufferPool bufferPool)
                 throws java.io.IOException

create a new compressing OutputStream

Parameters:

outStream - the stream to wrap

bufferPool - the pool to fetch and return buffers

Throws:

java.io.IOException

Method Detail

setFinalize

@Deprecated
public void setFinalize(boolean finalize)

Deprecated.

If you don't rely on finalizers, use `ZstdOutputStreamNoFinalizer` instead.

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

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

recommendedCOutSize

public static long recommendedCOutSize()

setChecksum

@NotNull
public @NotNull ZstdOutputStream setChecksum(boolean useChecksums)
                                      throws java.io.IOException

Enable checksums for the compressed stream. Default: false

Throws:

java.io.IOException

setLevel

@NotNull
public @NotNull ZstdOutputStream setLevel(int level)
                                   throws java.io.IOException

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

Throws:

java.io.IOException

setLong

@NotNull
public @NotNull ZstdOutputStream setLong(int windowLog)
                                  throws java.io.IOException

Set the Long Distance Matching. Values for windowLog outside the range 10-27 will disable and reset LDM

Throws:

java.io.IOException

setWorkers

@NotNull
public @NotNull ZstdOutputStream setWorkers(int n)
                                     throws java.io.IOException

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

Throws:

java.io.IOException

setOverlapLog

@NotNull
public @NotNull ZstdOutputStream setOverlapLog(int overlapLog)
                                        throws java.io.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:

java.io.IOException

setJobSize

@NotNull
public @NotNull ZstdOutputStream setJobSize(int jobSize)
                                     throws java.io.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:

java.io.IOException

setTargetLength

@NotNull
public @NotNull ZstdOutputStream setTargetLength(int targetLength)
                                          throws java.io.IOException

Advanced Compression Option: Set the target match length. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

Throws:

java.io.IOException

setMinMatch

@NotNull
public @NotNull ZstdOutputStream setMinMatch(int minMatch)
                                      throws java.io.IOException

Advanced Compression Option: Set the minimum match length. See https://facebook.github.io/zstd/zstd_manual.html#Chapter5 for more information.

Throws:

java.io.IOException

setSearchLog

@NotNull
public @NotNull ZstdOutputStream setSearchLog(int searchLog)
                                       throws java.io.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:

java.io.IOException

setChainLog

@NotNull
public @NotNull ZstdOutputStream setChainLog(int chainLog)
                                      throws java.io.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:

java.io.IOException

setHashLog

@NotNull
public @NotNull ZstdOutputStream setHashLog(int hashLog)
                                     throws java.io.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:

java.io.IOException

setWindowLog

@NotNull
public @NotNull ZstdOutputStream setWindowLog(int windowLog)
                                       throws java.io.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:

java.io.IOException

setStrategy

@NotNull
public @NotNull ZstdOutputStream setStrategy(int strategy)
                                      throws java.io.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:

java.io.IOException

setCloseFrameOnFlush

@NotNull
public @NotNull ZstdOutputStream 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

@NotNull
public @NotNull ZstdOutputStream setDict(byte @NotNull [] dict)
                                  throws java.io.IOException

Throws:

java.io.IOException

setDict

@NotNull
public @NotNull ZstdOutputStream setDict(@NotNull
                                         @NotNull ZstdDictCompress dict)
                                  throws java.io.IOException

Throws:

java.io.IOException

write

public void write(byte @NotNull [] src,
                  int offset,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

write

public void write(int i)
           throws java.io.IOException

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Flushes the output

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.FilterOutputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.FilterOutputStream

Throws:

java.io.IOException