net.openhft.chronicle.bytes.util

Interface Compression

All Known Implementing Classes:

Compressions

public interface Compression

Interface for providing compression and decompression functionality to various types of input data.

Method Summary

Modifier and Type	Method and Description
default boolean	available() Indicates whether compression/decompression is available.
default byte[]	compress(byte[] bytes) Compresses a byte array using the streams returned by compressingStream(OutputStream).
default void	compress(@NotNull BytesIn<?> from, @NotNull BytesOut<?> to) Compresses data from from to to using this implementation's algorithm.
static void	compress(@NotNull CharSequence cs, @NotNull Bytes<?> uncompressed, @NotNull Bytes<?> compressed) Compresses uncompressed into compressed using the named algorithm.
OutputStream	compressingStream(OutputStream output) Returns a new OutputStream that compresses any bytes written to it using this algorithm's strategy.
InputStream	decompressingStream(InputStream input) Returns a new InputStream that wraps input and will decompress bytes as they are read.
default byte[]	uncompress(byte[] bytes) Uncompresses a byte array using the stream returned by decompressingStream(InputStream).
default void	uncompress(@NotNull BytesIn<?> from, @NotNull BytesOut<?> to) Uncompresses data from the input to the output using the implementing uncompression algorithm.
static void	uncompress(@NotNull CharSequence cs, @NotNull BytesIn<?> from, @NotNull BytesOut<?> to) Decompresses data using the named algorithm.
static <T> byte[]	uncompress(@NotNull CharSequence cs, T t, @NotNull net.openhft.chronicle.core.util.ThrowingFunction<T,byte[],net.openhft.chronicle.core.io.IORuntimeException> bytes) Uncompresses data using the specified algorithm and a custom function to read bytes.

Method Detail

compress

static void compress(@NotNull
                     @NotNull CharSequence cs,
                     @NotNull
                     @NotNull Bytes<?> uncompressed,
                     @NotNull
                     @NotNull Bytes<?> compressed)
              throws IllegalStateException,
                     BufferOverflowException

Compresses uncompressed into compressed using the named algorithm. Unrecognised names cause a fall back to Compressions.Binary which performs no compression. Supported aliases are "lzw" and "gzip".

Parameters:

cs - the algorithm name, must not be null

uncompressed - the input data to compress

compressed - the destination buffer for compressed data

Throws:

BufferOverflowException - If there is not enough space in the output buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

uncompress

static void uncompress(@NotNull
                       @NotNull CharSequence cs,
                       @NotNull
                       @NotNull BytesIn<?> from,
                       @NotNull
                       @NotNull BytesOut<?> to)
                throws net.openhft.chronicle.core.io.IORuntimeException,
                       IllegalArgumentException,
                       IllegalStateException,
                       BufferOverflowException

Decompresses data using the named algorithm. Alias "!binary" behaves the same as "binary". Any other unrecognised name results in an IllegalArgumentException.

Parameters:

cs - the algorithm name, must not be null

from - the input compressed data

to - the destination for decompressed bytes

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs.

IllegalArgumentException - If the algorithm is unsupported.

BufferOverflowException - If there is not enough space in the output buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

uncompress

static <T> byte[] uncompress(@NotNull
                             @NotNull CharSequence cs,
                             T t,
                             @NotNull
                             @NotNull net.openhft.chronicle.core.util.ThrowingFunction<T,byte[],net.openhft.chronicle.core.io.IORuntimeException> bytes)
                      throws net.openhft.chronicle.core.io.IORuntimeException

Uncompresses data using the specified algorithm and a custom function to read bytes.

Parameters:

cs - The compression algorithm to be used (e.g. "lzw", "gzip").

t - The input data.

bytes - A function to read bytes from the input data.

Returns:

The uncompressed data as byte array.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs.

compress

default byte[] compress(byte[] bytes)

Compresses a byte array using the streams returned by compressingStream(OutputStream).

Parameters:

bytes - the input bytes to compress

Returns:

the compressed data

Throws:

AssertionError - if an unexpected IOException occurs

compress

default void compress(@NotNull
                      @NotNull BytesIn<?> from,
                      @NotNull
                      @NotNull BytesOut<?> to)
               throws IllegalStateException,
                      BufferOverflowException

Compresses data from from to to using this implementation's algorithm. The stream wrappers originate from compressingStream(OutputStream). Unexpected I/O issues are wrapped in an AssertionError as the streams are memory based.

Parameters:

from - The input data to be compressed.

to - The output to write the compressed data.

Throws:

BufferOverflowException - If there is not enough space in the output buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

uncompress

default byte[] uncompress(byte[] bytes)
                   throws net.openhft.chronicle.core.io.IORuntimeException

Uncompresses a byte array using the stream returned by decompressingStream(InputStream).

Parameters:

bytes - the compressed data

Returns:

the resulting uncompressed bytes

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs while reading the data

uncompress

default void uncompress(@NotNull
                        @NotNull BytesIn<?> from,
                        @NotNull
                        @NotNull BytesOut<?> to)
                 throws net.openhft.chronicle.core.io.IORuntimeException,
                        IllegalStateException,
                        BufferOverflowException

Uncompresses data from the input to the output using the implementing uncompression algorithm.

Parameters:

from - The input compressed data.

to - The output to write the uncompressed data.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs.

BufferOverflowException - If there is not enough space in the output buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

decompressingStream

InputStream decompressingStream(InputStream input)
                         throws net.openhft.chronicle.core.io.IORuntimeException

Returns a new InputStream that wraps input and will decompress bytes as they are read. The caller is responsible for closing the returned stream. Closing the wrapper does not close the underlying input stream. Future implementations may buffer the input and callers should not depend on the concrete type of the returned stream.

Parameters:

input - the underlying stream supplying compressed data

Returns:

a stream producing uncompressed bytes

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs

compressingStream

OutputStream compressingStream(OutputStream output)

Returns a new OutputStream that compresses any bytes written to it using this algorithm's strategy. The caller must close the returned stream to flush all data. Closing it does not close output. The returned stream may be wrapped in additional buffering and its exact class is not guaranteed.

Parameters:

output - the underlying stream to receive compressed data

Returns:

a stream accepting uncompressed bytes

available

default boolean available()

Indicates whether compression/decompression is available.

Returns:

true if available, false otherwise.