Package com.intellij.openapi.roots

Class ProjectRootManager

java.lang.Object

com.intellij.openapi.util.SimpleModificationTracker

com.intellij.openapi.roots.ProjectRootManager

All Implemented Interfaces:

ModificationTracker

Direct Known Subclasses:

ProjectRootManagerEx

public abstract class ProjectRootManager
extends SimpleModificationTracker

Allows to query and modify the list of root files and directories belonging to a project.

Field Summary

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
ProjectRootManager()

Method Summary

Modifier and Type	Method and Description
abstract VirtualFile []	getContentRoots() Returns the list of content roots for all modules in the project.
abstract VirtualFile []	getContentRootsFromAllModules() Unlike getContentRoots(), this includes the project base dir.
abstract java.util.List<java.lang.String>	getContentRootUrls() Returns the list of content root URLs for all modules in the project.
abstract VirtualFile []	getContentSourceRoots() Returns the list of source roots under the content roots for all modules in the project.
abstract ProjectFileIndex	getFileIndex() Returns the file index for the project.
static ProjectRootManager	getInstance(Project project) Returns the project root manager instance for the specified project.
abstract java.util.List<VirtualFile>	getModuleSourceRoots(java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes) Returns the list of source roots from all modules which types belong to the specified set
abstract Sdk	getProjectSdk()
abstract java.lang.String	getProjectSdkName()
abstract java.lang.String	getProjectSdkTypeName()
abstract OrderEnumerator	orderEntries() Creates new enumerator instance to process dependencies of all modules in the project.
abstract OrderEnumerator	orderEntries(java.util.Collection<? extends Module> modules) Creates new enumerator instance to process dependencies of several modules in the project.
abstract void	setProjectSdk(Sdk sdk) Sets the SDK to be used for the project.
abstract void	setProjectSdkName(java.lang.String name) Deprecated. use setProjectSdk(Sdk) or setProjectSdkName(String, String)
abstract void	setProjectSdkName(java.lang.String name, java.lang.String sdkTypeName) Sets the name of the JDK to be used for the project

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

getModificationCount, incModificationCount

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectRootManager

public ProjectRootManager()

Method Detail

getInstance

public static ProjectRootManager getInstance(Project project)

Returns the project root manager instance for the specified project.

Parameters:

project - the project for which the instance is requested.

Returns:

the instance.

getFileIndex

public abstract ProjectFileIndex getFileIndex()

Returns the file index for the project.

Returns:

the file index instance.

orderEntries

public abstract OrderEnumerator orderEntries()

Creates new enumerator instance to process dependencies of all modules in the project. Only first level dependencies of modules are processed so OrderEnumerator.recursively() option is ignored and OrderEnumerator.withoutDepModules() option is forced

Returns:

new enumerator instance

orderEntries

public abstract OrderEnumerator orderEntries(java.util.Collection<? extends Module> modules)

Creates new enumerator instance to process dependencies of several modules in the project. Caching is not supported for this enumerator

Parameters:

modules - modules to process

Returns:

new enumerator instance

getContentRootsFromAllModules

public abstract VirtualFile [] getContentRootsFromAllModules()

Unlike getContentRoots(), this includes the project base dir. Is this really necessary? TODO: remove this method?

getContentRootUrls

public abstract java.util.List<java.lang.String> getContentRootUrls()

Returns the list of content root URLs for all modules in the project.

Returns:

the list of content root URLs.

getContentRoots

public abstract VirtualFile [] getContentRoots()

Returns the list of content roots for all modules in the project.

Returns:

the list of content roots.

getContentSourceRoots

public abstract VirtualFile [] getContentSourceRoots()

Returns the list of source roots under the content roots for all modules in the project.

Returns:

the list of content source roots.

getModuleSourceRoots

public abstract java.util.List<VirtualFile> getModuleSourceRoots(java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes)

Returns the list of source roots from all modules which types belong to the specified set

Parameters:

rootTypes - types of source roots

Returns:

list of source roots

getProjectSdk

public abstract Sdk getProjectSdk()

Returns:

the instance of the JDK selected for the project or null if the name of the selected JDK does not correspond to any existing JDK instance

getProjectSdkName

public abstract java.lang.String getProjectSdkName()

Returns:

the name of the SDK selected for the project

getProjectSdkTypeName

public abstract java.lang.String getProjectSdkTypeName()

Returns:

the SDK type name (@link SdkTypeId.getName() of the current Project SDK

setProjectSdk

public abstract void setProjectSdk(Sdk sdk)

Sets the SDK to be used for the project.

Parameters:

sdk - the SDK instance.

setProjectSdkName

@Deprecated
public abstract void setProjectSdkName(java.lang.String name)

Deprecated. use setProjectSdk(Sdk) or setProjectSdkName(String, String)

setProjectSdkName

public abstract void setProjectSdkName(java.lang.String name,
                                       java.lang.String sdkTypeName)

Sets the name of the JDK to be used for the project

Parameters:

sdkTypeName - the SdkTypeId.getName() of the SDK type