Package com.intellij.openapi.roots.impl

Class ModuleRootManagerImpl

java.lang.Object

com.intellij.openapi.roots.ModuleRootManager

com.intellij.openapi.roots.ModuleRootManagerEx

com.intellij.openapi.roots.impl.ModuleRootManagerImpl

All Implemented Interfaces:

Disposable, ModuleRootModel, ProjectModelElement

Direct Known Subclasses:

ModuleRootManagerComponent

public class ModuleRootManagerImpl
extends ModuleRootManagerEx
implements Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleRootManagerImpl.ModuleRootManagerState

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG
protected SimpleModificationTracker	myModificationTracker
protected RootModelImpl	myRootModel

Constructor Summary

Constructors

Constructor and Description
ModuleRootManagerImpl(Module module)

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
void	dropCaches()
static OrderRootsEnumerator	getCachingEnumeratorForType(OrderRootType type, Module module)
ContentEntry []	getContentEntries() Use this method to obtain all content entries of a module.
VirtualFile []	getContentRoots() Returns an array of content roots from all content entries.
java.lang.String []	getContentRootUrls() Returns an array of content root urls from all content entries.
Module []	getDependencies() Returns the list of modules on which the current module directly depends.
Module []	getDependencies(boolean includeTests) Returns the list of modules on which the current module directly depends.
java.lang.String []	getDependencyModuleNames() Returns list of module names this module depends on.
VirtualFile []	getExcludeRoots() Returns an array of exclude roots from all content entries.
java.lang.String []	getExcludeRootUrls() Returns an array of exclude root urls from all content entries.
ProjectModelExternalSource	getExternalSource() Return non-null value if this element was automatically created by the IDE during importing from some external project system rather than created by user manually via UI.
ModuleFileIndex	getFileIndex() Returns the file index for the current module.
ModifiableRootModel	getModifiableModel() Returns the interface for modifying the set of roots for this module.
ModifiableRootModel	getModifiableModel(RootConfigurationAccessor accessor)
long	getModificationCountForTests()
Module	getModule() Returns the module to which the model belongs.
Module []	getModuleDependencies()
Module []	getModuleDependencies(boolean includeTests)
<T> T	getModuleExtension(java.lang.Class<T> klass)
OrderEntry []	getOrderEntries() Use this method to obtain order of roots of a module.
RootModelImpl	getRootModel()
Sdk	getSdk() Returns the SDK used by the module.
VirtualFile []	getSourceRoots() Returns an array of source roots from all content entries.
VirtualFile []	getSourceRoots(boolean includingTests) Returns an array of source roots from all content entries.
java.util.List<VirtualFile>	getSourceRoots(JpsModuleSourceRootType<?> rootType) Return a list of source roots of the specified type.
java.util.List<VirtualFile>	getSourceRoots(java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes) Return a list of source roots which types belong to the specified set.
java.lang.String []	getSourceRootUrls() Returns an array of source root urls from all content entries.
java.lang.String []	getSourceRootUrls(boolean includingTests) Returns an array of source root urls from all content entries.
ModuleRootManagerImpl.ModuleRootManagerState	getState()
boolean	isDependsOn(Module module) Checks if the current module directly depends on the specified module.
boolean	isSdkInherited() Returns true if SDK for this module is inherited from a project.
void	loadState(ModuleRootManagerImpl.ModuleRootManagerState object)
protected void	loadState(ModuleRootManagerImpl.ModuleRootManagerState object, boolean throwEvent)
OrderEnumerator	orderEntries() Returns OrderEnumerator instance which can be used to process order entries of the module (with or without dependencies) and collect classes or source roots.
<R> R	processOrder(RootPolicy<R> policy, R initialValue) Passes all order entries in the module to the specified visitor.
void	stateChanged()

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

getInstanceEx

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

getInstance

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

myRootModel

protected RootModelImpl myRootModel

myModificationTracker

protected final SimpleModificationTracker myModificationTracker

Constructor Detail

ModuleRootManagerImpl

public ModuleRootManagerImpl(Module module)

Method Detail

getModule

public Module getModule()

Description copied from interface: ModuleRootModel

Returns the module to which the model belongs.

Specified by:

getModule in interface ModuleRootModel

Returns:

the module instance.

getFileIndex

public ModuleFileIndex getFileIndex()

Description copied from class: ModuleRootManager

Returns the file index for the current module.

Specified by:

getFileIndex in class ModuleRootManager

Returns:

the file index instance.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getModifiableModel

public ModifiableRootModel getModifiableModel()

Description copied from class: ModuleRootManager

Returns the interface for modifying the set of roots for this module. Must be called in a read action. !!!!! WARNING !!!!!: This model MUST be either committed ModifiableRootModel.commit() or disposed ModifiableRootModel.dispose()

Specified by:

getModifiableModel in class ModuleRootManager

Returns:

the modifiable root model.

getModifiableModel

public ModifiableRootModel getModifiableModel(RootConfigurationAccessor accessor)

Specified by:

getModifiableModel in class ModuleRootManagerEx

getModificationCountForTests

public long getModificationCountForTests()

Specified by:

getModificationCountForTests in class ModuleRootManagerEx

getRootModel

public RootModelImpl getRootModel()

getContentEntries

public ContentEntry [] getContentEntries()

Description copied from interface: ModuleRootModel

Use this method to obtain all content entries of a module. Entries are given in lexicographical order of their paths.

Specified by:

getContentEntries in interface ModuleRootModel

Returns:

list of content entries for this module

See Also:

ContentEntry

getOrderEntries

public OrderEntry [] getOrderEntries()

Description copied from interface: ModuleRootModel

Use this method to obtain order of roots of a module. Order of entries is important.

Specified by:

getOrderEntries in interface ModuleRootModel

Returns:

list of order entries for this module

getSdk

public Sdk getSdk()

Description copied from interface: ModuleRootModel

Returns the SDK used by the module.

Specified by:

getSdk in interface ModuleRootModel

Returns:

either module-specific or inherited SDK

See Also:

ModuleRootModel.isSdkInherited()

isSdkInherited

public boolean isSdkInherited()

Description copied from interface: ModuleRootModel

Returns true if SDK for this module is inherited from a project.

Specified by:

isSdkInherited in interface ModuleRootModel

Returns:

true if the SDK is inherited, false otherwise

See Also:

ProjectRootManager.getProjectSdk(), ProjectRootManager.setProjectSdk(Sdk)

getDependencies

public Module [] getDependencies()

Description copied from class: ModuleRootManager

Returns the list of modules on which the current module directly depends. The method does not traverse the entire dependency structure - dependencies of dependency modules are not included in the returned list.

Specified by:

getDependencies in class ModuleRootManager

Returns:

the list of module direct dependencies.

getDependencies

public Module [] getDependencies(boolean includeTests)

Description copied from class: ModuleRootManager

Returns the list of modules on which the current module directly depends. The method does not traverse the entire dependency structure - dependencies of dependency modules are not included in the returned list.

Specified by:

getDependencies in class ModuleRootManager

Parameters:

includeTests - whether test-only dependencies should be included

Returns:

the list of module direct dependencies.

getModuleDependencies

public Module [] getModuleDependencies()

Specified by:

getModuleDependencies in interface ModuleRootModel

getModuleDependencies

public Module [] getModuleDependencies(boolean includeTests)

Specified by:

getModuleDependencies in interface ModuleRootModel

isDependsOn

public boolean isDependsOn(Module module)

Description copied from class: ModuleRootManager

Checks if the current module directly depends on the specified module.

Specified by:

isDependsOn in class ModuleRootManager

Parameters:

module - the module to check.

Returns:

true if module is contained in the list of dependencies for the current module, false otherwise.

getDependencyModuleNames

public java.lang.String [] getDependencyModuleNames()

Description copied from interface: ModuleRootModel

Returns list of module names this module depends on.

Specified by:

getDependencyModuleNames in interface ModuleRootModel

Returns:

the list of module names this module depends on.

getModuleExtension

public <T> T getModuleExtension(java.lang.Class<T> klass)

Specified by:

getModuleExtension in interface ModuleRootModel

processOrder

public <R> R processOrder(RootPolicy<R> policy,
                          R initialValue)

Description copied from interface: ModuleRootModel

Passes all order entries in the module to the specified visitor.

Specified by:

processOrder in interface ModuleRootModel

Parameters:

policy - the visitor to accept.

initialValue - the default value to be returned by the visit process.

Returns:

the value returned by the visitor.

See Also:

OrderEntry.accept(RootPolicy, Object)

orderEntries

public OrderEnumerator orderEntries()

Description copied from interface: ModuleRootModel

Returns OrderEnumerator instance which can be used to process order entries of the module (with or without dependencies) and collect classes or source roots.

Specified by:

orderEntries in interface ModuleRootModel

Returns:

OrderEnumerator instance

getCachingEnumeratorForType

public static OrderRootsEnumerator getCachingEnumeratorForType(OrderRootType type,
                                                               Module module)

getContentRoots

public VirtualFile [] getContentRoots()

Description copied from interface: ModuleRootModel

Returns an array of content roots from all content entries.

Specified by:

getContentRoots in interface ModuleRootModel

Returns:

the array of content roots.

See Also:

ModuleRootModel.getContentEntries()

getContentRootUrls

public java.lang.String [] getContentRootUrls()

Description copied from interface: ModuleRootModel

Returns an array of content root urls from all content entries.

Specified by:

getContentRootUrls in interface ModuleRootModel

Returns:

the array of content root URLs.

See Also:

ModuleRootModel.getContentEntries()

getExcludeRootUrls

public java.lang.String [] getExcludeRootUrls()

Description copied from interface: ModuleRootModel

Returns an array of exclude root urls from all content entries.

Specified by:

getExcludeRootUrls in interface ModuleRootModel

Returns:

the array of excluded root URLs.

See Also:

ModuleRootModel.getContentEntries()

getExcludeRoots

public VirtualFile [] getExcludeRoots()

Description copied from interface: ModuleRootModel

Returns an array of exclude roots from all content entries.

Specified by:

getExcludeRoots in interface ModuleRootModel

Returns:

the array of excluded roots.

See Also:

ModuleRootModel.getContentEntries()

getSourceRootUrls

public java.lang.String [] getSourceRootUrls()

Description copied from interface: ModuleRootModel

Returns an array of source root urls from all content entries.

Specified by:

getSourceRootUrls in interface ModuleRootModel

Returns:

the array of source root URLs.

See Also:

ModuleRootModel.getContentEntries(), ModuleRootModel.getSourceRootUrls(boolean)

getSourceRootUrls

public java.lang.String [] getSourceRootUrls(boolean includingTests)

Description copied from interface: ModuleRootModel

Returns an array of source root urls from all content entries.

Specified by:

getSourceRootUrls in interface ModuleRootModel

Parameters:

includingTests - determines whether test source root urls should be included in the result

Returns:

the array of source root URLs.

See Also:

ModuleRootModel.getContentEntries()

getSourceRoots

public VirtualFile [] getSourceRoots()

Description copied from interface: ModuleRootModel

Returns an array of source roots from all content entries.

Specified by:

getSourceRoots in interface ModuleRootModel

Returns:

the array of source roots.

See Also:

ModuleRootModel.getContentEntries(), ModuleRootModel.getSourceRoots(boolean)

getSourceRoots

public VirtualFile [] getSourceRoots(boolean includingTests)

Description copied from interface: ModuleRootModel

Returns an array of source roots from all content entries.

Specified by:

getSourceRoots in interface ModuleRootModel

Parameters:

includingTests - determines whether test source roots should be included in the result

Returns:

the array of source roots.

See Also:

ModuleRootModel.getContentEntries()

getSourceRoots

public java.util.List<VirtualFile> getSourceRoots(JpsModuleSourceRootType<?> rootType)

Description copied from interface: ModuleRootModel

Return a list of source roots of the specified type.

Specified by:

getSourceRoots in interface ModuleRootModel

Parameters:

rootType - type of source roots

Returns:

list of source roots

getSourceRoots

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

Description copied from interface: ModuleRootModel

Return a list of source roots which types belong to the specified set.

Specified by:

getSourceRoots in interface ModuleRootModel

Parameters:

rootTypes - types of source roots

Returns:

list of source roots

dropCaches

public void dropCaches()

Specified by:

dropCaches in class ModuleRootManagerEx

getState

public ModuleRootManagerImpl.ModuleRootManagerState getState()

loadState

public void loadState(ModuleRootManagerImpl.ModuleRootManagerState object)

loadState

protected void loadState(ModuleRootManagerImpl.ModuleRootManagerState object,
                         boolean throwEvent)

stateChanged

public void stateChanged()

getExternalSource

public ProjectModelExternalSource getExternalSource()

Description copied from interface: ProjectModelElement

Return non-null value if this element was automatically created by the IDE during importing from some external project system rather than created by user manually via UI. Configuration files corresponding to such elements will be stored separately so they won't pollute project directories. Also IDEs will show a warning if user tries to modify settings of such element because these changes may be lost after reimporting from the external model.

Specified by:

getExternalSource in interface ProjectModelElement