package nom.tam.fits.compression.algorithm.api;

import nom.tam.fits.compression.provider.param.api.ICompressParameters;

/*
 * #%L
 * nom.tam FITS library
 * %%
 * Copyright (C) 1996 - 2015 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%
 */

/**
 * Option for the compression algorithm, implementors are used to control the
 * compression algorithm.
 */
public interface ICompressOption extends Cloneable {

    /**
     * @return copy the option (normally the option from with the copy happened
     *         is saved as original).
     */
    ICompressOption copy();

    /**
     * @return the parameters that must be synchronized with the hdu meta data.
     */
    ICompressParameters getCompressionParameters();

    /**
     * @return true if the compression done with this specified options uses
     *         approximations. That means if the reconstruction of the data is
     *         excact the return should be false.
     */
    boolean isLossyCompression();

    /**
     * set the parameters that must be synchronized with the hdu meta data.
     *
     * @param parameters
     *            the parameters to synchronized
     */
    void setParameters(ICompressParameters parameters);

    /**
     * set the tile height in pixel.
     *
     * @param value
     *            the number of pixel.
     * @return this (builder pattern)
     */
    ICompressOption setTileHeight(int value);

    /**
     * set the tile width.
     *
     * @param value
     *            the number of pixel.
     * @return this (builder pattern)
     */
    ICompressOption setTileWidth(int value);

    /**
     * un wrap a specific implementation detail.
     *
     * @param clazz
     *            the type to unwrap
     * @param <T>
     *            the class to unrwap
     * @return the implementation detail or null if no such detail is avalable.
     */
    <T> T unwrap(Class<T> clazz);
}
