java/debugger/openapi/src/com/intellij/debugger/engine/SourcesFinder.java

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed 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 com.intellij.debugger.engine;

import com.intellij.openapi.project.Project;
import com.intellij.psi.PsiFile;
import org.jetbrains.annotations.Nullable;

/**
 * @author Eugene Zhuravlev
 *         Date: May 23, 2006
 */
public interface SourcesFinder<Scope> {
  /**
   * Searches for source file within the deployedModules
   * @param relPath relative path of the source to be found (fetched from the class file)
   * @param project
   * @param scope a search scope
   */
  @Nullable
  PsiFile findSourceFile(String relPath, Project project, Scope scope);
}