Module org.cojen.tupl
Package org.cojen.tupl.io

Interface PageCompressor

All Superinterfaces:
AutoCloseable, Closeable
public interface PageCompressor extends Closeable
Compresses and decompresses pages. Instances aren't expected to be thread-safe.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    int
    compress(byte[] src, int srcOff, int srcLen)
    Compress to a byte array.
    int
    compress(long srcPtr, int srcOff, int srcLen)
    Compress to a byte array from a raw memory pointer.
    byte[]
    compressedBytes()
    Target of the compress method.
    void
    decompress(byte[] src, int srcOff, int srcLen, byte[] dst, int dstOff, int dstLen)
    Decompress to a byte array.
    void
    decompress(byte[] src, int srcOff, int srcLen, long dstPtr, int dstOff, int dstLen)
    Decompress to a raw memory pointer.
    static PageCompressor
    lz4()
    Returns a new LZ4 compressor.
    static PageCompressor
    zlib()
    Returns a new ZLIB compressor (deflate).
    static PageCompressor
    zlib(int level)
    Returns a new ZLIB compressor (deflate).

  • Method Details

    • zlib

      static PageCompressor zlib()
      Returns a new ZLIB compressor (deflate).

    • zlib

      static PageCompressor zlib(int level)
      Returns a new ZLIB compressor (deflate).
      Parameters:
      level - compression level [0..9]

    • lz4

      static PageCompressor lz4()
      Returns a new LZ4 compressor.

    • compress

      int compress(byte[] src, int srcOff, int srcLen) throws IOException
      Compress to a byte array.
      Returns:
      the compressed size
      Throws:
      IOException

    • compress

      int compress(long srcPtr, int srcOff, int srcLen) throws IOException
      Compress to a byte array from a raw memory pointer.
      Returns:
      the compressed size
      Throws:
      IOException

    • compressedBytes

      byte[] compressedBytes()
      Target of the compress method. The array is recycled, although it can be replaced.

    • decompress

      void decompress(byte[] src, int srcOff, int srcLen, byte[] dst, int dstOff, int dstLen) throws IOException
      Decompress to a byte array.
      Parameters:
      dstLen - original size of uncompressed page
      Throws:
      IOException

    • decompress

      void decompress(byte[] src, int srcOff, int srcLen, long dstPtr, int dstOff, int dstLen) throws IOException
      Decompress to a raw memory pointer.
      Parameters:
      dstLen - original size of uncompressed page
      Throws:
      IOException

    • close

      void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable