core/plugins/org.eclipse.hawk.core/src/org/eclipse/hawk/core/IModelResourceFactory.java

/*******************************************************************************
 * Copyright (c) 2011-2019 The University of York, Aston University.
 * 
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License, v. 2.0 are satisfied: GNU General Public License, version 3.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-3.0
 *
 * Contributors:
 *     Konstantinos Barmpis - initial API and implementation
 *     Antonio Garcia-Dominguez - add IFileImporter to parse, IHawkPlugin
 ******************************************************************************/
package org.eclipse.hawk.core;

import java.io.File;
import java.util.Collection;

import org.eclipse.hawk.core.model.IHawkModelResource;

/**
 * Interface for a factory of {@link IHawkModelResource} instances from files.
 *
 * @author Kostas Barmpis, Antonio Garcia-Dominguez
 */
public interface IModelResourceFactory extends IHawkPlugin {

	/**
	 * Parses a single model file.
	 *
	 * @param importer
	 *            Importer used to save the changed file from the
	 *            {@link IVcsManager}. This is normally only needed if parsing
	 *            the model file requires additional metadata in other files
	 *            that might not have changed (e.g. Modelio and the
	 *            <code>mmversion.dat</code> file).
	 * @param changedFile
	 *            Model file that underwent changes.
	 */
	IHawkModelResource parse(IFileImporter importer, File changedFile) throws Exception;

	/**
	 * Releases all resources associated to this factory.
	 */
	void shutdown();

	/**
	 * Quickly checks if this file can be parsed by this factory.
	 *
	 * @return <code>true</code> if it can, <code>false</code> otherwise.
	 */
	boolean canParse(File f);

	/**
	 * Reports which file extensions can be parsed by this factory.
	 *
	 * @return A collection of strings (e.g. ".xmi", ".model") with the
	 *         supported extensions, including the extension separator.
	 */
	Collection<String> getModelExtensions();

	@Override
	default Category getCategory() {
		return Category.MODEL_RESOURCE_FACTORY;
	}

}