1 package nom.tam.fits.compression.provider.api;
2
3 import nom.tam.fits.compression.algorithm.api.ICompressorControl;
4
5 /*
6 * #%L
7 * nom.tam FITS library
8 * %%
9 * Copyright (C) 1996 - 2024 nom-tam-fits
10 * %%
11 * This is free and unencumbered software released into the public domain.
12 *
13 * Anyone is free to copy, modify, publish, use, compile, sell, or
14 * distribute this software, either in source code form or as a compiled
15 * binary, for any purpose, commercial or non-commercial, and by any
16 * means.
17 *
18 * In jurisdictions that recognize copyright laws, the author or authors
19 * of this software dedicate any and all copyright interest in the
20 * software to the public domain. We make this dedication for the benefit
21 * of the public at large and to the detriment of our heirs and
22 * successors. We intend this dedication to be an overt act of
23 * relinquishment in perpetuity of all present and future rights to this
24 * software under copyright law.
25 *
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
29 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32 * OTHER DEALINGS IN THE SOFTWARE.
33 * #L%
34 */
35
36 /**
37 * (<i>for internal use</i>) Service loader Interface to provide compression algorithms to fits.
38 */
39 public interface ICompressorProvider {
40
41 /**
42 * @return the {@code ICompressorControl} to use for the specified quantize and compression
43 * algorithms and base type.
44 *
45 * @param quantAlgorithm the quantification algorithm to use or null if none
46 * @param compressionAlgorithm the compression algorithm to use
47 * @param baseType the base type of the data to (de)compress.
48 */
49 ICompressorControl createCompressorControl(String quantAlgorithm, String compressionAlgorithm, Class<?> baseType);
50
51 }