ModuleManagerImpl (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.SimpleModificationTracker
- - com.intellij.openapi.module.ModuleManager
  - - com.intellij.openapi.module.impl.ModuleManagerEx
    - - com.intellij.openapi.module.impl.ModuleManagerImpl

All Implemented Interfaces:

BaseComponent, NamedComponent, PersistentStateComponent<Element>, ProjectComponent, Disposable, ModificationTracker

Direct Known Subclasses:

CoreModuleManager, ModuleManagerComponent
```
public abstract class ModuleManagerImpl
extends ModuleManagerEx
implements Disposable, PersistentStateComponent<Element>, ProjectComponent
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable
  Disposable.Parent

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE_FILEPATH`
`static java.lang.String`	`ATTRIBUTE_FILEURL`
`static java.lang.String`	`ATTRIBUTE_GROUP`
`static java.lang.String`	`COMPONENT_NAME`
`static java.lang.String`	`ELEMENT_MODULE`
`static java.lang.String`	`ELEMENT_MODULES`
`static java.lang.String`	`IML_EXTENSION`
`static java.lang.String`	`MODULE_GROUP_SEPARATOR`
`protected MessageBus`	`myMessageBus`
`protected com.intellij.openapi.module.impl.ModuleManagerImpl.ModuleModelImpl`	`myModuleModel`
`protected Project`	`myProject`

Fields inherited from interface com.intellij.openapi.util.ModificationTracker
EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors
Constructor and Description

ModuleManagerImpl(Project project)

Constructors
Constructor and Description
`ModuleManagerImpl(Project project)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areModulesLoaded()`
`protected void`	`cleanCachedStuff()`
`static void`	`commitModelWithRunnable(ModifiableModuleModel model, java.lang.Runnable runnable)`
`protected abstract ModuleEx`	`createAndLoadModule(java.lang.String filePath)`
`protected abstract ModuleEx`	`createModule(java.lang.String filePath)`
`protected ModuleEx`	`createNonPersistentModule(java.lang.String name)`
`protected void`	`deliverPendingEvents()`
`void`	`dispose()` Usually not invoked directly, see class javadoc.
`void`	`disposeModule(Module module)` Disposes of the specified module and removes it from the project.
`Module`	`findModuleByName(java.lang.String name)` Returns the project module with the specified name.
`protected void`	`fireBeforeModuleRemoved(Module module)`
`protected void`	`fireModuleAdded(Module module)`
`protected void`	`fireModuleAddedInWriteAction(ModuleEx module)`
`protected void`	`fireModuleLoadErrors(java.util.List<? extends ModuleLoadingErrorDescription> errors)`
`protected void`	`fireModuleRemoved(Module module)`
`void`	`fireModuleRenamedByVfsEvent(Module module, java.lang.String oldName)`
`protected void`	`fireModulesAdded()`
`protected void`	`fireModulesRenamed(java.util.List<Module> modules, java.util.Map<Module,java.lang.String> oldNames)`
`java.util.Collection<ModuleDescription>`	`getAllModuleDescriptions()`
`java.util.Collection<ModulePath>`	`getFailedModulePaths()`
`static ModuleManagerImpl`	`getInstanceImpl(Project project)`
`ModifiableModuleModel`	`getModifiableModel()` Returns the model for the list of modules in the project, which can be used to add, remove or modify modules.
`java.util.List<Module>`	`getModuleDependentModules(Module module)` Returns the list of modules which directly depend on the specified module.
`ModuleGrouper`	`getModuleGrouper(ModifiableModuleModel model)`
`java.lang.String[]`	`getModuleGroupPath(Module module)` Returns the path to the group to which the specified module belongs, as an array of group names starting from the project root.
`int`	`getModulePathsCount()`
`Module []`	`getModules()` Returns the list of all modules in the project.
`static java.util.Set<ModulePath>`	`getPathsToModuleFiles(Element element)`
`Module []`	`getSortedModules()` Returns the list of modules sorted by dependency (the modules which do not depend on anything are in the beginning of the list, a module which depends on another module follows it in the list).
`Element`	`getState()`
`UnloadedModuleDescription`	`getUnloadedModuleDescription(java.lang.String moduleName)`
`java.util.Collection<UnloadedModuleDescription>`	`getUnloadedModuleDescriptions()`
`boolean`	`hasModuleGroups()`
`boolean`	`isModuleDependent(Module module, Module onModule)` Checks if one of the specified modules directly depends on the other module.
`protected boolean`	`isUnknownModuleType(Module module)`
`Module`	`loadModule(java.lang.String filePath)` Loads a module from an .iml file with the specified path and adds it to the project.
`protected void`	`loadModules(com.intellij.openapi.module.impl.ModuleManagerImpl.ModuleModelImpl moduleModel)`
`void`	`loadState(Element state)` This method is called when new component state is loaded.
`java.util.Comparator<Module>`	`moduleDependencyComparator()` Returns the module comparator which can be used for sorting modules by dependency (the modules which do not depend on anything are in the beginning of the list, a module which depends on another module follows it in the list).
`Graph<Module>`	`moduleGraph()` Returns the graph of dependencies between modules in the project.
`Graph<Module>`	`moduleGraph(boolean includeTests)` Returns the graph of dependencies between modules in the project.
`Module`	`newModule(java.lang.String filePath, java.lang.String moduleTypeId)` Creates a module of the specified type at the specified path and adds it to the project to which the module manager is related.
`Module`	`newNonPersistentModule(java.lang.String moduleName, java.lang.String id)` Creates a non-persistent module of the specified type and adds it to the project to which the module manager is related.
`void`	`noStateLoaded()` This method is called when the component is initialized, but no state is persisted.
`void`	`projectClosed()` Invoked when the project corresponding to this component instance is closed.
`void`	`projectOpened()` Invoked when the project corresponding to this component instance is opened.
`void`	`removeUnloadedModules(java.util.Collection<? extends UnloadedModuleDescription> unloadedModules)`
`void`	`setModuleGroupPath(Module module, java.lang.String [] groupPath)`
`void`	`setProgressStep(double step)`
`protected void`	`setUnloadedModuleNames(java.util.List<java.lang.String> unloadedModuleNames)`
`void`	`setUnloadedModules(java.util.List<java.lang.String> unloadedModuleNames)` Specify list of modules which will be unloaded from the project.
`protected void`	`showUnknownModuleTypeNotification(java.util.List<? extends Module> types)`
`protected void`	`unloadNewlyAddedModulesIfPossible(java.util.Set<ModulePath> modulesToLoad, java.util.List<UnloadedModuleDescriptionImpl> modulesToUnload)`
`void`	`writeExternal(Element element, java.util.List<? extends Module> collection)`
`static void`	`writeExternal(Element element, java.util.List<? extends Module> collection, ModuleManagerEx moduleManager)`

Methods inherited from class com.intellij.openapi.module.impl.ModuleManagerEx
getInstanceEx

Methods inherited from class com.intellij.openapi.module.ModuleManager
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

Methods inherited from interface com.intellij.openapi.components.BaseComponent
disposeComponent, initComponent

Methods inherited from interface com.intellij.openapi.components.NamedComponent
getComponentName

- Field Detail
  - COMPONENT_NAME
```
public static final java.lang.String COMPONENT_NAME
```
    See Also:
    
    Constant Field Values
  - ELEMENT_MODULES
```
public static final java.lang.String ELEMENT_MODULES
```
    See Also:
    
    Constant Field Values
  - ELEMENT_MODULE
```
public static final java.lang.String ELEMENT_MODULE
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_FILEURL
```
public static final java.lang.String ATTRIBUTE_FILEURL
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_FILEPATH
```
public static final java.lang.String ATTRIBUTE_FILEPATH
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_GROUP
```
public static final java.lang.String ATTRIBUTE_GROUP
```
    See Also:
    
    Constant Field Values
  - IML_EXTENSION
```
public static final java.lang.String IML_EXTENSION
```
    See Also:
    
    Constant Field Values
  - MODULE_GROUP_SEPARATOR
```
public static final java.lang.String MODULE_GROUP_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - myProject
```
protected final Project myProject
```
  - myMessageBus
```
protected final MessageBus myMessageBus
```
  - myModuleModel
```
protected volatile com.intellij.openapi.module.impl.ModuleManagerImpl.ModuleModelImpl myModuleModel
```
- Constructor Detail
  - ModuleManagerImpl
```
public ModuleManagerImpl(Project project)
```
- Method Detail
  - getInstanceImpl
```
public static ModuleManagerImpl getInstanceImpl(Project project)
```
  - projectOpened
```
public void projectOpened()
```
    Description copied from interface: ProjectComponent
    
    Invoked when the project corresponding to this component instance is opened.
    Note that components may be created for even unopened projects and this method can be never invoked for a particular component instance (for example for default project).
    
    Specified by:
    
    projectOpened in interface ProjectComponent
  - projectClosed
```
public void projectClosed()
```
    Description copied from interface: ProjectComponent
    
    Invoked when the project corresponding to this component instance is closed.
    Note that components may be created for even unopened projects and this method can be never invoked for a particular component instance (for example for default project).
    
    Specified by:
    
    projectClosed in interface ProjectComponent
  - cleanCachedStuff
```
protected void cleanCachedStuff()
```
  - dispose
```
public void dispose()
```
    Description copied from interface: Disposable
    
    Usually not invoked directly, see class javadoc.
    
    Specified by:
    
    dispose in interface Disposable
  - 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
  - loadState
```
public void loadState(Element state)
```
    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:
    
    state - 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>
  - unloadNewlyAddedModulesIfPossible
```
protected void unloadNewlyAddedModulesIfPossible(java.util.Set<ModulePath> modulesToLoad,
                                                 java.util.List<UnloadedModuleDescriptionImpl> modulesToUnload)
```
  - getPathsToModuleFiles
```
public static java.util.Set<ModulePath> getPathsToModuleFiles(Element element)
```
  - loadModules
```
protected void loadModules(com.intellij.openapi.module.impl.ModuleManagerImpl.ModuleModelImpl moduleModel)
```
  - getModulePathsCount
```
public int getModulePathsCount()
```
  - areModulesLoaded
```
public boolean areModulesLoaded()
```
  - setProgressStep
```
public void setProgressStep(double step)
```
  - isUnknownModuleType
```
protected boolean isUnknownModuleType(Module module)
```
  - showUnknownModuleTypeNotification
```
protected void showUnknownModuleTypeNotification(java.util.List<? extends Module> types)
```
  - fireModuleAdded
```
protected void fireModuleAdded(Module module)
```
  - fireModuleRemoved
```
protected void fireModuleRemoved(Module module)
```
  - fireBeforeModuleRemoved
```
protected void fireBeforeModuleRemoved(Module module)
```
  - fireModulesRenamed
```
protected void fireModulesRenamed(java.util.List<Module> modules,
                                  java.util.Map<Module,java.lang.String> oldNames)
```
  - fireModuleLoadErrors
```
protected void fireModuleLoadErrors(java.util.List<? extends ModuleLoadingErrorDescription> errors)
```
  - getModifiableModel
```
public ModifiableModuleModel getModifiableModel()
```
    Description copied from class: ModuleManager
    
    Returns the model for the list of modules in the project, which can be used to add, remove or modify modules.
    
    Specified by:
    
    getModifiableModel in class ModuleManager
    
    Returns:
    
    the modifiable model instance.
  - writeExternal
```
public void writeExternal(Element element,
                          java.util.List<? extends Module> collection)
```
  - writeExternal
```
public static void writeExternal(Element element,
                                 java.util.List<? extends Module> collection,
                                 ModuleManagerEx moduleManager)
```
  - newModule
```
public Module newModule(java.lang.String filePath,
                        java.lang.String moduleTypeId)
```
    Description copied from class: ModuleManager
    
    Creates a module of the specified type at the specified path and adds it to the project to which the module manager is related.
    
    Specified by:
    
    newModule in class ModuleManager
    
    Parameters:
    
    filePath - path to an *.iml file where module configuration will be saved; name of the module will be equal to the file name without extension.
    
    moduleTypeId - the ID of the module type to create.
    
    Returns:
    
    the module instance.
  - newNonPersistentModule
```
public Module newNonPersistentModule(java.lang.String moduleName,
                                     java.lang.String id)
```
    Description copied from class: ModuleManager
    
    Creates a non-persistent module of the specified type and adds it to the project to which the module manager is related. #commit() must be called to bring the changes in effect. In contrast with modules created by ModuleManager.newModule(String, String), non-persistent modules aren't stored on a filesystem and aren't being written in a project XML file. When IDE closes, all non-persistent modules vanishes out.
    
    Overrides:
    
    newNonPersistentModule in class ModuleManager
  - loadModule
```
public Module loadModule(java.lang.String filePath)
                  throws java.io.IOException,
                         ModuleWithNameAlreadyExists
```
    Description copied from class: ModuleManager
    
    Loads a module from an .iml file with the specified path and adds it to the project.
    
    Specified by:
    
    loadModule in class ModuleManager
    
    Parameters:
    
    filePath - the path to load the module from.
    
    Returns:
    
    the module instance.
    
    Throws:
    
    java.io.IOException - if an I/O error occurred when loading the module file.
    
    ModuleWithNameAlreadyExists - if a module with such a name already exists in the project.
  - disposeModule
```
public void disposeModule(Module module)
```
    Description copied from class: ModuleManager
    
    Disposes of the specified module and removes it from the project.
    
    Specified by:
    
    disposeModule in class ModuleManager
    
    Parameters:
    
    module - the module to remove.
  - getModules
```
public Module [] getModules()
```
    Description copied from class: ModuleManager
    
    Returns the list of all modules in the project.
    
    Specified by:
    
    getModules in class ModuleManager
    
    Returns:
    
    the array of modules.
  - getSortedModules
```
public Module [] getSortedModules()
```
    Description copied from class: ModuleManager
    
    Returns the list of modules sorted by dependency (the modules which do not depend on anything are in the beginning of the list, a module which depends on another module follows it in the list).
    
    Specified by:
    
    getSortedModules in class ModuleManager
    
    Returns:
    
    the sorted array of modules.
  - findModuleByName
```
public Module findModuleByName(java.lang.String name)
```
    Description copied from class: ModuleManager
    
    Returns the project module with the specified name.
    
    Specified by:
    
    findModuleByName in class ModuleManager
    
    Parameters:
    
    name - the name of the module to find.
    
    Returns:
    
    the module instance, or null if no module with such name exists.
  - moduleDependencyComparator
```
public java.util.Comparator<Module> moduleDependencyComparator()
```
    Description copied from class: ModuleManager
    
    Returns the module comparator which can be used for sorting modules by dependency (the modules which do not depend on anything are in the beginning of the list, a module which depends on another module follows it in the list).
    
    Specified by:
    
    moduleDependencyComparator in class ModuleManager
    
    Returns:
    
    the module comparator instance.
  - deliverPendingEvents
```
protected void deliverPendingEvents()
```
  - moduleGraph
```
public Graph<Module> moduleGraph()
```
    Description copied from class: ModuleManager
    
    Returns the graph of dependencies between modules in the project.
    
    Specified by:
    
    moduleGraph in class ModuleManager
    
    Returns:
    
    the module dependency graph.
  - moduleGraph
```
public Graph<Module> moduleGraph(boolean includeTests)
```
    Description copied from class: ModuleManager
    
    Returns the graph of dependencies between modules in the project.
    
    Specified by:
    
    moduleGraph in class ModuleManager
    
    Parameters:
    
    includeTests - whether test-only dependencies should be included
    
    Returns:
    
    the module dependency graph.
  - getModuleDependentModules
```
public java.util.List<Module> getModuleDependentModules(Module module)
```
    Description copied from class: ModuleManager
    
    Returns the list of modules which directly depend on the specified module.
    
    Specified by:
    
    getModuleDependentModules in class ModuleManager
    
    Parameters:
    
    module - the module for which the list of dependent modules is requested.
    
    Returns:
    
    list of modules that depend on given module.
    
    See Also:
    
    ModuleUtilCore.getAllDependentModules(Module)
  - isModuleDependent
```
public boolean isModuleDependent(Module module,
                                 Module onModule)
```
    Description copied from class: ModuleManager
    
    Checks if one of the specified modules directly depends on the other module.
    
    Specified by:
    
    isModuleDependent in class ModuleManager
    
    Parameters:
    
    module - the module to check the dependency for.
    
    onModule - the module on which module may depend.
    
    Returns:
    
    true if module directly depends on onModule, false otherwise.
  - fireModulesAdded
```
protected void fireModulesAdded()
```
  - fireModuleAddedInWriteAction
```
protected void fireModuleAddedInWriteAction(ModuleEx module)
```
  - commitModelWithRunnable
```
public static void commitModelWithRunnable(ModifiableModuleModel model,
                                           java.lang.Runnable runnable)
```
  - createModule
```
protected abstract ModuleEx createModule(java.lang.String filePath)
```
  - createNonPersistentModule
```
protected ModuleEx createNonPersistentModule(java.lang.String name)
```
  - createAndLoadModule
```
protected abstract ModuleEx createAndLoadModule(java.lang.String filePath)
                                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - fireModuleRenamedByVfsEvent
```
public void fireModuleRenamedByVfsEvent(Module module,
                                        java.lang.String oldName)
```
  - getModuleGroupPath
```
public java.lang.String[] getModuleGroupPath(Module module)
```
    Description copied from class: ModuleManager
    
    Returns the path to the group to which the specified module belongs, as an array of group names starting from the project root.
    Use ModuleGrouper#getGroupPath(Module) instead. Explicit module groups will be replaced by automatical module grouping accordingly to qualified names of modules, see https://youtrack.jetbrains.com/issue/IDEA-166061 for details.
    
    Specified by:
    
    getModuleGroupPath in class ModuleManager
    
    Parameters:
    
    module - the module for which the path is requested.
    
    Returns:
    
    the path to the group for the module, or null if the module does not belong to any group.
  - hasModuleGroups
```
public boolean hasModuleGroups()
```
    Specified by:
    
    hasModuleGroups in class ModuleManager
  - getAllModuleDescriptions
```
public java.util.Collection<ModuleDescription> getAllModuleDescriptions()
```
    Specified by:
    
    getAllModuleDescriptions in class ModuleManager
    
    Returns:
    
    description of all modules in the project including unloaded
  - getUnloadedModuleDescriptions
```
public java.util.Collection<UnloadedModuleDescription> getUnloadedModuleDescriptions()
```
    Specified by:
    
    getUnloadedModuleDescriptions in class ModuleManager
  - getFailedModulePaths
```
public java.util.Collection<ModulePath> getFailedModulePaths()
```
    Specified by:
    
    getFailedModulePaths in class ModuleManagerEx
  - getUnloadedModuleDescription
```
public UnloadedModuleDescription getUnloadedModuleDescription(java.lang.String moduleName)
```
    Specified by:
    
    getUnloadedModuleDescription in class ModuleManager
  - getModuleGrouper
```
public ModuleGrouper getModuleGrouper(ModifiableModuleModel model)
```
    Specified by:
    
    getModuleGrouper in class ModuleManager
  - setUnloadedModules
```
public void setUnloadedModules(java.util.List<java.lang.String> unloadedModuleNames)
```
    Description copied from class: ModuleManager
    
    Specify list of modules which will be unloaded from the project.
    
    Specified by:
    
    setUnloadedModules in class ModuleManager
    
    See Also:
    
    UnloadedModuleDescription
  - removeUnloadedModules
```
public void removeUnloadedModules(java.util.Collection<? extends UnloadedModuleDescription> unloadedModules)
```
    Overrides:
    
    removeUnloadedModules in class ModuleManager
  - setUnloadedModuleNames
```
protected void setUnloadedModuleNames(java.util.List<java.lang.String> unloadedModuleNames)
```
  - setModuleGroupPath
```
public void setModuleGroupPath(Module module,
                               java.lang.String [] groupPath)
```

Class ModuleManagerImpl

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.intellij.openapi.module.impl.ModuleManagerEx

Methods inherited from class com.intellij.openapi.module.ModuleManager

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

COMPONENT_NAME

ELEMENT_MODULES

ELEMENT_MODULE

ATTRIBUTE_FILEURL

ATTRIBUTE_FILEPATH

ATTRIBUTE_GROUP

IML_EXTENSION

MODULE_GROUP_SEPARATOR

myProject

myMessageBus

myModuleModel

Constructor Detail

ModuleManagerImpl

Method Detail

getInstanceImpl

projectOpened

projectClosed

cleanCachedStuff

dispose

getState

loadState

noStateLoaded

unloadNewlyAddedModulesIfPossible

getPathsToModuleFiles

loadModules

getModulePathsCount

areModulesLoaded

setProgressStep

isUnknownModuleType

showUnknownModuleTypeNotification

fireModuleAdded

fireModuleRemoved

fireBeforeModuleRemoved

fireModulesRenamed

fireModuleLoadErrors

getModifiableModel

writeExternal

writeExternal

newModule

newNonPersistentModule

loadModule

disposeModule

getModules

getSortedModules

findModuleByName

moduleDependencyComparator

deliverPendingEvents

moduleGraph

moduleGraph

getModuleDependentModules

isModuleDependent

fireModulesAdded

fireModuleAddedInWriteAction

commitModelWithRunnable

createModule

createNonPersistentModule

createAndLoadModule

fireModuleRenamedByVfsEvent

getModuleGroupPath

hasModuleGroups

getAllModuleDescriptions

getUnloadedModuleDescriptions

getFailedModulePaths

getUnloadedModuleDescription

getModuleGrouper