com.datastax.oss.protocol.internal

Interface Compressor<B>

Type Parameters:

B - the binary representation to compress.

All Known Implementing Classes:

NoopCompressor

public interface Compressor<B>

Method Summary

Modifier and Type	Method and Description
String	algorithm() The name of the algorithm used.
B	compress(B uncompressed) Compresses a payload using the "legacy" format of protocol v4- frame bodies.
B	compressWithoutLength(B uncompressed) Compresses a payload using the "modern" format of protocol v5+ segments.
B	decompress(B compressed) Decompresses a payload that was compressed with compress(Object).
B	decompressWithoutLength(B compressed, int uncompressedLength) Decompresses a payload that was compressed with compressWithoutLength(Object).
static <B> Compressor<B>	none()

Method Detail

none

static <B> Compressor<B> none()

algorithm

String algorithm()

The name of the algorithm used.

It's the string that will be used in the STARTUP message. Null or empty means no compression.

compress

B compress(B uncompressed)

Compresses a payload using the "legacy" format of protocol v4- frame bodies.

The resulting payload encodes the uncompressed length, and is therefore self-sufficient for decompression.

decompress

B decompress(B compressed)

Decompresses a payload that was compressed with compress(Object).

compressWithoutLength

B compressWithoutLength(B uncompressed)

Compresses a payload using the "modern" format of protocol v5+ segments.

The resulting payload does not encode the uncompressed length. It must be stored separately, and provided to the decompression method.

decompressWithoutLength

B decompressWithoutLength(B compressed,
                          int uncompressedLength)

Decompresses a payload that was compressed with compressWithoutLength(Object).