Package com.intellij.openapi.extensions.impl

Class ExtensionPointImpl<T>

java.lang.Object

com.intellij.openapi.extensions.impl.ExtensionPointImpl<T>

All Implemented Interfaces:

ExtensionPoint<T>, java.lang.Iterable<T>

Direct Known Subclasses:

BeanExtensionPoint, InterfaceExtensionPoint

public abstract class ExtensionPointImpl<T>
extends java.lang.Object
implements ExtensionPoint<T>, java.lang.Iterable<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.extensions.ExtensionPoint

ExtensionPoint.Kind

Field Summary

Fields

Modifier and Type	Field and Description
protected PluginDescriptor	myDescriptor

Method Summary

Modifier and Type	Method and Description
void	addExtensionPointListener(ExtensionPointChangeListener listener, boolean invokeForLoadedExtensions, Disposable parentDisposable)
void	addExtensionPointListener(ExtensionPointListener<T> listener)
void	addExtensionPointListener(ExtensionPointListener<T> listener, boolean invokeForLoadedExtensions, Disposable parentDisposable)
void	clearExtensionClass()
abstract ExtensionPointImpl<T>	cloneFor(ComponentManager manager)
protected abstract ExtensionComponentAdapter	createAdapterAndRegisterInPicoContainerIfNeeded(Element extensionElement, PluginDescriptor pluginDescriptor, ComponentManager componentManager)
java.util.stream.Stream<T>	extensions()
<V extends T> V	findExtension(java.lang.Class<V> aClass, boolean isRequired, ThreeState strictMatch)
java.lang.String	getClassName()
ComponentManager	getComponentManager()
java.lang.Class<T>	getExtensionClass()
java.util.List<T>	getExtensionList()
T []	getExtensions() Prefer to use ExtensionPoint.getExtensionList().
java.lang.String	getName()
PluginDescriptor	getPluginDescriptor()
PluginDescriptor	getPluginDescriptor(T extension)
boolean	hasAnyExtensions()
boolean	isDynamic()
java.util.Iterator<T>	iterator() Do not use it if there is any extension point listener, because in this case behaviour is not predictable - events will be fired during iteration and probably it will be not expected.
void	maskAll(java.util.List<? extends T> list, Disposable parentDisposable, boolean fireEvents) Put extension point in read-only mode and replace existing extensions by supplied.
void	processImplementations(boolean shouldBeSorted, java.util.function.BiConsumer<java.util.function.Supplier<T>,? super PluginDescriptor> consumer)
void	processWithPluginDescriptor(boolean shouldBeSorted, java.util.function.BiConsumer<? super T,? super PluginDescriptor> consumer)
void	registerExtension(T extension)
void	registerExtension(T extension, Disposable parentDisposable)
void	registerExtension(T extension, LoadingOrder order)
void	registerExtension(T extension, LoadingOrder order, Disposable parentDisposable) Use com.intellij.testFramework.PlatformTestUtil#maskExtensions to register extension as first or to completely replace existing extensions in tests.
void	registerExtensions(java.util.List<? extends T> extensions) There are valid cases where we need to register a lot of extensions programmatically, e.g.
void	removeExtensionPointListener(ExtensionPointListener<T> listener)
void	removeUnloadableExtensions()
void	reset()
static void	setCheckCanceledAction(java.lang.Runnable checkCanceled)
java.lang.String	toString()
void	unregisterExtension(java.lang.Class<? extends T> extensionClass) Unregisters an extension of the specified type.
void	unregisterExtension(T extension)
boolean	unregisterExtensions(java.util.function.BiPredicate<? super java.lang.String,? super ExtensionComponentAdapter> extensionClassFilter, boolean stopAfterFirstMatch) Unregisters extensions for which the specified predicate returns false.
boolean	unregisterExtensions(java.util.function.BiPredicate<? super java.lang.String,? super ExtensionComponentAdapter> extensionClassFilter, boolean stopAfterFirstMatch, java.util.List<java.lang.Runnable> listenerCallbacks) Unregisters extensions for which the specified predicate returns false and collects the callables for listener invocation into the given list so that listeners can be called later.
abstract void	unregisterExtensions(PluginDescriptor pluginDescriptor, java.util.List<Element> elements, java.util.List<java.lang.Runnable> listenerCallbacks)
void	unregisterExtensions(java.util.function.Predicate<? super T> filter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.openapi.extensions.ExtensionPoint

getExtension, hasExtension

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

myDescriptor

protected final PluginDescriptor myDescriptor

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface ExtensionPoint<T>

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface ExtensionPoint<T>

isDynamic

public boolean isDynamic()

Specified by:

isDynamic in interface ExtensionPoint<T>

Returns:

true if the EP allows adding/removing extensions at runtime

registerExtension

public void registerExtension(T extension)

Specified by:

registerExtension in interface ExtensionPoint<T>

registerExtension

public void registerExtension(T extension,
                              LoadingOrder order)

Specified by:

registerExtension in interface ExtensionPoint<T>

registerExtension

public void registerExtension(T extension,
                              Disposable parentDisposable)

Specified by:

registerExtension in interface ExtensionPoint<T>

getPluginDescriptor

public final PluginDescriptor getPluginDescriptor()

Specified by:

getPluginDescriptor in interface ExtensionPoint<T>

registerExtension

public void registerExtension(T extension,
                              LoadingOrder order,
                              Disposable parentDisposable)

Description copied from interface: ExtensionPoint

Use com.intellij.testFramework.PlatformTestUtil#maskExtensions to register extension as first or to completely replace existing extensions in tests.

Specified by:

registerExtension in interface ExtensionPoint<T>

getComponentManager

public ComponentManager getComponentManager()

registerExtensions

public void registerExtensions(java.util.List<? extends T> extensions)

There are valid cases where we need to register a lot of extensions programmatically, e.g. see SqlDialectTemplateRegistrar, so, special method for bulk insertion is introduced.

getExtensionList

public java.util.List<T> getExtensionList()

Specified by:

getExtensionList in interface ExtensionPoint<T>

getExtensions

public T [] getExtensions()

Description copied from interface: ExtensionPoint

Prefer to use ExtensionPoint.getExtensionList().

Specified by:

getExtensions in interface ExtensionPoint<T>

iterator

public final java.util.Iterator<T> iterator()

Do not use it if there is any extension point listener, because in this case behaviour is not predictable - events will be fired during iteration and probably it will be not expected.

Use only for interface extension points, not for bean.

Due to internal reasons, there is no easy way to implement hasNext in a reliable manner, so, `next` may return `null` (in this case stop iteration).

Specified by:

iterator in interface java.lang.Iterable<T>

processWithPluginDescriptor

public final void processWithPluginDescriptor(boolean shouldBeSorted,
                                              java.util.function.BiConsumer<? super T,? super PluginDescriptor> consumer)

processImplementations

public final void processImplementations(boolean shouldBeSorted,
                                         java.util.function.BiConsumer<java.util.function.Supplier<T>,? super PluginDescriptor> consumer)

extensions

public java.util.stream.Stream<T> extensions()

Specified by:

extensions in interface ExtensionPoint<T>

hasAnyExtensions

public boolean hasAnyExtensions()

Specified by:

hasAnyExtensions in interface ExtensionPoint<T>

cloneFor

public abstract ExtensionPointImpl<T> cloneFor(ComponentManager manager)

removeUnloadableExtensions

public void removeUnloadableExtensions()

maskAll

public void maskAll(java.util.List<? extends T> list,
                    Disposable parentDisposable,
                    boolean fireEvents)

Put extension point in read-only mode and replace existing extensions by supplied. For tests this method is more preferable than #registerExtension) because makes registration more isolated and strict (no one can modify extension point until `parentDisposable` is not disposed).

Please use com.intellij.testFramework.ExtensionTestUtil#maskExtensions(ExtensionPointName, List, Disposable) instead of direct usage.

unregisterExtensions

public void unregisterExtensions(java.util.function.Predicate<? super T> filter)

Specified by:

unregisterExtensions in interface ExtensionPoint<T>

unregisterExtension

public void unregisterExtension(T extension)

Specified by:

unregisterExtension in interface ExtensionPoint<T>

unregisterExtension

public void unregisterExtension(java.lang.Class<? extends T> extensionClass)

Description copied from interface: ExtensionPoint

Unregisters an extension of the specified type. Please note that you can deregister service specifying empty implementation class. Consider to use ExtensionNotApplicableException instead.

Specified by:

unregisterExtension in interface ExtensionPoint<T>

unregisterExtensions

public boolean unregisterExtensions(java.util.function.BiPredicate<? super java.lang.String,? super ExtensionComponentAdapter> extensionClassFilter,
                                    boolean stopAfterFirstMatch)

Description copied from interface: ExtensionPoint

Unregisters extensions for which the specified predicate returns false. Consider to use ExtensionNotApplicableException instead.

Specified by:

unregisterExtensions in interface ExtensionPoint<T>

unregisterExtensions

public boolean unregisterExtensions(java.util.function.BiPredicate<? super java.lang.String,? super ExtensionComponentAdapter> extensionClassFilter,
                                    boolean stopAfterFirstMatch,
                                    java.util.List<java.lang.Runnable> listenerCallbacks)

Description copied from interface: ExtensionPoint

Unregisters extensions for which the specified predicate returns false and collects the callables for listener invocation into the given list so that listeners can be called later.

Specified by:

unregisterExtensions in interface ExtensionPoint<T>

unregisterExtensions

public abstract void unregisterExtensions(PluginDescriptor pluginDescriptor,
                                          java.util.List<Element> elements,
                                          java.util.List<java.lang.Runnable> listenerCallbacks)

addExtensionPointListener

public void addExtensionPointListener(ExtensionPointListener<T> listener,
                                      boolean invokeForLoadedExtensions,
                                      Disposable parentDisposable)

Specified by:

addExtensionPointListener in interface ExtensionPoint<T>

addExtensionPointListener

public void addExtensionPointListener(ExtensionPointListener<T> listener)

Specified by:

addExtensionPointListener in interface ExtensionPoint<T>

addExtensionPointListener

public void addExtensionPointListener(ExtensionPointChangeListener listener,
                                      boolean invokeForLoadedExtensions,
                                      Disposable parentDisposable)

Specified by:

addExtensionPointListener in interface ExtensionPoint<T>

removeExtensionPointListener

public void removeExtensionPointListener(ExtensionPointListener<T> listener)

Specified by:

removeExtensionPointListener in interface ExtensionPoint<T>

reset

public void reset()

Specified by:

reset in interface ExtensionPoint<T>

getExtensionClass

public java.lang.Class<T> getExtensionClass()

clearExtensionClass

public void clearExtensionClass()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createAdapterAndRegisterInPicoContainerIfNeeded

protected abstract ExtensionComponentAdapter createAdapterAndRegisterInPicoContainerIfNeeded(Element extensionElement,
                                                                                             PluginDescriptor pluginDescriptor,
                                                                                             ComponentManager componentManager)

getPluginDescriptor

public final PluginDescriptor getPluginDescriptor(T extension)

findExtension

public final <V extends T> V findExtension(java.lang.Class<V> aClass,
                                           boolean isRequired,
                                           ThreeState strictMatch)

setCheckCanceledAction

public static void setCheckCanceledAction(java.lang.Runnable checkCanceled)