nom.tam.fits.compression.provider.api.ICompressorProvider Maven / Gradle / Ivy
package nom.tam.fits.compression.provider.api;
import nom.tam.fits.compression.algorithm.api.ICompressorControl;
/*
* #%L
* nom.tam FITS library
* %%
* Copyright (C) 1996 - 2024 nom-tam-fits
* %%
* This is free and unencumbered software released into the public domain.
*
* Anyone is free to copy, modify, publish, use, compile, sell, or
* distribute this software, either in source code form or as a compiled
* binary, for any purpose, commercial or non-commercial, and by any
* means.
*
* In jurisdictions that recognize copyright laws, the author or authors
* of this software dedicate any and all copyright interest in the
* software to the public domain. We make this dedication for the benefit
* of the public at large and to the detriment of our heirs and
* successors. We intend this dedication to be an overt act of
* relinquishment in perpetuity of all present and future rights to this
* software under copyright law.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
* #L%
*/
/**
* (for internal use) Service loader Interface to provide compression algorithms to fits.
*/
public interface ICompressorProvider {
/**
* @return the {@code ICompressorControl} to use for the specified quantize and compression
* algorithms and base type.
*
* @param quantAlgorithm the quantification algorithm to use or null if none
* @param compressionAlgorithm the compression algorithm to use
* @param baseType the base type of the data to (de)compress.
*/
ICompressorControl createCompressorControl(String quantAlgorithm, String compressionAlgorithm, Class baseType);
}