Application: gvSIG desktop » gvSIG raster

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.raster.lib.buffer.api;

import org.gvsig.tools.lang.Cloneable;

/**

 * @author fdiaz

 *

 */

public interface NoData extends Cloneable, Comparable<NoData>{

    /**

     * Gets the for nodata.

     *

     * @return the noData

     */

    public Number getValue();

    /**

     * Sets the value for NoData.

     *

     * @param value the noData to set

     */

    public void setValue(Number value);

    /**

     * Returns true if getValue is defined and false if is null

     * @return true if getValue is defined and false if is null

     */

    public boolean isDefined();

    /**

     * Clear the nodata value.

     */

    public void clear();

    /**

     * Restores default value. This value

     * has to be assign when NoData object is initialize.

     */

    public void restore();

    /**

     * Gets the default value. This value

     * has to be assign when NoData object is initialize.

     * @return the noData

     */

    public Number getDefaultValue();

    /**

     * Gets the NoData data type

     * @return the data type

     */

    public int getDataType();

    /**

     * Copy from noData parameter

     *

     * @param noData

     */

    public void copyFrom(NoData noData);

}