org.eclipse.core.runtime
Interface IExtension

public interface IExtension

An extension declared in a plug-in. All information 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 declared by this extension.
IPluginDescriptor	getDeclaringPluginDescriptor() Returns the descriptor of the plug-in that declares this extension.
String	getExtensionPointUniqueIdentifier() Returns the unique identifier of the extension point that this extension gets plugged into.
String	getLabel() Returns a displayable label for this extension.
String	getSimpleIdentifier() Returns the simple identifier of this extension, or null if this extension does not have an identifier.
String	getUniqueIdentifier() Returns the unique identifier of this extension, or null if this extension does not have an identifier.

Method Detail

getConfigurationElements

public IConfigurationElement[] getConfigurationElements()

Returns all configuration elements declared by this extension. These elements are a direct reflection of the configuration markup supplied in the manifest (plugin.xml) file for the plug-in that declares this extension. Returns an empty array if this extension does not declare any configuration elements.

Returns:

the configuration elements declared by this extension

getDeclaringPluginDescriptor

public IPluginDescriptor getDeclaringPluginDescriptor()

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

Returns:

the plug-in that declares this extension

getExtensionPointUniqueIdentifier

public String getExtensionPointUniqueIdentifier()

Returns the unique identifier of the extension point that this extension gets plugged into.

Returns:

the unique identifier of the relevant extension point

getLabel

public String getLabel()

Returns a displayable label for this extension. Returns the empty string if no label for this extension 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, possibly the empty string

See Also:

IPluginDescriptor.getResourceString(java.lang.String)

getSimpleIdentifier

public String getSimpleIdentifier()

Returns the simple identifier of this extension, or null if this extension does not have an identifier. This identifier is specified in the plug-in manifest (plugin.xml) file as a non-empty string containing no period characters ('.') and must be unique within the defining plug-in.

Returns:

the simple identifier of the extension (e.g. "main") or null

getUniqueIdentifier

public String getUniqueIdentifier()

Returns the unique identifier of this extension, or null if this extension does not have an identifier. If available, this identifier is unique within the plug-in registry, and is composed of the identifier of the plug-in that declared this extension and this extension's simple identifier.

Returns:

the unique identifier of the extension (e.g. "com.example.acme.main"), or null