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

/*******************************************************************************
 * Copyright (c) 2017 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:
 *     Antonio Garcia-Dominguez - Initial Implementation of Hawk Server Configuration
 ******************************************************************************/
package org.eclipse.hawk.core;

import java.io.File;

/**
 * Interface for a component which imports files on demand from a predefined
 * {@link IVcsManager} into a predefined temporary location. Meant to be a
 * heavily restricted version of the {@link IVcsManager} interface for use by
 * various classes that need to fetch extra files on demand.
 */
public interface IFileImporter {

	/**
	 * Imports a file from the VCS to a temporary local directory, and returns
	 * that temporary copy. This temporary directory will be the same one where
	 * the changed files for that VCS are imported.
	 *
	 * @return Files where the contents of that path can be read from, or
	 *         <code>null</code. if that path does not exist or could not be
	 *         read.
	 */
	File importFile(String path);
}