/* FeatureIDE - An IDE to support feature-oriented software development
 * Copyright (C) 2005-2009  FeatureIDE Team, University of Magdeburg
 *
 * 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, see http://www.gnu.org/licenses/.
 *
 * See http://www.fosd.de/featureide/ for further information.
 */
package featureide.fm.core.io;

import java.io.File;
import java.io.FileNotFoundException;
import java.util.List;

import org.eclipse.core.resources.IFile;

import featureide.fm.core.FeatureModel;

/**
 * Parses a feature model from a given file or string.
 * 
 * @author Thomas Thuem
 */
public interface IFeatureModelReader {
	
	/**
	 * Returns the feature model where the read data is stored.
	 * 
	 * @return the model to fill
	 */
	public FeatureModel getFeatureModel();
	
	/**
	 * Sets the feature model where the read data is stored.
	 * 
	 * @param featureModel the model to fill
	 */
	public void setFeatureModel(FeatureModel featureModel);

	/**
	 * Parses a specific feature model file.
	 * 
	 * @param  file  the feature model file
	 * @throws UnsupportedModelException
	 * @throws FileNotFoundException
	 */
	public void readFromFile(IFile file)
			throws UnsupportedModelException, FileNotFoundException;
	/**
	 * Parses a specific feature model file.
	 * 
	 * @param  file  the feature model file
	 * @throws UnsupportedModelException
	 * @throws FileNotFoundException
	 */
	public void readFromFile(File file)
			throws UnsupportedModelException, FileNotFoundException;

	/**
	 * Parses a textual representation of a feature model.
	 * 
	 * @param text
	 * @throws UnsupportedModelException
	 */
	public void readFromString(String text)
			throws UnsupportedModelException;

	/**
	 * Returns warnings occurred while last parsing.
	 * 
	 * @return
	 */
	public List<ModelWarning> getWarnings();

}