org.eclipse.core.runtime.IPluginRegistry Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-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.
*
* The plug-in registry can be queried, by name, for
* plug-ins, extension points, and extensions.
*
*
* @deprecated
* The plug-in registry has been generalized in Eclipse 3.0. It is now the
* {@link IExtensionRegistry}. Most of the IPluginRegistry function
* is directly supported on the new interface without change. Most clients
* of IPluginRegistry need only to change their references to use
* IExtensionRegistry. The only exceptions are
* methods that return IPluginDescriptors. See the relevant method
* comments for details.
*
* This interface must only be used by plug-ins
* which explicitly require the org.eclipse.core.runtime.compatibility plug-in.
*
*
* @noimplement This interface is not intended to be implemented by clients.
*/
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. "org.eclipse.core.resources.builders")
* @return the configuration elements
* @deprecated Replaced by {@link IExtensionRegistry#getConfigurationElementsFor(String)}.
*/
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. "org.eclipse.core.resources")
* @param extensionPointName the simple identifier of the
* extension point (e.g. "builders")
* @return the configuration elements
* @deprecated Replaced by {@link IExtensionRegistry#getConfigurationElementsFor(String, String)}.
*/
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. "org.eclipse.core.resources")
* @param extensionPointName the simple identifier of the
* extension point (e.g. "builders")
* @param extensionId the unique identifier of the extension
* (e.g. "com.example.acme.coolbuilder)
* @return the configuration elements
* @deprecated Replaced by {@link IExtensionRegistry#getConfigurationElementsFor(String, String, String)}.
*/
public IConfigurationElement[] getConfigurationElementsFor(String pluginId, String extensionPointName, String extensionId);
/**
* Returns the specified extension in this plug-in registry,
* or null 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. "org.eclipse.core.resources.builders")
* @param extensionId the unique identifier of the extension
* (e.g. "com.example.acme.coolbuilder")
* @return the extension, or null
* @deprecated Replaced by {@link IExtensionRegistry#getExtension(String, String)}.
*/
public IExtension getExtension(String extensionPointId, String extensionId);
/**
* Returns the specified extension in this plug-in registry,
* or null 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. "org.eclipse.core.resources")
* @param extensionPointName the simple identifier of the
* extension point (e.g. "builders")
* @param extensionId the unique identifier of the extension
* (e.g. "com.example.acme.coolbuilder")
* @return the extension, or null
* @deprecated Replaced by {@link IExtensionRegistry#getExtension(String, String, String)}.
*/
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 null if there is no such
* extension point.
*
* @param extensionPointId the unique identifier of the extension point
* (e.g., "org.eclipse.core.resources.builders")
* @return the extension point, or null
* @deprecated Replaced by {@link IExtensionRegistry#getExtensionPoint(String)}.
*/
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 null if there is no such extension point.
*
* @param pluginId the unique identifier of the plug-in
* (e.g. "org.eclipse.core.resources")
* @param extensionPointName the simple identifier of the
* extension point (e.g. " builders")
* @return the extension point, or null
* @deprecated Replaced by {@link IExtensionRegistry#getExtensionPoint(String, String)}.
*/
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 Replaced by {@link IExtensionRegistry#getExtensionPoints()}.
*/
public IExtensionPoint[] getExtensionPoints();
/**
* Returns the plug-in descriptor with the given plug-in identifier
* in this plug-in registry, or null 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. "com.example.acme").
* @return the plug-in descriptor, or null
* @deprecated
* IPluginDescriptor was refactored in Eclipse 3.0.
* The getPluginDescriptor() method may only be called by plug-ins
* which explicitly require the org.eclipse.core.runtime.compatibility plug-in.
* See the comments on {@link IPluginDescriptor} and its methods for details.
*/
public IPluginDescriptor getPluginDescriptor(String pluginId);
/**
* Returns the plug-in descriptor with the given plug-in identifier
* and version in this plug-in registry, or null if
* there is no such plug-in.
*
* @param pluginId the unique identifier of the plug-in
* (e.g. "org.eclipse.core.resources")
* @param version plug-in version identifier. If null is specified,
* a non-deterministically chosen version of the identified plug-in (if any)
* will be returned
* @return the plug-in descriptor, or null
* @deprecated
* IPluginDescriptor was refactored in Eclipse 3.0.
* The getPluginDescriptor() method may only be called by plug-ins
* which explicitly require the org.eclipse.core.runtime.compatibility plug-in.
* See the comments on {@link IPluginDescriptor} and its methods for details.
*/
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
* IPluginDescriptor was refactored in Eclipse 3.0.
* The getPluginDescriptors() method may only be called by plug-ins
* which explicitly require the org.eclipse.core.runtime.compatibility plug-in.
* See the comments on {@link IPluginDescriptor} and its methods for details.
*/
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. "org.eclipse.core.resources").
* @return the plug-in descriptors known to this plug-in registry
* @deprecated
* IPluginDescriptor was refactored in Eclipse 3.0.
* The getPluginDescriptors() method may only be called by plug-ins
* which explicitly require the org.eclipse.core.runtime.compatibility plug-in.
* See the comments on {@link IPluginDescriptor} and its methods for details.
*/
public IPluginDescriptor[] getPluginDescriptors(String pluginId);
}