MaskPersistence.java

/*
 * Copyright 2010, 2011 Institut Pasteur.
 * 
 * This file is part of NHerve Main Toolbox, which is an ICY plugin.
 * 
 * NHerve Main Toolbox 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 3 of the License, or
 * (at your option) any later version.
 * 
 * NHerve Main Toolbox 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 NHerve Main Toolbox. If not, see <http://www.gnu.org/licenses/>.
 */
package plugins.nherve.toolbox.image.mask;

import java.io.File;

import plugins.nherve.toolbox.PersistenceException;

/**
 * The Interface MaskPersistence.
 * 
 * @author Nicolas HERVE - nicolas.herve@pasteur.fr
 */
public interface MaskPersistence {
	
	/**
	 * Load mask stack.
	 * 
	 * @param f
	 *            the f
	 * @return the mask stack
	 * @throws PersistenceException
	 *             the persistence exception
	 */
	MaskStack loadMaskStack(File f) throws PersistenceException;
	
	/**
	 * Save.
	 * 
	 * @param stack
	 *            the stack
	 * @param f
	 *            the f
	 * @throws PersistenceException
	 *             the persistence exception
	 */
	void save(MaskStack stack, File f) throws PersistenceException;
	
	/**
	 * Gets the mask file extension.
	 * 
	 * @return the mask file extension
	 */
	String getMaskFileExtension();
	
	File getMaskFileFor(File image);
}