PluginReplacement.java

/*
 * Copyright 2000-2016 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.ide.plugins;

import com.intellij.ide.IdeBundle;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.extensions.PluginAware;
import com.intellij.openapi.extensions.PluginDescriptor;
import org.jetbrains.annotations.NotNull;

/**
 * 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.
 * <p/>
 * The implementation must be registered in plugin.xml of the plugin you want to replace:
 * <pre>
 * <extensions defaultExtensionNs="com.intellij">
 *   <pluginReplacement implementation="qualified-class-name"/>
 * </extensions>
 * </pre>
 *
 * @author nik
 */
public abstract class PluginReplacement implements PluginAware {
  public static final ExtensionPointName<PluginReplacement> EP_NAME = ExtensionPointName.create("com.intellij.pluginReplacement");
  private final String myNewPluginId;
  private PluginDescriptor myPluginDescriptor;

  protected PluginReplacement(String newPluginId) {
    myNewPluginId = newPluginId;
  }

  @NotNull
  public String getReplacementMessage(@NotNull IdeaPluginDescriptor oldPlugin, @NotNull IdeaPluginDescriptor newPlugin) {
    return IdeBundle.message("plugin.manager.replace.plugin.0.by.plugin.1", oldPlugin.getName(), newPlugin.getName());
  }

  @Override
  public final void setPluginDescriptor(PluginDescriptor pluginDescriptor) {
    myPluginDescriptor = pluginDescriptor;
  }

  public final PluginDescriptor getOldPluginDescriptor() {
    return myPluginDescriptor;
  }

  public final String getNewPluginId() {
    return myNewPluginId;
  }
}