Method Detail

• newFactory

  public static Supplier<ZstdCompressor> newFactory()

  Creates a new Zstd compressor factory. Please note that if you use the default constructor, the default BLOCK_SIZE and MAX_BLOCK_SIZE will be used. If you want to specify BLOCK_SIZE and MAX_BLOCK_SIZE yourself, please use the newFactory(int,int) method.

  Returns:

  the factory.

• newFactory

  public static Supplier<ZstdCompressor> newFactory​(int compressionLevel)

  Creates a new Zstd compressor factory.

  Parameters:

  compressionLevel - specifies the level of the compression

  Returns:

  the factory.

• newFactory

  public static Supplier<ZstdCompressor> newFactory​(int blockSize,
                                                    int maxEncodeSize)

  Creates a new Zstd compressor factory.

  Parameters:

  blockSize - is used to calculate the compressionLevel

  maxEncodeSize - specifies the size of the largest compressed object

  Returns:

  the factory.

• newFactory

  public static Supplier<ZstdCompressor> newFactory​(int compressionLevel,
                                                    int blockSize,
                                                    int maxEncodeSize)

  Parameters:

  blockSize - is used to calculate the compressionLevel

  maxEncodeSize - specifies the size of the largest compressed object

  compressionLevel - specifies the level of the compression

  Returns:

  the factory.

• compress

  public Buffer compress​(Buffer in,
                         BufferAllocator allocator)
                  throws CompressionException

  Description copied from interface: Compressor
  This method will read from the input Buffer and compress into a new Buffer that will be allocated (if needed) from the BufferAllocator. This method is expected to consume all data from the input but not take ownership. The caller is responsible to release the input buffer after this method returns.

  Specified by:

  compress in interface Compressor

  Parameters:

  in - the Buffer that contains the data to be compressed.

  allocator - the BufferAllocator that is used to allocate a new buffer (if needed) to write the compressed bytes too.

  Returns:

  the Buffer that contains the compressed data. The caller of this method takes ownership of the buffer. The return value will never be null.

  Throws:

  CompressionException - thrown if an compression error was encountered or the compressor was closed already.

• finish

  public Buffer finish​(BufferAllocator allocator)

  Description copied from interface: Compressor
  By calling this method we signal that the compression stream is marked as finish. The returned Buffer might contain a "trailer" which marks the end of the stream.

  Specified by:

  finish in interface Compressor

  Returns:

  the Buffer which represent the end of the compression stream, which might be empty if the compressor don't need a trailer to signal the end. The caller of this method takes ownership of the buffer. The return value will never be null.

• isFinished

  public boolean isFinished()

  Description copied from interface: Compressor
  Returns true if the compressor was finished or closed. This might happen because someone explicit called Compressor.finish(BufferAllocator) / Compressor.close() or the compressor implementation did decide to close itself due a compression error which can't be recovered. After Compressor.isFinished() returns true the Compressor.compress(Buffer, BufferAllocator) method will just return an empty buffer without consuming anything from its input buffer.

  Specified by:

  isFinished in interface Compressor

  Returns:

  true if the compressor was marked as finished, false otherwise.

• isClosed

  public boolean isClosed()

  Description copied from interface: Compressor
  Return true if the decompressor was closed, false otherwise.

  Specified by:

  isClosed in interface Compressor

  Returns:

  true if the decompressor was closed, false otherwise.

• close

  public void close()

  Description copied from interface: Compressor
  # Close the compressor. After this method was called Compressor.isFinished() will return true as well and it is not allowed to call Compressor.compress(Buffer, BufferAllocator) or Compressor.finish(BufferAllocator) anymore -

  Specified by:

  close in interface AutoCloseable

  Specified by:

  close in interface Compressor