IModelElementWrapperFactory.java

/*******************************************************************************
 * Copyright (c) 2008-2011 Chair for Applied Software Engineering,
 * Technische Universitaet Muenchen.
 * 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:
 ******************************************************************************/
package org.eclipse.emf.emfstore.client.model.util;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;

/**
 * Wraps the given {@link EObject}. <br>
 * For example implementations of this interface can be used to wrap imported modelElements before adding them to the
 * project.
 */
public interface IModelElementWrapperFactory {

	/**
	 * Returns true, if this handler should be used to wrap the toWrap for the given container.<br>
	 * The container can be <code>null</code>, if the toWrap should not be wrapped for any container.
	 * 
	 * @param container the container for which the toWrap should be wrapped or <code>null</code>.
	 * @param toWrap the {@link EObject} which should be wrapped.
	 * @return true if the object can be wrapped
	 */
	boolean isFor(EObject container, EObject toWrap);

	/**
	 * Wraps the given {@link EObject}.
	 * 
	 * @param toWrap the {@link EObject} which should be wrapped.
	 * @return the wrapper of the toWrap.
	 */
	EObject wrap(EObject toWrap);

	/**
	 * Wraps the given {@link EObject}.
	 * 
	 * @param toWrap the {@link EObject} which should be wrapped.
	 * @param uri the {@link URI} of the resource to import.
	 * @param resourceIndex - the index of the element inside the eResource.
	 * @return the wrapper of the toWrap.
	 */
	EObject wrapForImport(EObject toWrap, URI uri, int resourceIndex);
}