de.jarnbjo.jsnappy

Class SnappyCompressor

java.lang.Object

de.jarnbjo.jsnappy.SnappyCompressor

public class SnappyCompressor
extends Object

This class provide utility methods for compressing data blocks using the Snappy algorithm.

Since:

1.0

Author:

Tor-Einar Jarnbjo

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EFFORT Default effort used for compression

Method Summary

Methods

Modifier and Type	Method and Description
static Buffer	compress(Buffer in) Equivalent to compress(in.getData(), 0, in.getLength(), null).
static Buffer	compress(Buffer in, Buffer out) Equivalent to compress(in.getData(), 0, in.getLength(), out).
static Buffer	compress(byte[] in) Equivalent to compress(in, 0, in.length, null).
static Buffer	compress(byte[] in, Buffer out) Equivalent to compress(in, 0, in.length, out).
static Buffer	compress(byte[] in, int offset, int length) Equivalent to compress(in, offset, length, null).
static Buffer	compress(byte[] in, int offset, int length, Buffer out) Equivalent to compress(in.getData(), 0, in.getLength(), out, DEFAULT_EFFORT).
static Buffer	compress(byte[] in, int offset, int length, Buffer out, int effort) Compress the data contained in in from offset and length bytes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EFFORT

public static final int DEFAULT_EFFORT

Default effort used for compression

See Also:

Constant Field Values

Method Detail

compress

public static Buffer compress(byte[] in)

Equivalent to compress(in, 0, in.length, null).

Parameters:

in - data to be compressed

Returns:

compressed data block

compress

public static Buffer compress(byte[] in,
              Buffer out)

Equivalent to compress(in, 0, in.length, out).

Parameters:

in - data to be compressed

out - Buffer for compressed data block

Returns:

reference to out

compress

public static Buffer compress(byte[] in,
              int offset,
              int length)

Equivalent to compress(in, offset, length, null).

Parameters:

in - data to be compressed

offset - offset in in, on which encoding is started

length - number of bytes read from the input block

Returns:

compressed data block

compress

public static Buffer compress(Buffer in)

Equivalent to compress(in.getData(), 0, in.getLength(), null).

Parameters:

in - data to be compressed

Returns:

compressed data block

compress

public static Buffer compress(Buffer in,
              Buffer out)

Equivalent to compress(in.getData(), 0, in.getLength(), out).

Parameters:

in - data to be compressed

out - buffer for decompressed data block

Returns:

reference to out

compress

public static Buffer compress(byte[] in,
              int offset,
              int length,
              Buffer out)

Equivalent to compress(in.getData(), 0, in.getLength(), out, DEFAULT_EFFORT).

Parameters:

in - input data

offset - offset into input data

length - length of input data

out - output buffer or null (new buffer will be allocated)

Returns:

reference to out

compress

public static Buffer compress(byte[] in,
              int offset,
              int length,
              Buffer out,
              int effort)

Compress the data contained in in from offset and length bytes. If an output buffer is provided, the buffer is reused for the compressed data. If the buffer is too small, its capacity is expanded to fit the result. If a null argument is passed, a new buffer is allocated.

The compression effort can be set from 1 (fastest, less compression) to 100 (slowest, highest compression).

Parameters:

in - input data

offset - offset into input data

length - length of input data

out - output buffer or null (new buffer will be allocated)

effort - compression effort

Returns: