Package com.intellij.openapi.project

Class ProjectLocator

java.lang.Object

com.intellij.openapi.project.ProjectLocator

public abstract class ProjectLocator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ProjectLocator()

Method Summary

Modifier and Type	Method and Description
static ProjectLocator	getInstance()
abstract java.util.Collection<Project>	getProjectsForFile(VirtualFile file) Gets all open projects containing the given file.
abstract Project	guessProjectForFile(VirtualFile file) Returns an open project which contains the given file.
static AccessToken	runWithPreferredProject(VirtualFile file, Project preferredProject)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectLocator

public ProjectLocator()

Method Detail

getInstance

public static ProjectLocator getInstance()

guessProjectForFile

public abstract Project guessProjectForFile(VirtualFile file)

Returns an open project which contains the given file. This is a guess-method, so if several projects contain the file, only one will be returned. Also a project may be returned though it doesn't contain the file for sure (see implementations).

Parameters:

file - file to be located in projects.

Returns:

project which probably contains the file, or null if couldn't guess (for example, there are no open projects).

getProjectsForFile

public abstract java.util.Collection<Project> getProjectsForFile(VirtualFile file)

Gets all open projects containing the given file. If none does, an empty list is returned.

Parameters:

file - file to be located in projects.

Returns:

list of open projects containing this file.

runWithPreferredProject

public static AccessToken runWithPreferredProject(VirtualFile file,
                                                  Project preferredProject)