Package com.intellij.openapi.project.impl

Class ProjectImpl

java.lang.Object

ComponentManagerImpl

com.intellij.openapi.project.impl.ProjectImpl

All Implemented Interfaces:

ComponentManager, Disposable, AreaInstance, ProjectEx, Project, UserDataHolder

public class ProjectImpl
extends ComponentManagerImpl
implements ProjectEx

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.project.ex.ProjectEx

ProjectEx.ProjectSaved

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Long>	CREATION_TIME
static Key<java.lang.String>	CREATION_TRACE
static java.lang.String	LIGHT_PROJECT_NAME

Fields inherited from interface com.intellij.openapi.project.ex.ProjectEx

NAME_FILE

Fields inherited from interface com.intellij.openapi.project.Project

DIRECTORY_STORE_FOLDER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProjectImpl(java.nio.file.Path filePath, java.lang.String projectName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	activityNamePrefix()
void	dispose() Usually not invoked directly, see class javadoc.
void	disposeEarlyDisposable()
VirtualFile	getBaseDir() Returns a project base directory - a parent directory of a .ipr file or .idea directory. Returns null for default project.
@SystemIndependent java.lang.String	getBasePath() Returns a path to a project base directory (see Project.getBaseDir()). Returns null for default project.
IComponentStore	getComponentStore()
protected ContainerDescriptor	getContainerDescriptor(IdeaPluginDescriptorImpl pluginDescriptor)
java.lang.String	getCreationTrace()
Disposable	getEarlyDisposable() Disposable that will be disposed right after container started to be disposed.
java.lang.String	getLocationHash()
java.lang.String	getName() Returns a name ot the project.
@SystemDependent java.lang.String	getPresentableUrl() Returns presentable project path: Project.getProjectFilePath() for file-based projects, Project.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()
IProjectStore	getStateStore()
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.
void	init(ProgressIndicator indicator)
boolean	isDefault()
boolean	isDisposed()
boolean	isInitialized()
boolean	isLight()
boolean	isOpen()
void	save()
protected void	setProgressDuringInit(ProgressIndicator indicator)
void	setProjectName(java.lang.String projectName)
void	setProjectStoreFactory(ProjectStoreFactory projectStoreFactory) This method is temporary introduced to allow overriding project store class for a specific project.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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, isDisposedOrDisposeInProgress, logError

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

getUserData, putUserData

Field Detail

CREATION_TIME

public static final Key<java.lang.Long> CREATION_TIME

CREATION_TRACE

public static final Key<java.lang.String> CREATION_TRACE

LIGHT_PROJECT_NAME

public static final java.lang.String LIGHT_PROJECT_NAME

See Also:

Constant Field Values

Constructor Detail

ProjectImpl

protected ProjectImpl(java.nio.file.Path filePath,
                      java.lang.String projectName)

Method Detail

isDisposed

public final boolean isDisposed()

Specified by:

isDisposed in interface ComponentManager

Returns:

true when this component is disposed (e.g. the "File|Close Project" invoked or the application is exited) or is about to be disposed (e.g. the dispose() was called but not completed yet)
The result is only valid inside read action because the application/project/module can be disposed at any moment. (see more details on read actions)

isLight

public boolean isLight()

Specified by:

isLight in interface ProjectEx

setProjectStoreFactory

public void setProjectStoreFactory(ProjectStoreFactory projectStoreFactory)

This method is temporary introduced to allow overriding project store class for a specific project. Overriding ProjectStoreFactory service won't work because a service may be overridden in a single plugin only.

setProjectName

public void setProjectName(java.lang.String projectName)

Specified by:

setProjectName in interface ProjectEx

getStateStore

public final IProjectStore getStateStore()

getComponentStore

public IComponentStore getComponentStore()

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Project

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface Project

getContainerDescriptor

protected ContainerDescriptor getContainerDescriptor(IdeaPluginDescriptorImpl pluginDescriptor)

getProjectFilePath

public @SystemIndependent java.lang.String getProjectFilePath()

Specified by:

getProjectFilePath in interface Project

Returns:

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

getProjectFile

public VirtualFile getProjectFile()

Description copied from interface: Project

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.

Specified by:

getProjectFile in interface Project

Returns:

project descriptor file, or null for default project

getBaseDir

public VirtualFile getBaseDir()

Description copied from interface: Project

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

Specified by:

getBaseDir in interface Project

See Also:

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

getBasePath

public @SystemIndependent java.lang.String getBasePath()

Description copied from interface: Project

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

Specified by:

getBasePath in interface Project

See Also:

com.intellij.openapi.project.ProjectUtil#guessProjectDir

getName

public java.lang.String getName()

Description copied from interface: Project

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.

Specified by:

getName in interface Project

Returns:

project name

getPresentableUrl

public @SystemDependent java.lang.String getPresentableUrl()

Description copied from interface: Project

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

Specified by:

getPresentableUrl in interface Project

getLocationHash

public java.lang.String getLocationHash()

Specified by:

getLocationHash in interface Project

getWorkspaceFile

public VirtualFile getWorkspaceFile()

Description copied from interface: Project

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.

Specified by:

getWorkspaceFile in interface Project

Returns:

workspace file, or null for default project

init

public void init(ProgressIndicator indicator)

setProgressDuringInit

protected void setProgressDuringInit(ProgressIndicator indicator)

save

public void save()

Specified by:

save in interface Project

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isDefault

public boolean isDefault()

Specified by:

isDefault in interface Project

toString

public java.lang.String toString()

getCreationTrace

public java.lang.String getCreationTrace()

activityNamePrefix

public java.lang.String activityNamePrefix()

getEarlyDisposable

public final Disposable getEarlyDisposable()

Description copied from interface: ProjectEx

Disposable that will be disposed right after container started to be disposed. Use it to dispose something that need to be disposed very early, e.g. Alarm. Or, only and only in unit test mode, if you need to publish something to message bus during dispose.

In unit test mode light project is not disposed, but this disposable is disposed for each test. So, you don't need to have another disposable and can use this one instead.

Dependent Disposable.dispose() may be called in any thread. Implementation of Disposable.dispose() must be self-contained and isolated (getting services is forbidden, publishing to message bus is allowed only in tests).

Specified by:

getEarlyDisposable in interface ProjectEx

disposeEarlyDisposable

public final void disposeEarlyDisposable()