gov.nasa.worldwind.data.DataRasterWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of worldwind-pcm Show documentation

worldwind-pcm

The newest version!

/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */
package gov.nasa.worldwind.data;

/**
 * DataRasterWriter is a common interface for objects
 * which can write a data raster in a particular file format.
 *
 * @author dcollins
 * @version $Id: DataRasterWriter.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public interface DataRasterWriter
{
    /**
     * Checks if a data raster could be written to a File  the given format.
     *
     * @param raster a data raster to be written to a File in the given format.
     * @param formatSuffix a String containing the format suffix
     * @param file a File to be written to
     * @return TRUE, if a data raster could be written to the File
     *
     */
    boolean canWrite(DataRaster raster, String formatSuffix, java.io.File file);

    /**
     * Writes an data raster to a File in the given format.
     * If there is already a File present, its contents are discarded.
     *
     * @param raster a data raster to be written
     * @param formatSuffix a String containing the format suffix
     * @param file a File to be written to
     * @throws java.io.IOException if any parameter is null or invalid
     */
    void write(DataRaster raster, String formatSuffix, java.io.File file) throws java.io.IOException;
}