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

Modifier and Type	Field	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	isClosed
private long	srcPos
private final long	stream

Fields inherited from class 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()
private void	close(boolean closeParentStream)
void	closeWithoutClosingParentStream()
private int	compressStream(long ctx, byte[] dst, int dst_size, byte[] src, int src_size)
private static long	createCStream()
private int	endStream(long ctx, byte[] dst, int dst_size)
void	flush()	Flushes the output
private int	flushStream(long ctx, byte[] dst, int dst_size)
private static int	freeCStream(long ctx)
static long	recommendedCOutSize()
private int	resetCStream(long ctx)
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	setLevel(int level)	Set the compression level.
ZstdOutputStreamNoFinalizer	setLong(int windowLog)	Enable Long Distance Matching and set the Window size Log.
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 FilterOutputStream

write

Methods inherited from class OutputStream

nullOutputStream

Methods inherited from class Object

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

Field Details

stream

private final long stream

srcPos

private long srcPos

dstPos

private long dstPos

bufferPool

private final BufferPool bufferPool

dstByteBuffer

private final ByteBuffer dstByteBuffer

dst

private final byte[] dst

isClosed

private boolean isClosed

dstSize

private static final int dstSize

closeFrameOnFlush

private boolean closeFrameOnFlush

frameClosed

private boolean frameClosed

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()

createCStream

private static long createCStream()

freeCStream

private static int freeCStream(long ctx)

resetCStream

private int resetCStream(long ctx)

compressStream

private int compressStream(long ctx,
 byte[] dst,
 int dst_size,
 byte[] src,
 int src_size)

flushStream

private int flushStream(long ctx,
 byte[] dst,
 int dst_size)

endStream

private int endStream(long ctx,
 byte[] dst,
 int dst_size)

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

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

close

private void close(boolean closeParentStream)
            throws IOException

Throws:

IOException