Eclipse Platform
2.0

org.eclipse.core.runtime
Interface IPluginRegistry


public interface IPluginRegistry

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.

This interface is not intended to be implemented by clients.


Method Summary
 IConfigurationElement[] getConfigurationElementsFor(String extensionPointId)
          Returns all configuration elements from all extensions configured into the identified extension point.
 IConfigurationElement[] getConfigurationElementsFor(String pluginId, String extensionPointName)
          Returns all configuration elements from all extensions configured into the identified extension point.
 IConfigurationElement[] getConfigurationElementsFor(String pluginId, String extensionPointName, String extensionId)
          Returns all configuration elements from the identified extension.
 IExtension getExtension(String extensionPointId, String extensionId)
          Returns the specified extension in this plug-in registry, or null if there is no such extension.
 IExtension getExtension(String pluginId, String extensionPointName, String extensionId)
          Returns the specified extension in this plug-in registry, or null if there is no such extension.
 IExtensionPoint getExtensionPoint(String extensionPointId)
          Returns the extension point with the given extension point identifier in this plug-in registry, or null if there is no such extension point.
 IExtensionPoint getExtensionPoint(String pluginId, String extensionPointName)
          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.
 IExtensionPoint[] getExtensionPoints()
          Returns all extension points known to this plug-in registry.
 IPluginDescriptor getPluginDescriptor(String pluginId)
          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.
 IPluginDescriptor getPluginDescriptor(String pluginId, PluginVersionIdentifier version)
          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.
 IPluginDescriptor[] getPluginDescriptors()
          Returns all plug-in descriptors known to this plug-in registry.
 IPluginDescriptor[] getPluginDescriptors(String pluginId)
          Returns all versions of the identified plug-in descriptor known to this plug-in registry.
 

Method Detail

getConfigurationElementsFor

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.

Parameters:
extensionPointId - the unique identifier of the extension point (e.g. "org.eclipse.core.resources.builders")
Returns:
the configuration elements

getConfigurationElementsFor

public IConfigurationElement[] getConfigurationElementsFor(String pluginId,
                                                           String extensionPointName)
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.

Parameters:
pluginId - the unique identifier of the plug-in (e.g. "org.eclipse.core.resources")
extensionPointName - the simple identifier of the extension point (e.g. "builders")
Returns:
the configuration elements

getConfigurationElementsFor

public IConfigurationElement[] getConfigurationElementsFor(String pluginId,
                                                           String extensionPointName,
                                                           String extensionId)
Returns all configuration elements from the identified extension. Returns an empty array if the extension does not exist or contains no configuration elements.

Parameters:
pluginId - the unique identifier of the plug-in (e.g. "org.eclipse.core.resources")
extensionPointName - the simple identifier of the extension point (e.g. "builders")
extensionId - the unique identifier of the extension (e.g. "com.example.acme.coolbuilder)
Returns:
the configuration elements

getExtension

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 parameter identifies the extension point, and the second parameter identifies an extension plugged in to that extension point.

Parameters:
extensionPointId - the unique identifier of the extension point (e.g. "org.eclipse.core.resources.builders")
extensionId - the unique identifier of the extension (e.g. "com.example.acme.coolbuilder")
Returns:
the extension, or null

getExtension

public IExtension getExtension(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 two parameters identify the extension point, and the third parameter identifies an extension plugged in to that extension point.

Parameters:
pluginId - the unique identifier of the plug-in (e.g. "org.eclipse.core.resources")
extensionPointName - the simple identifier of the extension point (e.g. "builders")
extensionId - the unique identifier of the extension (e.g. "com.example.acme.coolbuilder")
Returns:
the extension, or null

getExtensionPoint

public IExtensionPoint getExtensionPoint(String extensionPointId)
Returns the extension point with the given extension point identifier in this plug-in registry, or null if there is no such extension point.

Parameters:
extensionPointId - the unique identifier of the extension point (e.g., "org.eclipse.core.resources.builders")
Returns:
the extension point, or null

getExtensionPoint

public IExtensionPoint getExtensionPoint(String pluginId,
                                         String extensionPointName)
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.

Parameters:
pluginId - the unique identifier of the plug-in (e.g. "org.eclipse.core.resources")
extensionPointName - the simple identifier of the extension point (e.g. " builders")
Returns:
the extension point, or null

getExtensionPoints

public IExtensionPoint[] getExtensionPoints()
Returns all extension points known to this plug-in registry. Returns an empty array if there are no extension points.

Returns:
the extension points known to this plug-in registry

getPluginDescriptor

public IPluginDescriptor getPluginDescriptor(String pluginId)
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 choosen and returned.

Parameters:
pluginId - the unique identifier of the plug-in (e.g. "com.example.acme").
Returns:
the plug-in descriptor, or null

getPluginDescriptor

public IPluginDescriptor getPluginDescriptor(String pluginId,
                                             PluginVersionIdentifier version)
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.

Parameters:
pluginId - the unique identifier of the plug-in (e.g. "org.eclipse.core.resources").
version - plug-in version identifier
Returns:
the plug-in descriptor, or null

getPluginDescriptors

public IPluginDescriptor[] getPluginDescriptors()
Returns all plug-in descriptors known to this plug-in registry. Returns an empty array if there are no installed plug-ins.

Returns:
the plug-in descriptors known to this plug-in registry

getPluginDescriptors

public IPluginDescriptor[] getPluginDescriptors(String pluginId)
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.

Parameters:
pluginId - the unique identifier of the plug-in (e.g. "org.eclipse.core.resources").
Returns:
the plug-in descriptors known to this plug-in registry

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.