org.eclipse.core.internal.registry

Class BaseExtensionPointHandle

java.lang.Object

org.eclipse.core.internal.registry.Handle

org.eclipse.core.internal.registry.BaseExtensionPointHandle

All Implemented Interfaces:

IExtensionPoint

Direct Known Subclasses:

ExtensionPointHandle

public class BaseExtensionPointHandle
extends Handle
implements IExtensionPoint

This is the copy of the ExtensionPointHandle minus the getDeclaringPluginDescriptor() method that was moved into compatibility plugin. This class should not be used directly. Use ExtensionPointHandle 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
BaseExtensionPointHandle(IObjectManager objectManager, int id)

Method Summary

Modifier and Type	Method and Description
IConfigurationElement[]	getConfigurationElements() Returns all configuration elements from all extensions configured into this extension point.
IContributor	getContributor() Returns the contributor of this extension point.
IExtension	getExtension(java.lang.String extensionId) Returns the extension with the given unique identifier configured into this extension point, or null if there is no such extension.
protected ExtensionPoint	getExtensionPoint()
IExtension[]	getExtensions() Returns all extensions configured into this extension point.
java.lang.String	getLabel() Returns a displayable label for this extension point.
java.lang.String	getLabel(java.lang.String locale) When multi-language support is enabled, this method returns a displayable label for this extension point in the specified locale.
java.lang.String	getLabelAsIs()
java.lang.String	getNamespace() Returns the namespace for this extension point.
java.lang.String	getNamespaceIdentifier() Returns the namespace name for this extension point.
java.lang.String	getSchemaReference() Returns reference to the extension point schema.
java.lang.String	getSimpleIdentifier() Returns the simple identifier of this extension point.
java.lang.String	getUniqueIdentifier() Returns the unique identifier of this extension point.
boolean	isValid() Returns whether this extension point 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

equals

Constructor Detail

BaseExtensionPointHandle

public BaseExtensionPointHandle(IObjectManager objectManager,
                                int id)

Method Detail

getExtensions

public IExtension[] getExtensions()

Description copied from interface: IExtensionPoint

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

Specified by:

getExtensions in interface IExtensionPoint

Returns:

the extensions configured into this extension point

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IExtensionPoint

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

Specified by:

getNamespace in interface IExtensionPoint

Returns:

the namespace for this extension point

See Also:

IExtensionRegistry

getNamespaceIdentifier

public java.lang.String getNamespaceIdentifier()

Description copied from interface: IExtensionPoint

Returns the namespace name for this extension point.

Specified by:

getNamespaceIdentifier in interface IExtensionPoint

Returns:

the namespace name for this extension point

getContributor

public IContributor getContributor()

Description copied from interface: IExtensionPoint

Returns the contributor of this extension point.

Specified by:

getContributor in interface IExtensionPoint

Returns:

the contributor for this extension point

shouldPersist

protected boolean shouldPersist()

getExtension

public IExtension getExtension(java.lang.String extensionId)

Description copied from interface: IExtensionPoint

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.

Specified by:

getExtension in interface IExtensionPoint

Parameters:

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

Returns:

an extension, or null

getConfigurationElements

public IConfigurationElement[] getConfigurationElements()

Description copied from interface: IExtensionPoint

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.

Specified by:

getConfigurationElements in interface IExtensionPoint

Returns:

the configuration elements for all extension configured into this extension point

getLabelAsIs

public java.lang.String getLabelAsIs()

getLabel

public java.lang.String getLabel()

Description copied from interface: IExtensionPoint

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.

Specified by:

getLabel in interface IExtensionPoint

Returns:

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

getLabel

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

Description copied from interface: IExtensionPoint

When multi-language support is enabled, this method returns a displayable label for this extension point in the specified locale. Returns the empty string if no label for this extension point 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 IExtensionPoint.getLabel().

Specified by:

getLabel in interface IExtensionPoint

Parameters:

locale - the requested locale

Returns:

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

See Also:

IExtensionRegistry.isMultiLanguage()

getSchemaReference

public java.lang.String getSchemaReference()

Description copied from interface: IExtensionPoint

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.

Specified by:

getSchemaReference in interface IExtensionPoint

Returns:

a relative URL path, or an empty string

getSimpleIdentifier

public java.lang.String getSimpleIdentifier()

Description copied from interface: IExtensionPoint

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

Specified by:

getSimpleIdentifier in interface IExtensionPoint

Returns:

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

getUniqueIdentifier

public java.lang.String getUniqueIdentifier()

Description copied from interface: IExtensionPoint

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

Specified by:

getUniqueIdentifier in interface IExtensionPoint

Returns:

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

getExtensionPoint

protected ExtensionPoint getExtensionPoint()

isValid

public boolean isValid()

Description copied from interface: IExtensionPoint

Returns whether this extension point object is valid.

Specified by:

isValid in interface IExtensionPoint

Returns:

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