Package com.intellij.ide.plugins

Class PluginReplacement

java.lang.Object

com.intellij.ide.plugins.PluginReplacement

All Implemented Interfaces:

PluginAware

Direct Known Subclasses:

AppEnginePluginReplacement

public abstract class PluginReplacement
extends java.lang.Object
implements PluginAware

Implement this class in your plugin if there is another plugin which functionality covers functionality provided by this plugin so there is no sense to have the both plugins installed together. This will instruct the IDE to suggest a user to disable this plugin when he downloads the new plugin in Settings | Plugins.

The implementation must be registered in plugin.xml of the plugin you want to replace:

 <extensions defaultExtensionNs="com.intellij">
   <pluginReplacement implementation="qualified-class-name"/>
 </extensions>
 

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<PluginReplacement>	EP_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PluginReplacement(java.lang.String newPluginId)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNewPluginId()
PluginDescriptor	getOldPluginDescriptor()
java.lang.String	getReplacementMessage(IdeaPluginDescriptor oldPlugin, IdeaPluginDescriptor newPlugin)
void	setPluginDescriptor(PluginDescriptor pluginDescriptor) Called by extensions framework when extension is loaded from plugin.xml descriptor.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<PluginReplacement> EP_NAME

Constructor Detail

PluginReplacement

protected PluginReplacement(java.lang.String newPluginId)

Method Detail

getReplacementMessage

public java.lang.String getReplacementMessage(IdeaPluginDescriptor oldPlugin,
                                              IdeaPluginDescriptor newPlugin)

setPluginDescriptor

public final void setPluginDescriptor(PluginDescriptor pluginDescriptor)

Description copied from interface: PluginAware

Called by extensions framework when extension is loaded from plugin.xml descriptor.

If this method is implemented in a bean class extension point and it also exposes the stored plugin description via getPluginDescriptor method, you must annotate the latter with @Transient to ensure that serialization engine won't try to deserialize this property.

Specified by:

setPluginDescriptor in interface PluginAware

Parameters:

pluginDescriptor - descriptor of the plugin that provided this particular extension.

getOldPluginDescriptor

public final PluginDescriptor getOldPluginDescriptor()

getNewPluginId

public final java.lang.String getNewPluginId()