Package com.intellij.openapi.project

Interface Project

All Superinterfaces:

AreaInstance, ComponentManager, Disposable, UserDataHolder

All Known Subinterfaces:

ProjectEx

All Known Implementing Classes:

DummyProject, MockProject, ProjectImpl

public interface Project
extends ComponentManager, AreaInstance

An object representing an IntelliJ project.

To get all of its modules, use ModuleManager.getInstance(project).getModules().

To iterate over all project source files and directories, use ProjectFileIndex.SERVICE.getInstance(project).iterateContent(iterator).

To get the list of all open projects, use ProjectManager.getInstance().getOpenProjects().

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DIRECTORY_STORE_FOLDER

Method Summary

Modifier and Type	Method and Description
VirtualFile	getBaseDir() Deprecated. No such concept as "project root". Project consists of module set, each has own content root set.
@SystemIndependent java.lang.String	getBasePath() Returns a path to a project base directory (see getBaseDir()). Returns null for default project.
java.lang.String	getLocationHash()
java.lang.String	getName() Returns a name ot the project.
default @SystemDependent java.lang.String	getPresentableUrl() Returns presentable project path: getProjectFilePath() for file-based projects, getBasePath() for directory-based ones. Returns null for default project.
VirtualFile	getProjectFile() Returns project descriptor file: path/to/project/project.ipr - for file-based projects path/to/project/.idea/misc.xml - for directory-based projects Returns null for default project.
@SystemIndependent java.lang.String	getProjectFilePath()
VirtualFile	getWorkspaceFile() Returns a workspace file: path/to/project/project.iws - for file-based projects path/to/project/.idea/workspace.xml - for directory-based ones Returns null for default project.
boolean	isDefault()
boolean	isInitialized()
boolean	isOpen()
void	save()

Methods inherited from interface com.intellij.openapi.components.ComponentManager

createError, createError, getComponent, getComponent, getComponent, getComponentInstancesOfType, getComponentInstancesOfType, getComponents, getDisposed, getExtensionArea, getExtensions, getMessageBus, getPicoContainer, getService, getService, getServiceIfCreated, hasComponent, instantiateClass, instantiateClassWithConstructorInjection, instantiateExtensionWithPicoContainerOnlyIfNeeded, isDisposed, isDisposedOrDisposeInProgress, logError

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Field Detail

DIRECTORY_STORE_FOLDER

static final java.lang.String DIRECTORY_STORE_FOLDER

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns a name ot the project. For a directory-based project it's an arbitrary string specified by user at project creation or later in a project settings. For a file-based project it's a name of a project file without extension.

Returns:

project name

getBaseDir

@Deprecated
VirtualFile getBaseDir()

Deprecated. No such concept as "project root". Project consists of module set, each has own content root set.

Returns a project base directory - a parent directory of a .ipr file or .idea directory.
Returns null for default project.

See Also:

com.intellij.openapi.project.ProjectUtil#guessProjectDir, getBasePath()

getBasePath

@SystemIndependent java.lang.String getBasePath()

Returns a path to a project base directory (see getBaseDir()).
Returns null for default project.

See Also:

com.intellij.openapi.project.ProjectUtil#guessProjectDir

getProjectFile

VirtualFile getProjectFile()

Returns project descriptor file:

• path/to/project/project.ipr - for file-based projects
• path/to/project/.idea/misc.xml - for directory-based projects

Returns null for default project.

Returns:

project descriptor file, or null for default project

getProjectFilePath

@SystemIndependent java.lang.String getProjectFilePath()

Returns:

a path to project file (see getProjectFile()) or null for default project.

getPresentableUrl

default @SystemDependent java.lang.String getPresentableUrl()

Returns presentable project path: getProjectFilePath() for file-based projects, getBasePath() for directory-based ones.
Returns null for default project. Note: the word "presentable" here implies file system presentation, not a UI one.

getWorkspaceFile

VirtualFile getWorkspaceFile()

Returns a workspace file:

• path/to/project/project.iws - for file-based projects
• path/to/project/.idea/workspace.xml - for directory-based ones

Returns null for default project.

Returns:

workspace file, or null for default project

getLocationHash

java.lang.String getLocationHash()

save

void save()

isOpen

boolean isOpen()

isInitialized

boolean isInitialized()

isDefault

boolean isDefault()