nom.tam.fits.compression.algorithm.api

Interface ICompressor<T extends Buffer>

All Known Implementing Classes:

GZip2Compressor, GZip2Compressor.ByteGZip2Compress, GZip2Compressor.IntGZip2Compressor, GZip2Compressor.LongGZip2Compressor, GZip2Compressor.ShortGZip2Compressor, GZipCompressor, GZipCompressor.ByteGZipCompressor, GZipCompressor.DoubleGZipCompressor, GZipCompressor.FloatGZipCompressor, GZipCompressor.IntGZipCompressor, GZipCompressor.LongGZipCompressor, GZipCompressor.ShortGZipCompressor, HCompressor, HCompressor.ByteHCompressor, HCompressor.DoubleHCompressor, HCompressor.FloatHCompressor, HCompressor.IntHCompressor, HCompressor.ShortHCompressor, PLIOCompress.BytePLIOCompressor, PLIOCompress.IntPLIOCompressor, PLIOCompress.ShortPLIOCompressor, QuantizeProcessor.DoubleQuantCompressor, QuantizeProcessor.FloatQuantCompressor, RiceCompressor, RiceCompressor.ByteRiceCompressor, RiceCompressor.DoubleRiceCompressor, RiceCompressor.FloatRiceCompressor, RiceCompressor.IntRiceCompressor, RiceCompressor.ShortRiceCompressor

public interface ICompressor<T extends Buffer>

Compressor that can compress a Buffer into a ByteBuffer and vize versa. the Byte buffer must have enough space allocated else an exception will be thrown.

Method Summary

Modifier and Type	Method and Description
boolean	compress(T buffer, ByteBuffer compressed) compress the buffer into the byte buffer.
void	decompress(ByteBuffer compressed, T buffer) Decompress the byte buffer and restore the buffer from it, again enough space must already be allocated.

Method Detail

compress

boolean compress(T buffer,
                 ByteBuffer compressed)

compress the buffer into the byte buffer. Attention enough space must already be allocated.

Parameters:

buffer - the buffer to compress.

compressed - the compressed data

Returns:

true if the compression succeeded.

decompress

void decompress(ByteBuffer compressed,
                T buffer)

Decompress the byte buffer and restore the buffer from it, again enough space must already be allocated.

Parameters:

compressed - the compressed data

buffer - the buffer to fill with the uncompressed data.