Package com.intellij.openapi.roots

Class ModuleExtension

java.lang.Object

com.intellij.openapi.roots.ModuleExtension

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

CompilerModuleExtension, JavaModuleExternalPaths, LanguageLevelModuleExtensionImpl

public abstract class ModuleExtension
extends java.lang.Object
implements Disposable

Extend this class to provide additional module-level properties which can be edited in Project Structure dialog. For ordinary module-level properties use module service instead.

If the inheritor implements PersistentStateComponent its state will be persisted in the module configuration file.

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 ExtensionPointName<ModuleExtension>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
ModuleExtension()

Method Summary

Modifier and Type	Method and Description
abstract void	commit()
abstract ModuleExtension	getModifiableModel(boolean writable) Note: don't call this method directly from client code.
abstract boolean	isChanged()
void	readExternal(Element element) Deprecated. Please implement PersistentStateComponent instead.
void	writeExternal(Element element) Deprecated. Please implement PersistentStateComponent instead.

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.Disposable

dispose

Field Detail

EP_NAME

public static final ExtensionPointName<ModuleExtension> EP_NAME

Constructor Detail

ModuleExtension

public ModuleExtension()

Method Detail

getModifiableModel

public abstract ModuleExtension getModifiableModel(boolean writable)

Note: don't call this method directly from client code. Use approach below instead:

   ModifiableRootModel modifiableModel = ModuleRootManager.getInstance(module).getModifiableModel();
   CompilerModuleExtension extension = modifiableModel.getModuleExtension(CompilerModuleExtension.class);
   try {
     // ...
   }
   finally {
     modifiableModel.commit();
   }
 

The point is that call to commit() on CompilerModuleExtension obtained like 'CompilerModuleExtension.getInstance(module).getModifiableModel(true)' doesn't dispose the model.

Call to ModifiableRootModel.commit() not only commits linked extensions but disposes them as well.

Parameters:

writable - flag which identifies if resulting model is writable

Returns:

extension model

commit

public abstract void commit()

isChanged

public abstract boolean isChanged()

readExternal

@Deprecated
public void readExternal(Element element)

Deprecated. Please implement PersistentStateComponent instead.

writeExternal

@Deprecated
public void writeExternal(Element element)

Deprecated. Please implement PersistentStateComponent instead.