| /******************************************************************************* |
| * Copyright (c) 2000, 2003 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.core.runtime; |
| /** |
| * The plug-in registry holds the master list of all |
| * discovered plug-ins, extension points, and extensions. |
| * <p> |
| * The plug-in registry can be queried, by name, for |
| * plug-ins, extension points, and extensions. |
| * </p> |
| * <p> |
| * This interface is not intended to be implemented by clients. |
| * </p> |
| * @deprecated Use {@link org.eclipse.core.runtime.registry.IExtensionRegistry IExtensionRegistry} for all information relative to extension-points and extensions. |
| * For the information plugins being installed, go to the OSGi framework. For further information about this reorganisation please refer to the porting guide. |
| */ |
| public interface IPluginRegistry { |
| /** |
| * Returns all configuration elements from all extensions configured |
| * into the identified extension point. Returns an empty array if the extension |
| * point does not exist, has no extensions configured, or none of the extensions |
| * contain configuration elements. |
| * |
| * @param extensionPointId the unique identifier of the extension point |
| * (e.g. <code>"org.eclipse.core.resources.builders"</code>) |
| * @return the configuration elements |
| * @deprecated Use the same method available on the IExtensionRegistry |
| */ |
| public IConfigurationElement[] getConfigurationElementsFor(String extensionPointId); |
| /** |
| * Returns all configuration elements from all extensions configured |
| * into the identified extension point. Returns an empty array if the extension |
| * point does not exist, has no extensions configured, or none of the extensions |
| * contain configuration elements. |
| * |
| * @param pluginId the unique identifier of the plug-in |
| * (e.g. <code>"org.eclipse.core.resources"</code>) |
| * @param extensionPointName the simple identifier of the |
| * extension point (e.g. <code>"builders"</code>) |
| * @return the configuration elements |
| * @deprecated Same method available on the IExtensionRegistry |
| */ |
| public IConfigurationElement[] getConfigurationElementsFor(String pluginId, String extensionPointName); |
| /** |
| * Returns all configuration elements from the identified extension. |
| * Returns an empty array if the extension does not exist or |
| * contains no configuration elements. |
| * |
| * @param pluginId the unique identifier of the plug-in |
| * (e.g. <code>"org.eclipse.core.resources"</code>) |
| * @param extensionPointName the simple identifier of the |
| * extension point (e.g. <code>"builders"</code>) |
| * @param extensionId the unique identifier of the extension |
| * (e.g. <code>"com.example.acme.coolbuilder</code>) |
| * @return the configuration elements |
| * @deprecated Same method available on the IExtensionRegistry |
| */ |
| public IConfigurationElement[] getConfigurationElementsFor(String pluginId, String extensionPointName, String extensionId); |
| /** |
| * Returns the specified extension in this plug-in registry, |
| * or <code>null</code> if there is no such extension. |
| * The first parameter identifies the extension point, and the second |
| * parameter identifies an extension plugged in to that extension point. |
| * |
| * @param extensionPointId the unique identifier of the extension point |
| * (e.g. <code>"org.eclipse.core.resources.builders"</code>) |
| * @param extensionId the unique identifier of the extension |
| * (e.g. <code>"com.example.acme.coolbuilder"</code>) |
| * @return the extension, or <code>null</code> |
| * @deprecated Same method available on the IExtensionRegistry |
| */ |
| public IExtension getExtension(String extensionPointId, String extensionId); |
| /** |
| * Returns the specified extension in this plug-in registry, |
| * or <code>null</code> if there is no such extension. |
| * The first two parameters identify the extension point, and the third |
| * parameter identifies an extension plugged in to that extension point. |
| * |
| * @param pluginId the unique identifier of the plug-in |
| * (e.g. <code>"org.eclipse.core.resources"</code>) |
| * @param extensionPointName the simple identifier of the |
| * extension point (e.g. <code>"builders"</code>) |
| * @param extensionId the unique identifier of the extension |
| * (e.g. <code>"com.example.acme.coolbuilder"</code>) |
| * @return the extension, or <code>null</code> |
| * @deprecated Same method available on the IExtensionRegistry |
| */ |
| public IExtension getExtension(String pluginId, String extensionPointName, String extensionId); |
| /** |
| * Returns the extension point with the given extension point identifier |
| * in this plug-in registry, or <code>null</code> if there is no such |
| * extension point. |
| * |
| * @param extensionPointId the unique identifier of the extension point |
| * (e.g., <code>"org.eclipse.core.resources.builders"</code>) |
| * @return the extension point, or <code>null</code> |
| * @deprecated Same method available on the IExtensionRegistry |
| */ |
| public IExtensionPoint getExtensionPoint(String extensionPointId); |
| /** |
| * Returns the extension point in this plug-in registry |
| * with the given plug-in identifier and extension point simple identifier, |
| * or <code>null</code> if there is no such extension point. |
| * |
| * @param pluginId the unique identifier of the plug-in |
| * (e.g. <code>"org.eclipse.core.resources"</code>) |
| * @param extensionPointName the simple identifier of the |
| * extension point (e.g. <code>" builders"</code>) |
| * @return the extension point, or <code>null</code> |
| * @deprecated Same method available on the IExtensionRegistry |
| */ |
| public IExtensionPoint getExtensionPoint(String pluginId, String extensionPointName); |
| |
| /** |
| * Returns all extension points known to this plug-in registry. |
| * Returns an empty array if there are no extension points. |
| * |
| * @return the extension points known to this plug-in registry |
| * @deprecated Same method available on the IExtensionRegistry |
| */ |
| public IExtensionPoint[] getExtensionPoints(); |
| |
| /** |
| * Returns the plug-in descriptor with the given plug-in identifier |
| * in this plug-in registry, or <code>null</code> if there is no such |
| * plug-in. If there are multiple versions of the identified plug-in, |
| * one will be non-deterministically chosen and returned. |
| * |
| * @param pluginId the unique identifier of the plug-in |
| * (e.g. <code>"com.example.acme"</code>). |
| * @return the plug-in descriptor, or <code>null</code> |
| * @deprecated: Use {@link org.osgi.framework.BundleContext#getBundles(String) BundleContext#getBundles(pluginId)} and filter the results. |
| * Remember that this list can contain plugin in any state excepted UNINSTALLED. |
| */ |
| public IPluginDescriptor getPluginDescriptor(String pluginId); |
| /** |
| * Returns the plug-in descriptor with the given plug-in identifier |
| * and version in this plug-in registry, or <code>null</code> if |
| * there is no such plug-in. |
| * |
| * @param pluginId the unique identifier of the plug-in |
| * (e.g. <code>"org.eclipse.core.resources"</code>) |
| * @param version plug-in version identifier. If <code>null</code> is specified, |
| * a non-deterministically chosen version of the identified plug-in (if any) |
| * will be returned |
| * @return the plug-in descriptor, or <code>null</code> |
| * @deprecated: Use {@link org.osgi.framework.BundleContext#getBundles(String) BundleContext#getBundles(id)} and filter the results. |
| * Remember that this list can contain plugin in any state excepted UNINSTALLED. |
| */ |
| public IPluginDescriptor getPluginDescriptor(String pluginId, PluginVersionIdentifier version); |
| /** |
| * Returns all plug-in descriptors known to this plug-in registry. |
| * Returns an empty array if there are no installed plug-ins. |
| * |
| * @return the plug-in descriptors known to this plug-in registry |
| * @deprecated Use {@link org.osgi.framework.BundleContext#getBundles() BundleContext#getBundles()} |
| * Remember that this list can contain plugin in any state excepted UNINSTALLED. |
| */ |
| public IPluginDescriptor[] getPluginDescriptors(); |
| /** |
| * Returns all versions of the identified plug-in descriptor |
| * known to this plug-in registry. |
| * Returns an empty array if there are no plug-ins |
| * with the specified identifier. |
| * |
| * @param pluginId the unique identifier of the plug-in |
| * (e.g. <code>"org.eclipse.core.resources"</code>). |
| * @return the plug-in descriptors known to this plug-in registry |
| * @deprecated: Use {@link org.osgi.framework.BundleContext#getBundles(String) BundleContext#getBundles(pluginId)} and filter the results. |
| * Remember that this list can contain plugin in any state excepted UNINSTALLED. |
| */ |
| public IPluginDescriptor[] getPluginDescriptors(String pluginId); |
| |
| } |
