Package com.intellij.openapi.roots

Class ModuleRootManager

java.lang.Object

com.intellij.openapi.roots.ModuleRootManager

All Implemented Interfaces:

ModuleRootModel, ProjectModelElement

Direct Known Subclasses:

ModuleRootManagerEx

public abstract class ModuleRootManager
extends java.lang.Object
implements ModuleRootModel, ProjectModelElement

Interface for getting information about the contents and dependencies of a module.

See Also:

CompilerModuleExtension

Constructor Summary

Constructors

Constructor and Description
ModuleRootManager()

Method Summary

Modifier and Type	Method and Description
abstract Module []	getDependencies() Returns the list of modules on which the current module directly depends.
abstract Module []	getDependencies(boolean includeTests) Returns the list of modules on which the current module directly depends.
abstract ModuleFileIndex	getFileIndex() Returns the file index for the current module.
static ModuleRootManager	getInstance(Module module) Returns the module root manager instance for the specified module.
abstract ModifiableRootModel	getModifiableModel() Returns the interface for modifying the set of roots for this module.
abstract boolean	isDependsOn(Module module) Checks if the current module directly depends on the specified module.

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.roots.ModuleRootModel

getContentEntries, getContentRoots, getContentRootUrls, getDependencyModuleNames, getExcludeRoots, getExcludeRootUrls, getModule, getModuleDependencies, getModuleDependencies, getModuleExtension, getOrderEntries, getSdk, getSourceRoots, getSourceRoots, getSourceRoots, getSourceRoots, getSourceRootUrls, getSourceRootUrls, isSdkInherited, orderEntries, processOrder

Methods inherited from interface com.intellij.openapi.roots.ProjectModelElement

getExternalSource

Constructor Detail

ModuleRootManager

public ModuleRootManager()

Method Detail

getInstance

public static ModuleRootManager getInstance(Module module)

Returns the module root manager instance for the specified module.

Parameters:

module - the module for which the root manager is requested.

Returns:

the root manager instance.

getFileIndex

public abstract ModuleFileIndex getFileIndex()

Returns the file index for the current module.

Returns:

the file index instance.

getModifiableModel

public abstract ModifiableRootModel getModifiableModel()

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()

Returns:

the modifiable root model.

getDependencies

public abstract Module [] getDependencies()

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.

Returns:

the list of module direct dependencies.

getDependencies

public abstract Module [] getDependencies(boolean includeTests)

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.

Parameters:

includeTests - whether test-only dependencies should be included

Returns:

the list of module direct dependencies.

isDependsOn

public abstract boolean isDependsOn(Module module)

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

Parameters:

module - the module to check.

Returns:

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