SourceReferenceResolver.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.sling.ide.eclipse.core.launch;

import org.apache.sling.ide.osgi.SourceReference;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.launching.IRuntimeClasspathEntry;

/**
 * The <tt>SourceReferenceResolver</tt> is able to convert a {@link SourceReference} into a
 * {@link IRuntimeClasspathEntry} suitable for using in an Eclipse launch configuration
 */
public interface SourceReferenceResolver {
    
    /**
     * @param reference the reference, must not be null
     * @return the classspath entry, possibly null
     */
    IRuntimeClasspathEntry resolve(SourceReference reference) throws CoreException;
    
}