Package com.intellij.openapi.roots.impl

Class ProjectRootManagerImpl

java.lang.Object

com.intellij.openapi.util.SimpleModificationTracker

com.intellij.openapi.roots.ProjectRootManager

com.intellij.openapi.roots.ex.ProjectRootManagerEx

com.intellij.openapi.roots.impl.ProjectRootManagerImpl

All Implemented Interfaces:

PersistentStateComponent<Element>, ModificationTracker

Direct Known Subclasses:

ProjectRootManagerComponent

public class ProjectRootManagerImpl
extends ProjectRootManagerEx
implements PersistentStateComponent<Element>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ProjectRootManagerImpl.BatchSession

Nested classes/interfaces inherited from class com.intellij.openapi.roots.ex.ProjectRootManagerEx

ProjectRootManagerEx.ProjectJdkListener

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isFiringEvent
protected ProjectRootManagerImpl.BatchSession	myFileTypesChanged
protected Project	myProject
protected ProjectRootManagerImpl.BatchSession	myRootsChanged
protected boolean	myStartupActivityPerformed

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

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
ProjectRootManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	addProjectJdkListener(ProjectRootManagerEx.ProjectJdkListener listener)
void	assertListenersAreDisposed()
protected void	clearScopesCaches()
void	clearScopesCachesForModules()
static java.lang.String	extractLocalPath(java.lang.String url)
protected void	fireBeforeRootsChangeEvent(boolean fileTypes)
protected void	fireRootsChangedEvent(boolean fileTypes)
protected java.lang.Runnable	getActionToRunWhenProjectJdkChanges()
protected ProjectRootManagerImpl.BatchSession	getBatchSession(boolean fileTypes)
VirtualFile []	getContentRoots() Returns the list of content roots for all modules in the project.
VirtualFile []	getContentRootsFromAllModules() Unlike getContentRoots(), this includes the project base dir.
java.util.List<java.lang.String>	getContentRootUrls() Returns the list of content root URLs for all modules in the project.
VirtualFile []	getContentSourceRoots() Returns the list of source roots under the content roots for all modules in the project.
ProjectFileIndex	getFileIndex() Returns the file index for the project.
static ProjectRootManagerImpl	getInstanceImpl(Project project)
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
Project	getProject()
Sdk	getProjectSdk()
java.lang.String	getProjectSdkName()
java.lang.String	getProjectSdkTypeName()
VirtualFilePointerListener	getRootsValidityChangedListener()
Element	getState()
void	loadState(Element element) This method is called when new component state is loaded.
void	makeRootsChange(java.lang.Runnable runnable, boolean fileTypes, boolean fireEvents)
void	markRootsForRefresh()
void	mergeRootsChangesDuring(java.lang.Runnable runnable)
void	noStateLoaded() This method is called when the component is initialized, but no state is persisted.
OrderEnumerator	orderEntries() Creates new enumerator instance to process dependencies of all modules in the project.
OrderEnumerator	orderEntries(java.util.Collection<? extends Module> modules) Creates new enumerator instance to process dependencies of several modules in the project.
protected void	projectJdkChanged()
void	removeProjectJdkListener(ProjectRootManagerEx.ProjectJdkListener listener)
void	setProjectSdk(Sdk sdk) Sets the SDK to be used for the project.
void	setProjectSdkName(java.lang.String name) Deprecated.
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.roots.ex.ProjectRootManagerEx

getInstanceEx

Methods inherited from class com.intellij.openapi.roots.ProjectRootManager

getInstance

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

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

initializeComponent

Field Detail

myProject

protected final Project myProject

myStartupActivityPerformed

protected boolean myStartupActivityPerformed

myRootsChanged

protected final ProjectRootManagerImpl.BatchSession myRootsChanged

myFileTypesChanged

protected final ProjectRootManagerImpl.BatchSession myFileTypesChanged

isFiringEvent

protected boolean isFiringEvent

Constructor Detail

ProjectRootManagerImpl

public ProjectRootManagerImpl(Project project)

Method Detail

getInstanceImpl

public static ProjectRootManagerImpl getInstanceImpl(Project project)

getFileIndex

public ProjectFileIndex getFileIndex()

Description copied from class: ProjectRootManager

Returns the file index for the project.

Specified by:

getFileIndex in class ProjectRootManager

Returns:

the file index instance.

getContentRootUrls

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

Description copied from class: ProjectRootManager

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

Specified by:

getContentRootUrls in class ProjectRootManager

Returns:

the list of content root URLs.

getContentRoots

public VirtualFile [] getContentRoots()

Description copied from class: ProjectRootManager

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

Specified by:

getContentRoots in class ProjectRootManager

Returns:

the list of content roots.

getContentSourceRoots

public VirtualFile [] getContentSourceRoots()

Description copied from class: ProjectRootManager

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

Specified by:

getContentSourceRoots in class ProjectRootManager

Returns:

the list of content source roots.

getModuleSourceRoots

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

Description copied from class: ProjectRootManager

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

Specified by:

getModuleSourceRoots in class ProjectRootManager

Parameters:

rootTypes - types of source roots

Returns:

list of source roots

orderEntries

public OrderEnumerator orderEntries()

Description copied from class: ProjectRootManager

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

Specified by:

orderEntries in class ProjectRootManager

Returns:

new enumerator instance

orderEntries

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

Description copied from class: ProjectRootManager

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

Specified by:

orderEntries in class ProjectRootManager

Parameters:

modules - modules to process

Returns:

new enumerator instance

getContentRootsFromAllModules

public VirtualFile [] getContentRootsFromAllModules()

Description copied from class: ProjectRootManager

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

Specified by:

getContentRootsFromAllModules in class ProjectRootManager

getProjectSdk

public Sdk getProjectSdk()

Specified by:

getProjectSdk in class ProjectRootManager

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 java.lang.String getProjectSdkName()

Specified by:

getProjectSdkName in class ProjectRootManager

Returns:

the name of the SDK selected for the project

getProjectSdkTypeName

public java.lang.String getProjectSdkTypeName()

Specified by:

getProjectSdkTypeName in class ProjectRootManager

Returns:

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

setProjectSdk

public void setProjectSdk(Sdk sdk)

Description copied from class: ProjectRootManager

Sets the SDK to be used for the project.

Specified by:

setProjectSdk in class ProjectRootManager

Parameters:

sdk - the SDK instance.

projectJdkChanged

protected void projectJdkChanged()

getActionToRunWhenProjectJdkChanges

protected java.lang.Runnable getActionToRunWhenProjectJdkChanges()

setProjectSdkName

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

Deprecated.

Specified by:

setProjectSdkName in class ProjectRootManager

setProjectSdkName

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

Description copied from class: ProjectRootManager

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

Specified by:

setProjectSdkName in class ProjectRootManager

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

addProjectJdkListener

public void addProjectJdkListener(ProjectRootManagerEx.ProjectJdkListener listener)

Specified by:

addProjectJdkListener in class ProjectRootManagerEx

removeProjectJdkListener

public void removeProjectJdkListener(ProjectRootManagerEx.ProjectJdkListener listener)

Specified by:

removeProjectJdkListener in class ProjectRootManagerEx

loadState

public void loadState(Element element)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

element - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

noStateLoaded

public void noStateLoaded()

Description copied from interface: PersistentStateComponent

This method is called when the component is initialized, but no state is persisted.

Specified by:

noStateLoaded in interface PersistentStateComponent<Element>

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

mergeRootsChangesDuring

public void mergeRootsChangesDuring(java.lang.Runnable runnable)

Specified by:

mergeRootsChangesDuring in class ProjectRootManagerEx

clearScopesCaches

protected void clearScopesCaches()

clearScopesCachesForModules

public void clearScopesCachesForModules()

Specified by:

clearScopesCachesForModules in class ProjectRootManagerEx

makeRootsChange

public void makeRootsChange(java.lang.Runnable runnable,
                            boolean fileTypes,
                            boolean fireEvents)

Specified by:

makeRootsChange in class ProjectRootManagerEx

getBatchSession

protected ProjectRootManagerImpl.BatchSession getBatchSession(boolean fileTypes)

fireBeforeRootsChangeEvent

protected void fireBeforeRootsChangeEvent(boolean fileTypes)

fireRootsChangedEvent

protected void fireRootsChangedEvent(boolean fileTypes)

getProject

public Project getProject()

extractLocalPath

public static java.lang.String extractLocalPath(java.lang.String url)

assertListenersAreDisposed

public void assertListenersAreDisposed()

Overrides:

assertListenersAreDisposed in class ProjectRootManagerEx

markRootsForRefresh

public void markRootsForRefresh()

Specified by:

markRootsForRefresh in class ProjectRootManagerEx

getRootsValidityChangedListener

public VirtualFilePointerListener getRootsValidityChangedListener()