Package nom.tam.fits.compression.algorithm.api

Interface ICompressorControl

All Known Implementing Classes:

CompressorProvider.TileCompressorControl

public interface ICompressorControl

(for internal use) The interface to a provided compression algorithm.

Method Summary

Modifier and Type	Method	Description
boolean	compress(Buffer in, ByteBuffer out, ICompressOption option)	Compress the buffer into the byte buffer using the specified options.
void	decompress(ByteBuffer in, Buffer out, ICompressOption option)	decompress the byte buffer back into the buffer using the specified options.
ICompressOption	option()

Method Details

compress

boolean compress(Buffer in,
 ByteBuffer out,
 ICompressOption option)

Compress the buffer into the byte buffer using the specified options.

Parameters:

in - the buffer to compress.

out - the compressed data to fill (must already be allocated with enough space)

option - the options to use for the compression

Returns:

true if the compression succeded.

decompress

void decompress(ByteBuffer in,
 Buffer out,
 ICompressOption option)

decompress the byte buffer back into the buffer using the specified options.

Parameters:

in - the bytes to decompress.

out - the buffer to fill with the decompressed data (must already be allocated with enough space)

option - the options to use for decompressing.

option

ICompressOption option()

Returns:

a option instance that can be used to control the compression meganism.