/*******************************************************************************
 * Copyright (c) 2015 Obeo.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Obeo - initial API and implementation and/or initial documentation
 *    ...
 *******************************************************************************/
package org.eclipse.intent.mapping.ide.connector;

import org.eclipse.core.resources.IFile;
import org.eclipse.intent.mapping.base.ILocationContainer;
import org.eclipse.intent.mapping.content.IFileType;
import org.eclipse.intent.mapping.ide.resource.IFileLocation;

/**
 * {@link org.eclipse.core.resources.IFile IFile} connector delegate used by {@link ResourceConnector}.
 *
 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
 */
public interface IFileConnectorDelegate {

	/**
	 * Gets the handled {@link IFileType}.
	 * 
	 * @return the handled {@link IFileType}
	 */
	IFileType getFileType();

	/**
	 * Gets the {@link IFileLocation} type.
	 * 
	 * @return the {@link IFileLocation} type
	 */
	Class<? extends IFileLocation> getFileLocationType();

	/**
	 * Initializes the given {@link IFileLocation} with the given {@link IFile}.
	 * 
	 * @param container
	 *            the {@link ILocationContainer}
	 * @param location
	 *            the {@link IFileLocation}
	 * @param element
	 *            the {@link IFile}
	 */
	void initLocation(ILocationContainer container, IFileLocation location, IFile element);

	/**
	 * Updates the given {@link IFileLocation} with the given {@link IFile}.
	 * 
	 * @param location
	 *            the {@link IFileLocation}
	 * @param element
	 *            the {@link IFile}
	 */
	void update(IFileLocation location, IFile element);

	/**
	 * Gets the {@link Object element} located by the given {@link IFileLocation}.
	 * 
	 * @param location
	 *            the {@link IFileLocation}
	 * @return the {@link Object element} located by the given {@link IFileLocation} if the given
	 *         {@link IFileLocation} if handled by this {@link IFileConnectorDelegate}, <code>null</code>
	 *         otherwise
	 */
	Object getElement(IFileLocation location);

}