ModuleManager (Unofficial IntelliJ Community Edition API docs)

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

All Implemented Interfaces:

ModificationTracker

Direct Known Subclasses:

ModuleManagerEx
```
public abstract class ModuleManager
extends SimpleModificationTracker
```
Provides services for working with the modules of a project.

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

Constructor Summary

Constructors
Constructor and Description

ModuleManager()

Constructors
Constructor and Description
`ModuleManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`disposeModule(Module module)` Disposes of the specified module and removes it from the project.
`abstract Module`	`findModuleByName(java.lang.String name)` Returns the project module with the specified name.
`abstract java.util.Collection<ModuleDescription>`	`getAllModuleDescriptions()`
`static ModuleManager`	`getInstance(Project project)` Returns the module manager instance for the current project.
`abstract ModifiableModuleModel`	`getModifiableModel()` Returns the model for the list of modules in the project, which can be used to add, remove or modify modules.
`abstract java.util.List<Module>`	`getModuleDependentModules(Module module)` Returns the list of modules which directly depend on the specified module.
`abstract ModuleGrouper`	`getModuleGrouper(ModifiableModuleModel model)`
`abstract 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.
`abstract Module []`	`getModules()` Returns the list of all modules in the project.
`abstract 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).
`abstract UnloadedModuleDescription`	`getUnloadedModuleDescription(java.lang.String moduleName)`
`abstract java.util.Collection<UnloadedModuleDescription>`	`getUnloadedModuleDescriptions()`
`abstract boolean`	`hasModuleGroups()`
`abstract boolean`	`isModuleDependent(Module module, Module onModule)` Checks if one of the specified modules directly depends on the other module.
`abstract Module`	`loadModule(java.lang.String filePath)` Loads a module from an .iml file with the specified path and adds it to the project.
`abstract 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).
`abstract Graph<Module>`	`moduleGraph()` Returns the graph of dependencies between modules in the project.
`abstract Graph<Module>`	`moduleGraph(boolean includeTests)` Returns the graph of dependencies between modules in the project.
`abstract 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`	`removeUnloadedModules(java.util.Collection<? extends UnloadedModuleDescription> unloadedModules)`
`abstract void`	`setUnloadedModules(java.util.List<java.lang.String> unloadedModuleNames)` Specify list of modules which will be unloaded from 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
  - ModuleManager
```
public ModuleManager()
```
- Method Detail
  - getInstance
```
public static ModuleManager getInstance(Project project)
```
    Returns the module manager instance for the current project.
    
    Parameters:
    
    project - the project for which the module manager is requested.
    
    Returns:
    
    the module manager instance.
  - newModule
```
public abstract 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.
    
    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)
```
    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 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.
  - loadModule
```
public abstract Module loadModule(java.lang.String filePath)
                           throws java.io.IOException,
                                  JDOMException,
                                  ModuleWithNameAlreadyExists
```
    Loads a module from an .iml file with the specified path and adds it to the project.
    
    Parameters:
    
    filePath - the path to load the module from.
    
    Returns:
    
    the module instance.
    
    Throws:
    
    InvalidDataException - if the data in the .iml file is semantically incorrect.
    
    java.io.IOException - if an I/O error occurred when loading the module file.
    
    JDOMException - if the file contains invalid XML data.
    
    ModuleWithNameAlreadyExists - if a module with such a name already exists in the project.
  - disposeModule
```
public abstract void disposeModule(Module module)
```
    Disposes of the specified module and removes it from the project.
    
    Parameters:
    
    module - the module to remove.
  - getModules
```
public abstract Module [] getModules()
```
    Returns the list of all modules in the project.
    
    Returns:
    
    the array of modules.
  - findModuleByName
```
public abstract Module findModuleByName(java.lang.String name)
```
    Returns the project module with the specified name.
    
    Parameters:
    
    name - the name of the module to find.
    
    Returns:
    
    the module instance, or null if no module with such name exists.
  - getSortedModules
```
public abstract 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).
    
    Returns:
    
    the sorted array of modules.
  - moduleDependencyComparator
```
public abstract 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).
    
    Returns:
    
    the module comparator instance.
  - getModuleDependentModules
```
public abstract java.util.List<Module> getModuleDependentModules(Module module)
```
    Returns the list of modules which directly depend on the specified module.
    
    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 abstract boolean isModuleDependent(Module module,
                                          Module onModule)
```
    Checks if one of the specified modules directly depends on the other module.
    
    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.
  - moduleGraph
```
public abstract Graph<Module> moduleGraph()
```
    Returns the graph of dependencies between modules in the project.
    
    Returns:
    
    the module dependency graph.
  - moduleGraph
```
public abstract Graph<Module> moduleGraph(boolean includeTests)
```
    Returns the graph of dependencies between modules in the project.
    
    Parameters:
    
    includeTests - whether test-only dependencies should be included
    
    Returns:
    
    the module dependency graph.
  - getModifiableModel
```
public abstract ModifiableModuleModel getModifiableModel()
```
    Returns the model for the list of modules in the project, which can be used to add, remove or modify modules.
    
    Returns:
    
    the modifiable model instance.
  - getModuleGroupPath
```
public abstract 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.
    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.
    
    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 abstract boolean hasModuleGroups()
```
  - getAllModuleDescriptions
```
public abstract java.util.Collection<ModuleDescription> getAllModuleDescriptions()
```
    Returns:
    
    description of all modules in the project including unloaded
  - getUnloadedModuleDescriptions
```
public abstract java.util.Collection<UnloadedModuleDescription> getUnloadedModuleDescriptions()
```
  - getUnloadedModuleDescription
```
public abstract UnloadedModuleDescription getUnloadedModuleDescription(java.lang.String moduleName)
```
  - getModuleGrouper
```
public abstract ModuleGrouper getModuleGrouper(ModifiableModuleModel model)
```
  - setUnloadedModules
```
public abstract void setUnloadedModules(java.util.List<java.lang.String> unloadedModuleNames)
```
    Specify list of modules which will be unloaded from the project.
    
    See Also:
    
    UnloadedModuleDescription
  - removeUnloadedModules
```
public void removeUnloadedModules(java.util.Collection<? extends UnloadedModuleDescription> unloadedModules)
```

Class ModuleManager

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ModuleManager

Method Detail

getInstance

newModule

newNonPersistentModule

loadModule

disposeModule

getModules

findModuleByName

getSortedModules

moduleDependencyComparator

getModuleDependentModules

isModuleDependent

moduleGraph

moduleGraph

getModifiableModel

getModuleGroupPath

hasModuleGroups

getAllModuleDescriptions

getUnloadedModuleDescriptions

getUnloadedModuleDescription

getModuleGrouper

setUnloadedModules

removeUnloadedModules