Package org.apache.cassandra.io.compress

Class DeflateCompressor

java.lang.Object

org.apache.cassandra.io.compress.DeflateCompressor

All Implemented Interfaces:

ICompressor

public class DeflateCompressor
extends Object
implements ICompressor

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cassandra.io.compress.ICompressor

ICompressor.Uses

Field Summary

Fields

Modifier and Type	Field	Description
static final DeflateCompressor	instance

Method Summary

Modifier and Type	Method	Description
void	compress(ByteBuffer input, ByteBuffer output)	Compression for ByteBuffers.
int	compressArray(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset, int maxOutputLength)
void	compressBuffer(ByteBuffer input, ByteBuffer output)
static DeflateCompressor	create(Map<String,String> compressionOptions)
static byte[]	getThreadLocalScratchBuffer()
int	initialCompressedBufferLength(int sourceLen)
BufferType	preferredBufferType()	Returns the preferred (most efficient) buffer type for this compressor.
Set<ICompressor.Uses>	recommendedUses()	Hints to Cassandra which uses this compressor is recommended for.
Set<String>	supportedOptions()
boolean	supports(BufferType bufferType)	Checks if the given buffer would be supported by the compressor.
int	uncompress(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset)
int	uncompress(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset, int maxOutputLength)
void	uncompress(ByteBuffer input, ByteBuffer output)	Decompression for DirectByteBuffers.
void	uncompressBuffer(ByteBuffer input, ByteBuffer output)

Methods inherited from class java.lang.Object

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

Field Details

instance

public static final DeflateCompressor instance

Method Details

getThreadLocalScratchBuffer

public static byte[] getThreadLocalScratchBuffer()

create

public static DeflateCompressor create(Map<String,String> compressionOptions)

supportedOptions

public Set<String> supportedOptions()

Specified by:

supportedOptions in interface ICompressor

initialCompressedBufferLength

public int initialCompressedBufferLength(int sourceLen)

Specified by:

initialCompressedBufferLength in interface ICompressor

compress

public void compress(ByteBuffer input,
 ByteBuffer output)

Description copied from interface: ICompressor

Compression for ByteBuffers. The data between input.position() and input.limit() is compressed and placed into output starting from output.position(). Positions in both buffers are moved to reflect the bytes read and written. Limits are not changed.

Specified by:

compress in interface ICompressor

compressArray

public int compressArray(byte[] input,
 int inputOffset,
 int inputLength,
 byte[] output,
 int outputOffset,
 int maxOutputLength)

compressBuffer

public void compressBuffer(ByteBuffer input,
 ByteBuffer output)

uncompress

public void uncompress(ByteBuffer input,
 ByteBuffer output)
                throws IOException

Description copied from interface: ICompressor

Decompression for DirectByteBuffers. The data between input.position() and input.limit() is uncompressed and placed into output starting from output.position(). Positions in both buffers are moved to reflect the bytes read and written. Limits are not changed.

Specified by:

uncompress in interface ICompressor

Throws:

IOException

uncompressBuffer

public void uncompressBuffer(ByteBuffer input,
 ByteBuffer output)
                      throws IOException

Throws:

IOException

uncompress

public int uncompress(byte[] input,
 int inputOffset,
 int inputLength,
 byte[] output,
 int outputOffset)
               throws IOException

Specified by:

uncompress in interface ICompressor

Throws:

IOException

uncompress

public int uncompress(byte[] input,
 int inputOffset,
 int inputLength,
 byte[] output,
 int outputOffset,
 int maxOutputLength)
               throws IOException

Throws:

IOException

supports

public boolean supports(BufferType bufferType)

Description copied from interface: ICompressor

Checks if the given buffer would be supported by the compressor. If a type is supported, the compressor must be able to use it in combination with all other supported types. Direct and memory-mapped buffers must be supported by all compressors.

Specified by:

supports in interface ICompressor

preferredBufferType

public BufferType preferredBufferType()

Description copied from interface: ICompressor

Returns the preferred (most efficient) buffer type for this compressor.

Specified by:

preferredBufferType in interface ICompressor

recommendedUses

public Set<ICompressor.Uses> recommendedUses()

Description copied from interface: ICompressor

Hints to Cassandra which uses this compressor is recommended for. For example a compression algorithm which gets good compression ratio may trade off too much compression speed to be useful in certain compression heavy use cases such as flushes or mutation hints. Note that Cassandra may ignore these recommendations, it is not a strict contract.

Specified by:

recommendedUses in interface ICompressor