EclipseProjectCoordinateProvider.java

/**
 * Copyright (c) 2010, 2013 Darmstadt University of Technology.
 * 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:
 *    Marcel Bruch - initial API and implementation.
 */
package org.eclipse.recommenders.examples.models;

import static org.eclipse.recommenders.utils.Throws.throwNotImplemented;

import org.eclipse.recommenders.coordinates.ProjectCoordinate;
import org.eclipse.recommenders.examples.models.CompletionEngineExample.IJavaElement;

import com.google.common.base.Optional;

/**
 * Maps an IDE specific code element to a {@link ProjectCoordinate}.
 * <p>
 * Note that this interface is only a marker interface which will be implemented by each IDE-implementation
 * independently. An Eclipse-based provider may contain methods like:
 * 
 * <pre>
 * Optional<ProjectCoordinate> map(IMethod m);
 * 
 * Optional<ProjectCoordinate> map(IType t);
 * 
 * Optional<ProjectCoordinate> map(IPackgeFragmentRoot p);
 * 
 * Optional<ProjectCoordinate> map(IJavaProject p);
 * </pre>
 * 
 * The API for other IDEs or evaluation frameworks may use other methods names or abstractions.
 */
public class EclipseProjectCoordinateProvider {

    public Optional<ProjectCoordinate> map(IJavaElement jdtElement) {
        // TODO Auto-generated method stub
        throw throwNotImplemented();
    }

}