org.eclipse.core.runtime
Interface IExtensionPoint

public interface IExtensionPoint

An extension point declared in a plug-in. Except for the list of extensions plugged in to it, the information available for an extension point is obtained from the declaring plug-in's manifest (plugin.xml) file.

This interface is not intended to be implemented by clients.

Method Summary

IConfigurationElement[]	getConfigurationElements() Returns all configuration elements from all extensions configured into this extension point.
IPluginDescriptor	getDeclaringPluginDescriptor() Returns the descriptor of the plug-in that declares this extension point.
IExtension	getExtension(String extensionId) Returns the extension with the given unique identifier configured into this extension point, or null if there is no such extension.
IExtension[]	getExtensions() Returns all extensions configured into this extension point.
String	getLabel() Returns a displayable label for this extension point.
String	getSchemaReference() Returns reference to the extension point schema.
String	getSimpleIdentifier() Returns the simple identifier of this extension point.
String	getUniqueIdentifier() Returns the unique identifier of this extension point.

Method Detail

getConfigurationElements

public IConfigurationElement[] getConfigurationElements()

Returns all configuration elements from all extensions configured into this extension point. Returns an empty array if this extension point has no extensions configured, or none of the extensions contain configuration elements.

Returns:

the configuration elements for all extension configured into this extension point

getDeclaringPluginDescriptor

public IPluginDescriptor getDeclaringPluginDescriptor()

Returns the descriptor of the plug-in that declares this extension point.

Returns:

the plug-in that declares this extension point

getExtension

public IExtension getExtension(String extensionId)

Returns the extension with the given unique identifier configured into this extension point, or null if there is no such extension. Since an extension might not have an identifier, some extensions can only be found via the getExtensions method.

Parameters:

extensionId - the unique identifier of an extension (e.g. "com.example.acme.main").

Returns:

an extension, or null

getExtensions

public IExtension[] getExtensions()

Returns all extensions configured into this extension point. Returns an empty array if this extension point has no extensions.

Returns:

the extensions configured into this extension point

getLabel

public String getLabel()

Returns a displayable label for this extension point. Returns the empty string if no label for this extension point is specified in the plug-in manifest file.

Note that any translation specified in the plug-in manifest file is automatically applied.

Returns:

a displayable string label for this extension point, possibly the empty string

See Also:

IPluginDescriptor.getResourceString(java.lang.String)

getSchemaReference

public String getSchemaReference()

Returns reference to the extension point schema. The schema reference is returned as a URL path relative to the plug-in installation URL. Returns the empty string if no schema for this extension point is specified in the plug-in manifest file.

Returns:

a relative URL path, or an empty string

See Also:

IPluginDescriptor.getInstallURL()

getSimpleIdentifier

public String getSimpleIdentifier()

Returns the simple identifier of this extension point. This identifier is a non-empty string containing no period characters ('.') and is guaranteed to be unique within the defining plug-in.

Returns:

the simple identifier of the extension point (e.g. "builders")

getUniqueIdentifier

public String getUniqueIdentifier()

Returns the unique identifier of this extension point. This identifier is unique within the plug-in registry, and is composed of the identifier of the plug-in that declared this extension point and this extension point's simple identifier.

Returns:

the unique identifier of the extension point (e.g. "org.eclipse.core.resources.builders")