Package com.intellij.openapi.project

Class ProjectManager

java.lang.Object

com.intellij.openapi.project.ProjectManager

Direct Known Subclasses:

ProjectManagerEx

public abstract class ProjectManager
extends java.lang.Object

Provides project management.

Field Summary

Fields

Modifier and Type	Field and Description
static Topic<ProjectManagerListener>	TOPIC

Constructor Summary

Constructors

Constructor and Description
ProjectManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addProjectManagerListener(ProjectManagerListener listener) Deprecated. Use TOPIC instead
abstract void	addProjectManagerListener(ProjectManagerListener listener, Disposable parentDisposable) Deprecated. Use TOPIC instead
abstract void	addProjectManagerListener(Project project, ProjectManagerListener listener) Adds listener to the specified project.
abstract void	addProjectManagerListener(VetoableProjectManagerListener listener)
abstract boolean	closeProject(Project project) Closes the specified project, but does not dispose it.
abstract Project	createProject(java.lang.String name, java.lang.String path) Create new project in given location.
abstract Project	getDefaultProject() Returns the project which is used as a template for new projects.
static ProjectManager	getInstance()
static ProjectManager	getInstanceIfCreated()
abstract Project []	getOpenProjects() Returns the list of currently opened projects.
Project	loadAndOpenProject(java.io.File file)
abstract Project	loadAndOpenProject(java.nio.file.Path file)
abstract Project	loadAndOpenProject(java.lang.String filePath) Loads and opens a project with the specified path.
abstract void	reloadProject(Project project) Asynchronously reloads the specified project.
abstract void	removeProjectManagerListener(ProjectManagerListener listener) Deprecated. Use TOPIC instead
abstract void	removeProjectManagerListener(Project project, ProjectManagerListener listener) Removes listener from the specified project.
abstract void	removeProjectManagerListener(VetoableProjectManagerListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

TOPIC

public static final Topic<ProjectManagerListener> TOPIC

Constructor Detail

ProjectManager

public ProjectManager()

Method Detail

getInstance

public static ProjectManager getInstance()

Returns:

ProjectManager instance

getInstanceIfCreated

public static ProjectManager getInstanceIfCreated()

addProjectManagerListener

@Deprecated
public abstract void addProjectManagerListener(ProjectManagerListener listener)

Deprecated. Use TOPIC instead

addProjectManagerListener

public abstract void addProjectManagerListener(VetoableProjectManagerListener listener)

addProjectManagerListener

@Deprecated
public abstract void addProjectManagerListener(ProjectManagerListener listener,
                                               Disposable parentDisposable)

Deprecated. Use TOPIC instead

removeProjectManagerListener

@Deprecated
public abstract void removeProjectManagerListener(ProjectManagerListener listener)

Deprecated. Use TOPIC instead

removeProjectManagerListener

public abstract void removeProjectManagerListener(VetoableProjectManagerListener listener)

addProjectManagerListener

public abstract void addProjectManagerListener(Project project,
                                               ProjectManagerListener listener)

Adds listener to the specified project.

Parameters:

project - project to add listener to

listener - listener to add

removeProjectManagerListener

public abstract void removeProjectManagerListener(Project project,
                                                  ProjectManagerListener listener)

Removes listener from the specified project.

Parameters:

project - project to remove listener from

listener - listener to remove

getOpenProjects

public abstract Project [] getOpenProjects()

Returns the list of currently opened projects. ComponentManager.isDisposed() must be checked for each project before use (if the whole operation is not under read action).

getDefaultProject

public abstract Project getDefaultProject()

Returns the project which is used as a template for new projects. The template project is always available, even when no other project is open. This Project instance is not supposed to be used for anything except template settings storage.

NB: default project can be lazy loaded

Returns:

the template project instance.

loadAndOpenProject

public abstract Project loadAndOpenProject(java.lang.String filePath)
                                    throws java.io.IOException,
                                           JDOMException

Loads and opens a project with the specified path. If the project file is from an older IDEA version, prompts the user to convert it to the latest version. If the project file is from a newer version, shows a message box telling the user that the load failed.

Parameters:

filePath - the .ipr file path

Returns:

the opened project file, or null if the project failed to load because of version mismatch or because the project is already open.

Throws:

java.io.IOException - if the project file was not found or failed to read

JDOMException - if the project file contained invalid XML

loadAndOpenProject

public Project loadAndOpenProject(java.io.File file)
                           throws java.io.IOException,
                                  JDOMException

Throws:

java.io.IOException

JDOMException

loadAndOpenProject

public abstract Project loadAndOpenProject(java.nio.file.Path file)
                                    throws java.io.IOException,
                                           JDOMException

Throws:

java.io.IOException

JDOMException

closeProject

public abstract boolean closeProject(Project project)

Closes the specified project, but does not dispose it.

Parameters:

project - the project to close.

Returns:

true if the project was closed successfully, false if the closing was disallowed by the close listeners.

reloadProject

public abstract void reloadProject(Project project)

Asynchronously reloads the specified project.

Parameters:

project - the project to reload.

createProject

public abstract Project createProject(java.lang.String name,
                                      java.lang.String path)

Create new project in given location.

Parameters:

name - project name

path - project location

Returns:

newly crated project