org.eclipse.core.internal.registry

Class BaseExtensionHandle

java.lang.Object

org.eclipse.core.internal.registry.Handle

org.eclipse.core.internal.registry.BaseExtensionHandle

All Implemented Interfaces:

IExtension

Direct Known Subclasses:

ExtensionHandle

public class BaseExtensionHandle
extends Handle
implements IExtension

This is the copy of the ExtensionHandle minus the getDeclaringPluginDescriptor() method that was moved into compatibility plugin. This class should not be used directly. Use ExtensionHandle instead.

Since:

org.eclipse.equinox.registry 3.2

Field Summary

Fields inherited from class org.eclipse.core.internal.registry.Handle

objectManager

Constructor Summary

Constructors

Constructor and Description
BaseExtensionHandle(IObjectManager objectManager, int id)

Method Summary

Modifier and Type	Method and Description
IConfigurationElement[]	getConfigurationElements() Returns all configuration elements declared by this extension.
IContributor	getContributor() Returns the contributor of this extension.
protected Extension	getExtension()
java.lang.String	getExtensionPointUniqueIdentifier() Returns the unique identifier of the extension point to which this extension should be contributed.
java.lang.String	getLabel() Returns a displayable label for this extension.
java.lang.String	getLabel(java.lang.String locale) When multi-language support is enabled, this method returns a displayable label for this extension in the specified locale.
java.lang.String	getLabelAsIs()
java.lang.String	getNamespace() Returns the namespace for this extension.
java.lang.String	getNamespaceIdentifier() Returns the namespace name for this extension.
java.lang.String	getSimpleIdentifier() Returns the simple identifier of this extension, or null if this extension does not have an identifier.
java.lang.String	getUniqueIdentifier() Returns the unique identifier of this extension, or null if this extension does not have an identifier.
boolean	isValid() Returns whether this extension object is valid.
protected boolean	shouldPersist()

Methods inherited from class org.eclipse.core.internal.registry.Handle

equals, getId, hashCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.core.runtime.IExtension

equals

Constructor Detail

BaseExtensionHandle

public BaseExtensionHandle(IObjectManager objectManager,
                           int id)

Method Detail

getExtension

protected Extension getExtension()

shouldPersist

protected boolean shouldPersist()

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IExtension

Returns the namespace for this extension. This value can be used in various global facilities to discover this extension's provider.

Specified by:

getNamespace in interface IExtension

Returns:

the namespace for this extension

See Also:

IExtensionRegistry

getNamespaceIdentifier

public java.lang.String getNamespaceIdentifier()

Description copied from interface: IExtension

Returns the namespace name for this extension.

Specified by:

getNamespaceIdentifier in interface IExtension

Returns:

the namespace name for this extension

getContributor

public IContributor getContributor()

Description copied from interface: IExtension

Returns the contributor of this extension.

Specified by:

getContributor in interface IExtension

Returns:

the contributor for this extension

getExtensionPointUniqueIdentifier

public java.lang.String getExtensionPointUniqueIdentifier()

Description copied from interface: IExtension

Returns the unique identifier of the extension point to which this extension should be contributed.

Specified by:

getExtensionPointUniqueIdentifier in interface IExtension

Returns:

the unique identifier of the relevant extension point

getLabel

public java.lang.String getLabel()

Description copied from interface: IExtension

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.

Specified by:

getLabel in interface IExtension

Returns:

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

getLabelAsIs

public java.lang.String getLabelAsIs()

getLabel

public java.lang.String getLabel(java.lang.String locale)

Description copied from interface: IExtension

When multi-language support is enabled, this method returns a displayable label for this extension in the specified locale. Returns the empty string if no label for this extension is specified in the plug-in manifest file.

The locale matching tries to find the best match between available translations and the requested locale, falling back to a more generic locale ("en") when the specific locale ("en_US") is not available.

If multi-language support is not enabled, this method is equivalent to the method IExtension.getLabel().

Specified by:

getLabel in interface IExtension

Parameters:

locale - the requested locale

Returns:

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

See Also:

IExtensionRegistry.isMultiLanguage()

getSimpleIdentifier

public java.lang.String getSimpleIdentifier()

Description copied from interface: IExtension

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 namespace.

Specified by:

getSimpleIdentifier in interface IExtension

Returns:

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

getUniqueIdentifier

public java.lang.String getUniqueIdentifier()

Description copied from interface: IExtension

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 namespace where this extension was declared and this extension's simple identifier.

Specified by:

getUniqueIdentifier in interface IExtension

Returns:

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

getConfigurationElements

public IConfigurationElement[] getConfigurationElements()

Description copied from interface: IExtension

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.

Specified by:

getConfigurationElements in interface IExtension

Returns:

the configuration elements declared by this extension

isValid

public boolean isValid()

Description copied from interface: IExtension

Returns whether this extension object is valid.

Specified by:

isValid in interface IExtension

Returns:

true if the object is valid, and false if it is no longer valid