ModifiableModuleModel (Unofficial IntelliJ Community Edition API docs)

```
public interface ModifiableModuleModel
```
Represents the model for the list of modules in a project, or a temporary copy of that model displayed in the configuration UI.

See Also:

ModuleManager.getModifiableModel()

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`commit()` Commits changes made in this model to the actual project structure.
`void`	`dispose()` Disposes of all modules in the project.
`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.
`java.lang.String`	`getActualName(Module module)`
`java.lang.String []`	`getModuleGroupPath(Module module)`
`Module []`	`getModules()` Returns the list of all modules in the project.
`Module`	`getModuleToBeRenamed(java.lang.String newName)` Returns the project module which has been renamed to the specified name.
`java.lang.String`	`getNewName(Module module)` Returns the name to which the specified module has been renamed.
`Project`	`getProject()`
`boolean`	`hasModuleGroups()`
`boolean`	`isChanged()` Checks if there are any uncommitted changes to the model.
`Module`	`loadModule(@SystemIndependent java.lang.String filePath)` Loads a module from an .iml file with the specified path and adds it to 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`	`newModule(java.lang.String filePath, java.lang.String moduleTypeId, java.util.Map<java.lang.String,java.lang.String> options)` Creates a module of the specified type at the specified path and adds it to the project to which the module manager is related.
`default Module`	`newNonPersistentModule(java.lang.String moduleName, java.lang.String moduleTypeId)` Creates a non-persistent module of the specified type and adds it to the project to which the module manager is related.
`void`	`renameModule(Module module, java.lang.String newName)` Schedules the rename of a module to be performed when the model is committed.
`void`	`setModuleGroupPath(Module module, java.lang.String [] groupPath)`

- Method Detail
  - getModules
```
Module [] getModules()
```
    Returns the list of all modules in the project. Same as ModuleManager.getModules().
    
    Returns:
    
    the array of modules.
  - newModule
```
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. commit() must be called to bring the changes in effect.
    
    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
```
default Module newNonPersistentModule(java.lang.String moduleName,
                                      java.lang.String moduleTypeId)
```
    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.
  - newModule
```
Module newModule(java.lang.String filePath,
                 java.lang.String moduleTypeId,
                 java.util.Map<java.lang.String,java.lang.String> options)
```
    Creates a module of the specified type at the specified path and adds it to the project to which the module manager is related. commit() must be called to bring the changes in effect.
    
    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 - ID of the module type to create.
    
    options - map of module options to be used when creating the module
    
    Returns:
    
    the module instance.
  - loadModule
```
Module loadModule(@SystemIndependent java.lang.String filePath)
           throws java.io.IOException,
                  ModuleWithNameAlreadyExists
```
    Loads a module from an .iml file with the specified path and adds it to the project. commit() must be called to bring the changes in effect.
    
    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
```
void disposeModule(Module module)
```
    Disposes of the specified module and removes it from the project. commit() must be called to bring the changes in effect.
    
    Parameters:
    
    module - the module to remove.
  - findModuleByName
```
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.
  - dispose
```
void dispose()
```
    Disposes of all modules in the project.
  - isChanged
```
boolean isChanged()
```
    Checks if there are any uncommitted changes to the model.
    
    Returns:
    
    true if there are uncommitted changes, false otherwise
  - commit
```
void commit()
```
    Commits changes made in this model to the actual project structure.
  - renameModule
```
void renameModule(Module module,
                  java.lang.String newName)
           throws ModuleWithNameAlreadyExists
```
    Schedules the rename of a module to be performed when the model is committed.
    
    Parameters:
    
    module - the module to rename.
    
    newName - the new name to rename the module to.
    
    Throws:
    
    ModuleWithNameAlreadyExists - if a module with such a name already exists in the project.
  - getModuleToBeRenamed
```
Module getModuleToBeRenamed(java.lang.String newName)
```
    Returns the project module which has been renamed to the specified name.
    
    Parameters:
    
    newName - the name of the renamed module to find.
    
    Returns:
    
    the module instance, or null if no module has been renamed to such a name.
  - getNewName
```
java.lang.String getNewName(Module module)
```
    Returns the name to which the specified module has been renamed.
    
    Parameters:
    
    module - the module for which the new name is requested.
    
    Returns:
    
    the new name, or null if the module has not been renamed.
  - getActualName
```
java.lang.String getActualName(Module module)
```
    Returns:
    
    the new name of module if it has been renamed or its old name it hasn't.
  - getModuleGroupPath
```
java.lang.String [] getModuleGroupPath(Module module)
```
  - hasModuleGroups
```
boolean hasModuleGroups()
```
  - setModuleGroupPath
```
void setModuleGroupPath(Module module,
                        java.lang.String [] groupPath)
```
  - getProject
```
Project getProject()
```

Interface ModifiableModuleModel

Method Summary

Method Detail

getModules

newModule

newNonPersistentModule

newModule

loadModule

disposeModule

findModuleByName

dispose

isChanged

commit

renameModule

getModuleToBeRenamed

getNewName

getActualName

getModuleGroupPath

hasModuleGroups

setModuleGroupPath

getProject