1 package nom.tam.fits.compression.algorithm.api;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 import java.nio.Buffer;
35 import java.nio.ByteBuffer;
36
37 /**
38 * (<i>for internal use</i>) Compressor that can compress a Buffer into a ByteBuffer and vize versa. the Byte buffer
39 * must have enough space allocated else an exception will be thrown.
40 *
41 * @param <T> The generic type of NIO buffer on which this compressor operates.
42 */
43 public interface ICompressor<T extends Buffer> {
44
45 /**
46 * compress the buffer into the byte buffer. Attention enough space must already be allocated.
47 *
48 * @param buffer the buffer to compress.
49 * @param compressed the compressed data
50 *
51 * @return true if the compression succeeded.
52 */
53 boolean compress(T buffer, ByteBuffer compressed);
54
55 /**
56 * Decompress the byte buffer and restore the buffer from it, again enough space must already be allocated.
57 *
58 * @param compressed the compressed data
59 * @param buffer the buffer to fill with the uncompressed data.
60 */
61 void decompress(ByteBuffer compressed, T buffer);
62
63 }