org.maachang.mimdb.core.util.jsnappy

## クラス JSnappy

- java.lang.Object
- - org.maachang.mimdb.core.util.jsnappy.JSnappy

-     public class JSnappy
      extends java.lang.Object

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `JSnappy()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `static int` | `calcMaxCompressLength(int len)` 圧縮バッファサイズの計算
    `static JSnappyBuffer` | `compress(byte[] in)` Equivalent to `compress(in, 0, in.length, null)`.
    `static JSnappyBuffer` | `compress(byte[] in, int offset, int length)` Equivalent to `compress(in, offset, length, null)`.
    `static JSnappyBuffer` | `compress(byte[] in, int offset, int length, JSnappyBuffer out, int shift)` snappy圧縮.
    `static JSnappyBuffer` | `compress(byte[] in, JSnappyBuffer out)` Equivalent to `compress(in, 0, in.length, out)`.
    `static JSnappyBuffer` | `compress(JSnappyBuffer in)` Equivalent to `compress(in.getData(), 0, in.getLength(), null)`.
    `static JSnappyBuffer` | `compress(JSnappyBuffer in, JSnappyBuffer out)` Equivalent to `compress(in.getData(), 0, in.getLength(), out)`.
    `static JSnappyBuffer` | `decompress(byte[] in)` Equivalent to `decompress(in, 0, in.length, null)`.
    `static JSnappyBuffer` | `decompress(byte[] in, int offset, int length)` Equivalent to `decompress(in, offset, length, null)`.
    `static JSnappyBuffer` | `decompress(byte[] in, int offset, int length, JSnappyBuffer out)` snappy解凍.
    `static JSnappyBuffer` | `decompress(byte[] in, JSnappyBuffer out)` Equivalent to `decompress(in, 0, in.length, out)`.
    `static JSnappyBuffer` | `decompress(JSnappyBuffer in)` Equivalent to `decompress(in.getData(), 0, in.getLength(), null)`.
    `static JSnappyBuffer` | `decompress(JSnappyBuffer in, JSnappyBuffer out)` Equivalent to `decompress(in.getData(), 0, in.getLength(), out)`.
    `static int` | `decompressLength(byte[] binary, int off)` 解凍バッファサイズの取得.

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### コンストラクタの詳細

    - #### JSnappy

          public JSnappy()

  - ### メソッドの詳細

    - #### calcMaxCompressLength

          public static final int calcMaxCompressLength(int len)

      圧縮バッファサイズの計算
      パラメータ:
        `len` - 圧縮対象のメモリサイズを設定します.
      戻り値:
        圧縮バッファでの最大サイズが返却されます.

    - #### decompressLength

          public static final int decompressLength(byte[] binary,
                             int off)

      解凍バッファサイズの取得.
      パラメータ:
        `binary` - 対象のバイナリを設定します.
        `off` - 対象のオフセット値を設定します.
      戻り値:
        int 解凍対象のバイナリサイズが返却されます.

    - #### compress

          public static final JSnappyBuffer compress(byte[] in)
                                              throws java.lang.Exception

      Equivalent to `compress(in, 0, in.length, null)`.
      パラメータ:
        `in` - data to be compressed
      戻り値:
        compressed data block
      例外:
        `java.lang.Exception`

    - #### compress

          public static final JSnappyBuffer compress(byte[] in,
                               JSnappyBuffer out)
                                              throws java.lang.Exception

      Equivalent to `compress(in, 0, in.length, out)`.
      パラメータ:
        `in` - data to be compressed
        `out` - JSnappyBuffer for compressed data block
      戻り値:
        reference to `out`
      例外:
        `java.lang.Exception`

    - #### compress

          public static final JSnappyBuffer compress(byte[] in,
                               int offset,
                               int length)
                                              throws java.lang.Exception

      Equivalent to `compress(in, offset, length, null)`.
      パラメータ:
        `in` - data to be compressed
        `offset` - offset in `in`, on which encoding is started``
        `length` - number of bytes read from the input block
      戻り値:
        compressed data block
      例外:
        `java.lang.Exception`

    - #### compress

          public static final JSnappyBuffer compress(JSnappyBuffer in)
                                              throws java.lang.Exception

      Equivalent to `compress(in.getData(), 0, in.getLength(), null)`.
      パラメータ:
        `in` - data to be compressed
      戻り値:
        compressed data block
      例外:
        `java.lang.Exception`

    - #### compress

          public static final JSnappyBuffer compress(JSnappyBuffer in,
                               JSnappyBuffer out)
                                              throws java.lang.Exception

      Equivalent to `compress(in.getData(), 0, in.getLength(), out)`.
      パラメータ:
        `in` - data to be compressed
        `out` - buffer for decompressed data block
      戻り値:
        reference to `out`
      例外:
        `java.lang.Exception`

    - #### decompress

          public static final JSnappyBuffer decompress(byte[] in)
                                                throws java.lang.Exception

      Equivalent to `decompress(in, 0, in.length, null)`.
      パラメータ:
        `in` - compressed data block
      戻り値:
        decompressed data block
      例外:
        `java.lang.Exception`

    - #### decompress

          public static final JSnappyBuffer decompress(byte[] in,
                                 JSnappyBuffer out)
                                                throws java.lang.Exception

      Equivalent to `decompress(in, 0, in.length, out)`.
      パラメータ:
        `in` - compressed data block
        `out` - JSnappyBuffer for decompressed data block
      戻り値:
        reference to `out`
      例外:
        `java.lang.Exception`

    - #### decompress

          public static final JSnappyBuffer decompress(byte[] in,
                                 int offset,
                                 int length)
                                                throws java.lang.Exception

      Equivalent to `decompress(in, offset, length, null)`.
      パラメータ:
        `in` - byte array containing the compressed data block
        `offset` - offset in `in`, on which decoding is started``
        `length` - length of compressed data block
      戻り値:
        decompressed data block
      例外:
        `java.lang.Exception`

    - #### decompress

          public static final JSnappyBuffer decompress(JSnappyBuffer in)
                                                throws java.lang.Exception

      Equivalent to `decompress(in.getData(), 0, in.getLength(), null)`.
      パラメータ:
        `in` - compressed data block
      戻り値:
        decompressed data block
      例外:
        `java.lang.Exception`

    - #### decompress

          public static final JSnappyBuffer decompress(JSnappyBuffer in,
                                 JSnappyBuffer out)
                                                throws java.lang.Exception

      Equivalent to `decompress(in.getData(), 0, in.getLength(), out)`.
      パラメータ:
        `in` - compressed data block
        `out` - JSnappyBuffer for decompressed data block
      戻り値:
        reference to `out`
      例外:
        `java.lang.Exception`

    - #### compress

          public static final JSnappyBuffer compress(byte[] in,
                               int offset,
                               int length,
                               JSnappyBuffer out,
                               int shift)
                                              throws java.lang.Exception

      snappy圧縮.
      パラメータ:
        `in` - 圧縮対象のバイナリを設定します.
        `offset` - 圧縮対象バイナリの開始位置を設定します.
        `length` - 圧縮対象の長さを設定します.
        `out` - 圧縮結果を格納するBufferオブジェクトを設定します. 設定されない場合は、内部で新規作成されます.
        `shift` - 圧縮テーブル長を増やす場合は、この値に整数を設定します.
      戻り値:
        JSnappyBuffer 圧縮されたBufferオブジェクトが返却されます. この情報は第４引数でオブジェクトを渡した場合、 同様オブジェクトが返却されます.
      例外:
        `例外.`
        `java.lang.Exception`

    - #### decompress

          public static final JSnappyBuffer decompress(byte[] in,
                                 int offset,
                                 int length,
                                 JSnappyBuffer out)
                                                throws java.lang.Exception

      snappy解凍.
      パラメータ:
        `in` - 解凍対象のバイナリを設定します.
        `offset` - 解凍対象バイナリの開始位置を設定します.
        `length` - 解凍対象の長さを設定します.
        `out` - 解凍結果を格納するBufferオブジェクトを設定します. 設定されない場合は、内部で新規作成されます.
      戻り値:
        JSnappyBuffer 解凍されたBufferオブジェクトが返却されます. この情報は第４引数でオブジェクトを渡した場合、 同様オブジェクトが返却されます.
      例外:
        `例外.`
        `java.lang.Exception`