mirror of
https://gitflic.ru/project/openide/openide.git
synced 2026-09-27 10:03:11 +07:00
platform: added javadoc for ModuleExtension and moduleService
This commit is contained in:
@@ -23,6 +23,18 @@ import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
/**
|
||||
* Provide a module service if you need to can be used to store data associated with a module. Its implementation should be registered in plugin.xml:
|
||||
* <pre>
|
||||
* <extensions defaultExtensionNs="com.intellij">
|
||||
* <moduleService serviceInterface="qualified-interface-class-name"
|
||||
serviceImplementation="qualified-implementation-class-name"/>
|
||||
* </extensions>
|
||||
* </pre>
|
||||
* Class is loaded and its instance is created lazily when {@link #getService(Module, Class)} method is called for the first time.
|
||||
* <p/>
|
||||
* If the service implementation class implements {@link com.intellij.openapi.components.PersistentStateComponent} interface its state will
|
||||
* be persisted in the module configuration file.
|
||||
*
|
||||
* @author yole
|
||||
*/
|
||||
public class ModuleServiceManager {
|
||||
|
||||
@@ -22,7 +22,11 @@ import org.jdom.Element;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
|
||||
/**
|
||||
* Implement {@link com.intellij.openapi.components.PersistentStateComponent} to be serializable.
|
||||
* Extend this class to provide additional module-level properties which can be edited in Project Structure dialog. For ordinary module-level
|
||||
* properties use {@link com.intellij.openapi.module.ModuleServiceManager module service} instead.
|
||||
* <p/>
|
||||
* If the inheritor implements {@link com.intellij.openapi.components.PersistentStateComponent} its state will be persisted in the module
|
||||
* configuration file.
|
||||
*/
|
||||
public abstract class ModuleExtension implements Disposable {
|
||||
public static final ExtensionPointName<ModuleExtension> EP_NAME = ExtensionPointName.create("com.intellij.moduleExtension");
|
||||
|
||||
Reference in New Issue
Block a user