Package com.intellij.openapi.components

Interface ComponentManager

All Superinterfaces:

AreaInstance, Disposable, UserDataHolder

All Known Subinterfaces:

Application, ApplicationEx, Module, ModuleEx, Project, ProjectEx

All Known Implementing Classes:

ApplicationImpl, CoreModule, DummyProject, MockApplication, MockApplicationEx, MockComponentManager, MockProject, ModuleImpl, ProjectImpl

public interface ComponentManager
extends UserDataHolder, Disposable, AreaInstance

Provides access to components. Serves as a base interface for Application and Project.

See Also:

ProjectComponent, Application, Project

Nested Class Summary

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

Disposable.Parent

Method Summary

Modifier and Type	Method and Description
default java.lang.RuntimeException	createError(java.lang.String message, PluginId pluginId)
default java.lang.RuntimeException	createError(java.lang.Throwable error, PluginId pluginId)
<T> T	getComponent(java.lang.Class<T> interfaceClass) Gets the component by its interface class.
default <T> T	getComponent(java.lang.Class<T> interfaceClass, T defaultImplementationIfAbsent) Deprecated. Useless.
default BaseComponent	getComponent(java.lang.String name) Deprecated. Use getComponent(Class) instead.
default <T> java.util.List<T>	getComponentInstancesOfType(java.lang.Class<T> baseClass) Deprecated. Do not use.
default <T> java.util.List<T>	getComponentInstancesOfType(java.lang.Class<T> baseClass, boolean createIfNotYet) Deprecated.
default <T> T []	getComponents(java.lang.Class<T> baseClass) Deprecated. use extension points instead
Condition<?>	getDisposed()
default ExtensionsArea	getExtensionArea()
default <T> T []	getExtensions(ExtensionPointName<T> extensionPointName) Deprecated. Use ExtensionPointName.getExtensionList(AreaInstance)
MessageBus	getMessageBus()
PicoContainer	getPicoContainer()
default <T> T	getService(java.lang.Class<T> serviceClass)
default <T> T	getService(java.lang.Class<T> serviceClass, boolean createIfNeeded) Deprecated. Use getServiceIfCreated(Class) or getService(Class).
default <T> T	getServiceIfCreated(java.lang.Class<T> serviceClass)
default boolean	hasComponent(java.lang.Class<?> interfaceClass) Checks whether there is a component with the specified interface class.
default <T> T	instantiateClass(java.lang.Class<T> aClass, PluginId pluginId)
default <T> T	instantiateClassWithConstructorInjection(java.lang.Class<T> aClass, java.lang.Object key, PluginId pluginId)
default <T> T	instantiateExtensionWithPicoContainerOnlyIfNeeded(java.lang.String name, PluginDescriptor pluginDescriptor)
boolean	isDisposed()
default boolean	isDisposedOrDisposeInProgress() Deprecated. Use isDisposed() instead
default void	logError(java.lang.Throwable error, PluginId pluginId)

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Method Detail

getComponent

@Deprecated
default BaseComponent getComponent(java.lang.String name)

Deprecated. Use getComponent(Class) instead.

getComponent

<T> T getComponent(java.lang.Class<T> interfaceClass)

Gets the component by its interface class.

Parameters:

interfaceClass - the interface class of the component

Returns:

component that matches interface class or null if there is no such component

getComponent

@Deprecated
default <T> T getComponent(java.lang.Class<T> interfaceClass,
                           T defaultImplementationIfAbsent)

Deprecated. Useless.

hasComponent

default boolean hasComponent(java.lang.Class<?> interfaceClass)

Checks whether there is a component with the specified interface class.

Parameters:

interfaceClass - interface class of component to be checked

Returns:

true if there is a component with the specified interface class; false otherwise

getComponents

@Deprecated
default <T> T [] getComponents(java.lang.Class<T> baseClass)

Deprecated. use extension points instead

Gets all components whose implementation class is derived from baseClass.

getPicoContainer

PicoContainer getPicoContainer()

getMessageBus

MessageBus getMessageBus()

See Also:

com.intellij.application.Topics#subscribe

isDisposed

boolean isDisposed()

Returns:

true when this component is disposed (e.g. the "File|Close Project" invoked or the application is exited) or is about to be disposed (e.g. the ProjectImpl.dispose() was called but not completed yet)
The result is only valid inside read action because the application/project/module can be disposed at any moment. (see more details on read actions)

isDisposedOrDisposeInProgress

@Deprecated
default boolean isDisposedOrDisposeInProgress()

Deprecated. Use isDisposed() instead

getExtensions

@Deprecated
default <T> T [] getExtensions(ExtensionPointName<T> extensionPointName)

Deprecated. Use ExtensionPointName.getExtensionList(AreaInstance)

getDisposed

Condition<?> getDisposed()

Returns:

condition for this component being disposed. see Application.invokeLater(Runnable, Condition) for the usage example.

getService

@Deprecated
default <T> T getService(java.lang.Class<T> serviceClass,
                         boolean createIfNeeded)

Deprecated. Use getServiceIfCreated(Class) or getService(Class).

getService

default <T> T getService(java.lang.Class<T> serviceClass)

getServiceIfCreated

default <T> T getServiceIfCreated(java.lang.Class<T> serviceClass)

getExtensionArea

default ExtensionsArea getExtensionArea()

Specified by:

getExtensionArea in interface AreaInstance

instantiateClass

default <T> T instantiateClass(java.lang.Class<T> aClass,
                               PluginId pluginId)

instantiateClassWithConstructorInjection

default <T> T instantiateClassWithConstructorInjection(java.lang.Class<T> aClass,
                                                       java.lang.Object key,
                                                       PluginId pluginId)

logError

default void logError(java.lang.Throwable error,
                      PluginId pluginId)

createError

default java.lang.RuntimeException createError(java.lang.Throwable error,
                                               PluginId pluginId)

createError

default java.lang.RuntimeException createError(java.lang.String message,
                                               PluginId pluginId)

instantiateExtensionWithPicoContainerOnlyIfNeeded

default <T> T instantiateExtensionWithPicoContainerOnlyIfNeeded(java.lang.String name,
                                                                PluginDescriptor pluginDescriptor)

getComponentInstancesOfType

@Deprecated
default <T> java.util.List<T> getComponentInstancesOfType(java.lang.Class<T> baseClass)

Deprecated. Do not use.

getComponentInstancesOfType

@Deprecated
default <T> java.util.List<T> getComponentInstancesOfType(java.lang.Class<T> baseClass,
                                                          boolean createIfNotYet)

Deprecated.