Package com.intellij.openapi.command.impl

Class DummyProject

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.command.impl.DummyProject

All Implemented Interfaces:

ComponentManager, Disposable, AreaInstance, Project, UserDataHolder, UserDataHolderEx

public final class DummyProject
extends UserDataHolderBase
implements Project

Nested Class Summary

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

Disposable.Parent

Field Summary

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

DIRECTORY_STORE_FOLDER

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
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.
<T> T	getComponent(java.lang.Class<T> interfaceClass) Gets the component by its interface class.
Condition<?>	getDisposed()
ExtensionsArea	getExtensionArea()
static Project	getInstance()
java.lang.String	getLocationHash()
MessageBus	getMessageBus()
java.lang.String	getName() Returns a name ot the project.
DefaultPicoContainer	getPicoContainer()
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()
<T> T	getService(java.lang.Class<T> serviceClass)
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	isDisposed()
boolean	isInitialized()
boolean	isOpen()
void	save()

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

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

getPresentableUrl

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

createError, createError, getComponent, getComponent, getComponentInstancesOfType, getComponentInstancesOfType, getComponents, getExtensions, getService, getServiceIfCreated, hasComponent, instantiateClass, instantiateClassWithConstructorInjection, instantiateExtensionWithPicoContainerOnlyIfNeeded, isDisposedOrDisposeInProgress, logError

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

getUserData, putUserData

Method Detail

getInstance

public static Project getInstance()

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

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

getLocationHash

public java.lang.String getLocationHash()

Specified by:

getLocationHash in interface Project

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.

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

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

save

public void save()

Specified by:

save in interface Project

getService

public <T> T getService(java.lang.Class<T> serviceClass)

Specified by:

getService in interface ComponentManager

getComponent

public <T> T getComponent(java.lang.Class<T> interfaceClass)

Description copied from interface: ComponentManager

Gets the component by its interface class.

Specified by:

getComponent in interface ComponentManager

Parameters:

interfaceClass - the interface class of the component

Returns:

component that matches interface class or null if there is no such component

getPicoContainer

public DefaultPicoContainer getPicoContainer()

Specified by:

getPicoContainer in interface ComponentManager

getExtensionArea

public ExtensionsArea getExtensionArea()

Specified by:

getExtensionArea in interface ComponentManager

Specified by:

getExtensionArea in interface AreaInstance

isDisposed

public 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 ProjectImpl.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)

getDisposed

public Condition<?> getDisposed()

Specified by:

getDisposed in interface ComponentManager

Returns:

condition for this component being disposed. see Application.invokeLater(Runnable, Condition) for the usage example.

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Project

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface Project

isDefault

public boolean isDefault()

Specified by:

isDefault in interface Project

getMessageBus

public MessageBus getMessageBus()

Specified by:

getMessageBus in interface ComponentManager

See Also:

com.intellij.application.Topics#subscribe

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable