Application: gvSIG desktop

package org.gvsig.raster.lib.legend.api.colortable;

import java.io.File;

import org.gvsig.raster.lib.legend.api.exceptions.ColorTableIOException;

/**

 * Class to read {@link ColorTable} from files and write {@link ColorTable} to

 * files.

 * 

 * @author fdiaz

 *

 */

public interface ColorTableIO {

    /**

     * @return the name of {@link ColorTableIO}

     */

    public String getName();

    /**

     * @return the description of {@link ColorTableIO}

     */

    public String getDescription();

    /**

     * Reads file to create {@link ColorTable} from it.

     * 

     * @param file

     *            {@link ColorTable} file.

     * @return ColorTable {@link ColorTable} created from file.

     * @throws ColorTableIOException 

     */

    public ColorTable read(File file) throws ColorTableIOException;

    /**

     * Reads file to set information to {@link ColorTable} received as

     * parameter.

     * 

     * @param colorTable

     *            {@link ColorTable} to be filled.

     * @param file

     *            File of new {@link ColorTable}.

     * @throws ColorTableIOException 

     */

    public void read(ColorTable colorTable, File file) throws ColorTableIOException;

    /**

     * Writes {@link ColorTable} to file.

     * 

     * @param colorTable

     *            {@link ColorTable} to be written

     * @param file

     *            File of {@link ColorTable}

     * @throws ColorTableIOException 

     */

    public void write(ColorTable colorTable, File file) throws ColorTableIOException;

}